Granska dokumentation

Förutom data och metadata krävs också tillgång till relevant dokumentation för att en sekundäranvändare ska kunna förstå och återanvända det aktuella datasetet. Det är upp till dig som granskare att bedöma om inkomna data har den dokumentation som behövs. Det är svårt att säga exakt vad som är tillräcklig information eftersom det varierar beroende på bland annat forskningsområde, typ av data och det specifika forskningsprojektet. Det krävs ofta en bedömning i varje enskilt fall.  

I många fall används dokumentation och metadata som synonyma begrepp. Gränserna mellan dem kan vara flytande, men det finns skillnader. Dokumentationen riktas i första hand till människor och kan bestå av löpande text, medan metadata är ordnade för att också kunna läsas av datorer. Eftersom dokumentationen inte behöver vara maskinläsbar har den inte samma krav på struktur som metadata.  

Information om att granska datafiler och metadata finns på sidorna Granska data och Granska metadata.

Några exempel på sådant som det kan vara relevant att inkludera i dokumentationen:

• en beskrivning av vald insamlingsmetod
• innehåll i datafiler, till exempel variabellista, kodbok eller kodschema  
• undersökningsrapporter och tekniska rapporter
• frågeformulär eller intervjuguide
• en överblick över analysarbetet och en beskrivning av de data som används för analys
• beskrivningar av inkluderade fotografier, till exempel datum, plats och kamerainställningar (läs mer om hantering av audiovisuellt material på sidorna om filformat för Bild och Digital video på sidorna om filformat på Researchdata.se)
• tillhörande kod/skript.

Dokumentation av forskningsdata är mycket viktig för att kunna återanvända data för ny forskning, för att kunna validera forskning och för att forskningen ska kunna förstås. Relevant information kan till exempel sammanfattas i en README-fil, exempelvis SND:s DORIS README template som är framtagen specifikt för DORIS.

Exempel på dokumentation

Nedan kan du ta del av några exempel på vilken dokumentation som kan behövas för olika typer av data. 

Tabelldata

Här är det viktigt att varje variabel/kolumn är tydligt beskriven. Ofta används förkortningar som kolumnrubrik (header) för varje kolumn i en tabelldatabas och då är det viktigt att dessa förkortningar förklaras. Det kan räcka med att skriva ut en förkortning som används som kolumnrubrik i fulltext, till exempel ”CORINE 2012 Land cover type code” i stället för ”COR_TYPE”. Du bör även kontrollera att varje variabel/kolumn är ifylld på samma sätt, till exempel att alla datum i en kolumn som heter ”date of sampling” har samma format. Det är också bra att kontrollera att det inte finns några tomma fält; om något värde saknas bör det till exempel stå ”missing”.

Kontrollera att de värden som finns är förklarade eller beskrivna. Om till exempel en enkätundersökning är inmatad som en tabell med numeriska värden behöver den som återanvänder materialet veta att i kolumnen Kön betyder siffran 1 ”man” och siffran 2 ”kvinna”.  

Det är också viktigt att i dokumentation och variabelbeskrivningar länka eller referera till standarder och/eller formella definitioner, om det finns sådana. Det kan gälla allt från enkätdesigner och skattningsverktyg till ISO-standarder, algoritmer, kodningsmallar och så vidare. Länk eller referens anges förslagsvis med hjälp av beständiga identifierare.

Bilder

En stor samling bilder kan behöva dokumenteras på olika sätt och mycket dokumentation kan också räknas som metadata. Det är viktigt att bilderna har tydliga filnamn som lätt kan förstås av någon som vill återanvända dem. Filnamnen kan till exempel vara en beskrivning av bilden eller en kod som kan tolkas med hjälp av en kodlista. Om bilderna är uppdelade i olika mappar är det viktigt att mappstrukturen är tydlig och att varje mapp har namngetts på ett sätt som gör det enkelt att navigera och förstå innehållet i olika mappar.

Geospatiala data

Här behövs en förklaring av innehållet i de data som lämnas in. Dokumentationen kan vara en del av datamaterialet eller separata textfiler. När det gäller spatiala data kan det vara svårt att kontrollera att all information som behövs för att kunna förstå datamaterialet finns med och det är därför viktigt att kommunicera med forskaren för att försäkra sig om att datamaterialet går att använda med den befintliga dokumentationen. Några saker man kan fråga om är: 

1. Finns det information om projektion och koordinatsystem? 
2. Finns det information om hur man utläser kolumn- eller attributdata? 

Om data hör ihop med en artikel

I de fall ett dataset delas med avseende på en specifik artikel eller annan publikation kan det ställas något lägre krav på dokumentation. Då gäller det att den aktuella artikeln/publikationen 

• är öppen och fritt tillgänglig
• är länkad till i databeskrivningen med en beständig identifierare (PID)
• innehåller all information som krävs för att data ska gå att förstå och återanvända. 

Om en artikel ska ersätta delar av dokumentationen för ett dataset är det viktigt att artikeln innehåller 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. Listorna behöver då i stället delas tillsammans med datafilerna. 

Om artikeln finns hos ett förlag som kräver prenumeration måste de delar av artikeln som beskriver data sparas ner tillsammans med datafilerna.

Tänk också på att uppmana forskaren att länka från artikeln till data, till exempel i artikelns Data availability statement.

Ibland behöver data finnas tillgängliga innan en artikel publiceras. I undantagsfall kan du 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 den har publicerats. Läs mer om detta under rubriken Fördröj publicering av data (sluten referentgranskning/closed review) på sidan Hantera databeskrivningar i DORIS.