Uppfylla krav och rekommendationer

Här finns tips för hur dokumentet Krav och rekommendationer för data och metadata i SND:s forskningsdatakatalog kan uppfyllas. Punkterna för krav och rekommendationerna listas i samma ordning som i kravbeskrivningen, efter varje punkt följer ett tips eller förslag på hur kravet/rekommendationen kan uppfyllas.

Detta är en levande text som fylls på och omarbetas allt eftersom. Inspel från DAU-medarbetare tas tacksamt emot.

Krav för metadata och dokumentation

Krav: Obligatoriska metadatafält i DORIS:s formulär ska vara ifyllda och beskrivna så utförligt som möjligt för det aktuella fallet. Obligatoriska metadatafält ska också vara beskrivna på båda svenska och engelska, med undantag för fältet Titel.

Tips! De strukturerade metadatafält som finns i DORIS syftar främst till att göra data sökbara och ge grundläggande information om vad data innehåller och dess sammanhang. Obligatoriska metadatafält ska vara angivna innan posten publiceras i SND:s forskningsdatakatalog.

Vilka fält som är obligatoriska avgörs av vald metadataprofil i formuläret. Kontrollerade vokabulär och nyckelordslistor översätts automatiskt i DORIS medan fritextfält kräver manuell översättning. Översättningarna behöver inte vara exakta, men likvärdig information ska finnas på båda språken. Vid längre texter kan en hänvisning till den engelska katalogposten vara aktuellt, men en inledning bör finnas även på svenska.

Det är möjligt för både forskare och DAU att skicka vidare en databeskrivning utan att alla obligatoriska fält är ifyllda. På så sätt behöver inte arbetet stanna upp utan vi kan hjälpas åts med att ta fram rätt information innan publicering.

På sidan Kontroll av metadata finns information om vad som bör tänkas för specifika metadatafält.

Som rekommendation bör även icke-obligatoriska metadatafält vara ifyllda i så stor utsträckning som möjligt.

---

Krav: Metadata ska innehålla länkar/referenser till artiklar och/eller andra publikationer, i den mån det finns.

Tips! Hänvisningar till publikationer som är kopplade till data beskrivs i avsnittet Publikationer i DORIS. Viktigaste är att ange referenser till publikationer som beskriver data och hur de är framtagna, men det rekommenderas även att länka till publikationer som är baserade på data.

Det är möjligt att i DORIS söka och hämta metadata för publikationer i SwePub. Det är obligatoriskt att ange titel och referens för publikationen, det som anges i fältet för referens är det som blir synligt i blivande katalogposten. Att ange årtal det gör möjligt att kunna filtrera på år i katalogposten, om det finns många publikationer. Ange gärna PID för publikationen, om det finns.

---

Krav: Externa länkar ska, i den mån det finns, vara av typen persistenta identifierare.

Tips! Länkar som leder till externa källor, exempelvis till publikationer, hemsidor eller relaterade resurser ska så långt som möjligt vara av typen persistenta länkar. De kan t.ex. vara av typen DOI, handle eller URN:er. Saknas persistent länk kan ex. vanlig URL användas. URL har dock inte samma garanti för långsiktighet då en webbadress kan flyttas, ändras eller tas bort. Om URL:er används kan de behöva kontrolleras kontinuerligt så att de fungerar.

---

Krav: Tillhörande dokumentation som är relevant för att förstå och återanvända det aktuella datasetet ska delas tillsammans med data och metadata. Information om materialets framtagande, bearbetning och sammanhang bör finnas med.

I de fall databeskrivningen omfattas av ett dataset som delas med avseende på en specifik artikel (eller annan publikation) kan kravet om tillhörande dokumentation frångås, villkorat att den aktuella artikeln/publikationen:

• är öppen och fritt tillgänglig
• är länkad till i databeskrivningen med en persistent identifierare (PID)
• innehåller all information som krävs för att data ska gå att förstå och återanvända, så att resultat ska kunna återskapas oberoende andra resurser.

Tips! Tillhörande dokumentation är mycket viktigt för att data ska återanvändas för ny forskning, för att kunna validera forskning och för att forskningen ska kunna förstås. Med tillhörande dokumentation avses här information i löpande text som inte ryms i de strukturerade metadatafälten och som bifogas data.

Att definiera vad som är tillräcklig dokumentation för återanvändning är beroende av bland annat forskningsområde, typ av data och det specifika forskningsprojektet. Det krävs ofta en bedömning i varje enskilt fall.

Relevant information kan t.ex. sammanfattas i en readme-fil. Här är ett exempel på utformning av en readme-fil, framtagen av Cornell University.

Om en artikel ska ersätta delar av tillhörande dokumentation är det viktigt att det i artikeln finns information om bland annat metod och insamling. Tänk på att variabel- och kodlistor som förklarar själva datafilerna oftast inte finns med i den vetenskapliga artikeln, eller i dess supplementary materials, så detta behöver delas tillsammans med datafilerna.

Ibland behöver data finnas tillgängliga innan en artikel publiceras. I undantagsfall kan man därför behöva publicera databeskrivningen utan länk till artikeln. Rekommendationen är då att ange artikelns titel i DORIS följt av “under review” och uppdatera databeskrivningen med länk till artikeln så snart det finns.