ReadMe datne ir informatīvs teksta fails, ko bieži pievieno pētniecības un programmatūras izstrādes projektiem, datņu mapēm vai citiem digitāliem resursiem (tajā skaitā datu kopām), lai sniegtu pārskatāmu un noderīgu informāciju lietotājiem vai izstrādātājiem. ReadMe datne palīdz lietotājiem ātri saprast, par ko ir projekts un kā ar to strādāt.
ReadMe datne datu kopai
ReadMe datni vēlams sagatavot arī datu kopām, kas tiek saglabātas ilgtermiņā – vai nu deponētas pētniecības datu repozitorijā vai arhivētas citā veidā (piemēram, universitātes vai institūta sistēmās).
ReadMe datne satur kontekstuālu informāciju par datu kopu, un tās mērķis ir panākt, lai dati ir pareizi interpretējami gan autoram ilgākā laika perspektīvā, tostarp pēc pētnieciskā projekta noslēguma, gan citiem lietotājiem, kam piešķirta piekļuve datu kopai.
Ja pastāv nozarei specifiski standarti un prasības ReadMe datnes sagatavošanai, tad tiem ir dodama priekšroka salīdzinājumā ar šeit ieteikto ReadMe datnes saturu.
-
Gadījumos, kad datu kopu veido vairākas, kontekstuāli cieši saistītas datnes, tad ir pieļaujams veidot vienotu ReadMe datni datu kopas aprakstīšanai. Citos gadījumos var katrai datu kopas datnei veidot tai atbilstošu atsevišķu ReadMe datni
-
Ja aprakstītā datu kopa satur informāciju, kas varētu būt noderīga starptautiskai auditorijai, tad ieteicams ReadMe datni sagatavot angļu valodā
-
ReadMe datnes nosaukumā jāiekļauj informācija, kas:
-
-
Ļauj to identificēt kā ReadMe un atšķirt to no citām deponētām datnēm – nosaukumā jāiekļauj “ReadMe”, “readme” vai “read-me” vai līdzīgs teksts
-
-
Nepārprotami norāda, uz kuru no pievienotajām datnēm ReadMe ir attiecināms
-
ReadMe ir jāveido kā vienkārša teksta (.txt) vai arī markdown (.md) formāta datne – ir jāizvairās no patentēto formātu, piemēram, MS Word lietošanas, lai ikviens lietotājs varētu bez problēmām atvērt datni
-
Teksta formatējumam jābūt tādam, lai informācija ir saprotama un viegli uztverama – nerakstīt visu informāciju vienā rindkopā, bet gan nodalīt atsevišķas sadaļas, starp tām atstājot tukšas rindas
-
ReadMe tekstā jāizmanto UTF-8 kodējums, jo tas nodrošina universālu un konsekventu rakstzīmju attēlojumu visās valodās un platformās
-
Ja deponētajai datu kopai ir vairākas ReadMe datnes, tad to izveidē jāpieturas pie vienota stila un terminoloģijas
-
Jāievēro konkrētajā zinātnes nozarē vispārpieņemtās nosaukumu konvencijas un apzīmējumi
-
ReadMe papildina, bet nekādā ziņā neaizvieto metadatus, kuri pēc iespējas detalizēti un precīzi jāievada datu kopas deponēšanas procesā
-
ReadMe datnē vēlams norādīt kontaktinformāciju, lai jautājumu gadījumā interesenti var sazināties ar datu kopas veidotājiem, tādējādi veicinot potenciālu sadarbību
-
Īss apraksts par pētījumu un sasniedzamajiem mērķiem
-
Īss apraksts par deponētajiem datiem un to struktūru
-
Datnes (-ņu) formāts (-i)
-
Ja datu kopu veido vairākas savstarpēji saistītas datnes, tad nepieciešams aprakstīt šīs saistības raksturu
-
Vārds, uzvārds, pārstāvētās zinātniskās iestādes nosaukums, ORCID un e-pasts:
-
Galvenajam pētniekam (vai personai, kas atbildīga par datu ievākšanu)
-
Līdzautoriem
-
Kontaktpersonai (jautājumu gadījumā)
-
Datu ievākšanas datums vai datumu diapazons
-
Datu izcelsmes ģeogrāfiskā lokācija
-
Datnes izveides datums (datnes versija)
-
Datnes modificēšanas vai papildināšanas datums un veikto izmaiņu raksturs (datnes versiju vēsture)
-
Atslēgvārdi, kas raksturo datus pēc būtības
-
Izmantotā(s) valoda(s)
-
Metodes/-žu apraksts, var būt arī saite uz resursu, kur aprakstīta datu ievākšanas, apstrādes un kvalitātes kontroles procedūra
-
Mērinstrumentu specifiskie iestatījumi eksperimentu laikā
-
Instrumentu kalibrēšanas dati
-
Datu kvalitātes kontroles procedūras apraksts
-
Kodējums vai apzīmējumi datos, kas izmantoti, lai izceltu zemas kvalitātes/apšaubāmos mērījumus, izlēcējus (neraksturīgās vērtības) un trūkstošās vērtības, ja šādi dati ir iekļauti datu kopā
-
Personas, kas iesaistītas parauga/-u ņemšanā, datu apstrādē, analīzē
-
Datu kopā izmantoto abreviatūru un saīsinājumu atšifrējums, tabulāriem datiem – kolonnu nosaukumu atšifrējums un skaidrojums
-
Mērvienības
-
Iztrūkstošo datu identificēšanai izmantotā apzīmējuma atšifrējums (piemēram, NA; -999)
-
Datiem piešķirtā izmantošanas licence un citi ierobežojumi darbā ar datu kopu
-
Saites uz publikācijām, kur tiek citēta vai izmantota attiecīgā datu kopa
Ja atsevišķa dokumentācija (piemēram, kodu grāmata vai detalizēti metadati) jau satur daļu no šeit ieteiktās informācijas, ReadMe datnē var iekļaut tikai būtiskāko (papildinošu informāciju).
Ja ReadMe datne tiek veidota un regulāri papildināta jau projekta sākumā, tās gala versiju ir vieglāk sagatavot un izvairīties no kļūdām, kas var rasties, ja visa informācija tiek apkopota tikai projekta beigās.
Šeit pieejamas ReadMe datnes veidnes, ko izmantot datu kopas aprakstīšanai:
