ReadMe-filer

En ReadMe-fil er en ren tekstfil i formatet .txt som følger et datasett. ReadMe-filen fungerer som en guide for å forstå dataene og har til hensikt at andre skal forstå dataene i ettertid, når de deles og publiseres. Denne burde opprettes på et tidlig tidspunkt i forskningsprosessen og legges i hovedmappen for datasettet. Filen oppdateres hver gang man har utført en operasjon på dataene.

Dette skal en ReadMe-fil inneholde:

  • Generell bakgrunnsinformasjon: tittel på forskningsprosjekt, DOI, kontaktinfo, dato, sted, eierskap og finansiør
  • En beskrivelse av hvordan datasettet er oppdrettet
  • En beskrivelse av hvor fullstendig datasettet er
  • En beskrivelse av eventuelle vilkår for gjenbruk (les mer om lisensiering av datasett her)
  • En beskrivelse av metoden som er brukt for å frembringe datasettet, inkludert protokoller, instrumenter og programvare
  • En oversikt over filene som datasettet består av og forklaringer på filenes innehold

Husk:

  • Vær spesifikk i beskrivelsene
  • Definer eventuelle uttrykk og akronymer
  • Bruk etablert fagterminologi

Utover en ReadMe-fil burde et datasett som skal arkiveres følges av følgende informasjon i tilfeller der det er relevant:

  • Beskrivelser, instruksjoner og protokoller for innsamling, prosessering og analysesteg
  • Konfigurasjonsfiler og loggfiler fra kalibrering, prosessering og analyse
  • Ordbøker og kode-skjema
  • Variabellister
  • Informasjonsskriv og samtykkeskjema
  • Meldeskjema til Sikt og etiske godkjenninger
  • Spørreskjemaer og intervjuguider
  • Tillatelser og lisenser fra eventuelle rettighetsinnehavere
Publisert 16. des. 2022 11:05 - Sist endret 16. des. 2022 11:05