3. Tutkimusaineiston kuvailu (dokumentointi, metadata)

Tutkimusaineiston huolellinen dokumentointi ja kuvailu on ensiarvoisen tärkeää tutkimuksen alusta asti. Se turvaa aineiston ymmärrettävyyden sekä itselle että muille, vähentää väärän tulkinnan riskiä ja mahdollistaa aineiston jatkokäyttöä. Tutkimusaineiston kuvailu on siten avain FAIR-periaatteiden toteuttamiseen käytännössä. Ilman asianmukaista kuvailua tutkimusaineisto on vain kokoelma yksittäisiä tiedostoja, numeroita ja merkkejä, ja sen tulkinta, käyttö ja uudelleenkäyttö voi olla mahdotonta.

Tutkimusaineiston dokumentointi ja kuvailu koko sen elinkaaren ajan on tutkimuksen teon arkisessa ytimessä, vaikka aineistoa ei avattaisi. Kuvailuun ja dokumentointiin panostaminen projektin aikana säästää aikaa tutkimusaineistojen julkaisuhetkellä. On hyvä muistaa, että vaikka itse tutkimusaineistoja ei jostain syystä voida avata, kuvailutietojen julkaisemista suositellaan aina kuin mahdollista tutkimuksen näkyvyyden lisäämiseksi.

Kuvailutietoa voi syntyä automaattisesti esimerkiksi käytetyistä laitteista, mutta kaikessa tutkimuksessa kuvailua on suunniteltava ja toteutettava aktiivisin toimenpitein. Kuvailutietoa voi kirjata vaikkapa laboratorio- tai tutkimuspäiväkirjoihin, systemaattisesti laadittuihin tiedostoihin ja hakemistoihin tai vapaamuotoisiin muistiinpanoihin.

Dokumentaatio, metadata, paradata?

Tutkimusaineiston kuvailun keskiössä ovat termit dokumentaatio ja metadata (metatieto), joille ei välttämättä löydy tarkkoja määrittelyjä ja joita saatetaan käyttää hieman vaihtelevasti eri ohjeissa. Näiden lisäksi puhutaan myös paradatasta. Kaikki nämä termit viittaavat tutkimusaineiston kuvailuun tavalla tai toisella ja liittyvät samaan tavoitteeseen eli kertomaan aineistojen synty, rakenne, käsittely ja sisältö selkeästi ja ymmärrettävässä muodossa.

Dokumentaatiolla (englanniksi data documentation) voidaan ymmärtää ennen kaikkea tutkimuksenaikaista tietojen kirjaamista, mikä lisää tutkimuksen läpinäkyvyyttä ja toistettavuutta. Se voidaan tehdä esimerkiksi tavallisilla toimisto-ohjelmilla (esim. MS Word tai LibreOffice Writer) tai hyödyntämällä alakohtaisia sähköisiä laboratoriopäiväkirjoja (ELN), mihin kirjataan aineiston käsittelyn vaiheita. Toisinaan voi olla tarkoituksenmukaista tehdä muistiinpanot käsin, jolloin on myös suunniteltava ja toteutettava niiden muuntaminen digitaaliseen muotoon riskinhallinta huomioiden (ks. luku 2).

Metadata (metatieto) liitetään ennen kaikkea aineiston hallinnollisiin tai sisällöllisiin kuvailutietoihin. Nämä kertovat mm. aineistonkeräämisen alkuperän, tarkoituksen, aikaviitteen, maantieteellisen sijainnin, käytetyt laitteet ja ohjelmistot, tekijän, säilytyspaikan (sijainnin), käyttöehdot ja yhteyshenkilöt lisätietoja varten. Lisäksi metatiedot kertovat kansiorakenteesta, tiedostojen nimeämiskäytännöistä, aineiston muuttujista ja käytetyistä termeistä.

Tieteen termipankissa metadata määritellään avoimen tieteen yhteydessä kuvaamaan ”tiivistetyssä muodossa tietoaineistoa” (esim. sen sisältöä, rakennetta, kontekstia, jne.) ja todetaan, että metatietoja tarvitaan erityisesti aineistojen hakemiseen ja käyttöön. Metadatalla tarkoitetaan usein myös standardoitua ja jäsenneltyä tietoa, mistä on lisää seuraavassa osiossa.

Paradata viittaa aineiston keruuprosessin tai -tilanteen konteksti- ja havaintotietoon. Tällaista voivat olla esimerkiksi vastaajan käyttämä aika kyselyn vastauksiin, haastattelijan havainnot haastattelutilanteesta tai aineiston synty- tai keruuhetkeen liittyvät tapahtumat. Paradata on terminä tullut käyttöön kyselytutkimusten ja tilastollisten menetelmien kontekstissa 1990-luvun lopussa.

Standardit

Tutkimusaloilla saattaa olla aineiston kuvailuun omia vakiintuneita tapoja aineiston kuvailuun, jotka eivät sovellu sellaisinaan muille aloille. Kaikkia tieteenaloja koskevat kuitenkin tietyt kuvailuun liittyvät peruselementit, joiden huomioiminen mahdollistaa FAIR-periaatteiden toteutumisen. Ne tukevat ennen kaikkea löydettävyyttä ja sitä, että aineistot ovat hyödynnettävissä myös eri yhteyksissä. Kansallisessa kuvailuohjeessa näitä peruselementtejä on koottu selkeään taulukkomuotoon, jossa kerrotaan myös, mihin FAIR-periaatteeseen tietty elementti erityisesti liittyy ja kuka tai mikä palvelu kyseisen tiedon tuottaa.

Tässä yhteydessä puhutaan tyypillisesti metadatastandardeista. Ne ovat yhteisesti sovittuja tapoja jäsentää metadataa yhdenmukaisesti ja koneluettavasti. Koneluettavuudella tarkoitetaan rakenteeltaan ja muodoltaan sellaista tietoa, mitä tietokone pystyy käsittelemään.

Yksinkertaisimmillaan metadatastandardia hyödynnetään silloin, kun täytetään esimerkiksi jonkin datarepositorion tai kuvailupalvelun lomake, joka noudattaa tiettyä rakennetta ja muodostuu pakollisista ja vapaaehtoisista kentistä (ks. esim. alla Qvain-kuvailutyökalu ja Etsin-hakupalvelu). Lomakkeessa voidaan ohjata täyttäjää kertomaan määrätyllä tavalla vaikkapa tuotoksen nimi, tekijä, aika ja paikka, jolloin halutut metatiedot ovat yhdenmukaisessa muodossa. Konkreettinen esimerkki on tekijän ilmaiseminen, jota voidaan ohjata muotoon Sukunimi, Etunimi tai Etunimi Sukunimi.

Standardeja on lukuisia. Osa on ns. geneerisiä metadatastandardeja, kuten hyvin yleisesti käytetty Dublin Core (DC), osa sisältökohtaisia kuten paikkatietojen ISO-standardi 19115 tai päivämäärien ISO-standardi 8601, ja osa taas tieteenalakohtaisia. Tutkija ohjataankin usein hyödyntämään oman alansa standardeja, joita voi etsiä esimerkiksi Digital Curation Centren (DCC) tai Research Data Alliance -yhteisön (RDA) ylläpitämistä luetteloista.

Datarepositoriossa tai -arkistoissa voi olla käytössä jokin tieteenalakohtainen metadatastandardi. Esimerkiksi Tietoarkistossa sovelletaan DDI-metadatastandardia (Data Documentation Initiative), joka on kehitetty erityisesti yhteiskuntatieteellisen data-aineiston kuvailun tarpeita silmällä pitäen.

Tutkimuksessa käytettävä laitteisto saattaa myös tuottaa automaattisesti standardimuotoista metadataa. Onkin siis syytä kertoa käytetty laitteisto ja ohjelmisto tutkimusaineiston kuvailutiedoissa.

README-tiedosto: Avain aineistoon

README-tiedosto on tutkimusaineiston (ml. koodi, ohjelmisto) jäsennelty ja tiivis kuvailu tekstimuodossa. Se liitetään tutkimusaineiston ja/tai sen metatiedon yhteyteen siten, että se erottuu selkeästi tarjoten ikään kuin sisäänkäynnin tai avaimen itse aineistoon.

README-tiedosto kannattaa tallentaa yksinkertaisina, ohjelmistoista riippumattomina tiedostoina kuten muotoilemattomana tekstitiedostona (.txt) tai Markdown-tiedostona (.md). Näistä Markdown mahdollistaa jonkin verran muotoiluja ja toimii hyvin esimerkiksi Git-ympäristössä. Tekstitiedosto puolestaan avautuu eri käyttöympäristöissä ja on helppo luoda ja siirtää. Tekstinkäsittelyohjelmilla luodut tiedostot ovat riippuvaisia ohjelmistoista, eivät välttämättä kestä aikaa ja sisältävä turhaa muotoilua, joka voi muuttua eri ohjelmilla avattaessa.

README-tiedoston nimi on syytä pitää ytimekkäänä ja sisällyttää sana README heti alkuun, esim. ”README_[tarpeen mukaan aineiston tai alikansion nimi tms.]_[tiedostomuoto, esim. .txt]”

README-tiedostolle ei ole tiukasti määriteltyä sisällöllistä standardia, mutta ohjenuoraksi voi ottaa kolmen eri tason keskeisten tietojen tarjoamisen:

Projektitaso: tutkimusprojektin tiedot kertovat aineiston kontekstin
Tiedostotaso: tiedostojen yksityiskohdat kertovat itse aineistosta
Muuttuja- tai sanastotaso: aineiston muuttujien tai termien selitys mahdollistaa aineiston tulkinnan

Käytännössä README-tiedoston muistilista voisi olla seuraava:

Perustiedot: aineiston / datasetin nimi, pysyvä tunniste, yhteystiedot, tekijätiedot (ml. ORCID ja organisaatio eli affiliaatio), tiivis kuvaus sisällöstä, päiväys, sijainti, rahoittaja, yhteistyökumppanit
Aineiston käyttö ja viittaukset: rajoitukset tai lisenssitiedot, käyttöehdot, aineistoon liittyvät julkaisut (esim. artikkelit, opinnäytteet), viittausohjeet, viittaukset uudelleenkäytettyihin aineistoihin (jos näitä on)
Kansioiden ja tiedostojen yleiskuva: lista tiedostoista ja kansioista tiivine kuvauksineen, selitys tiedostojen välisestä suhteesta
Aineistokohtainen tieto: muuttujat, mittayksiköt, termit, koodien selitykset, muistiot
Metodologinen tieto: keruu, käsittely, analyysi, välineet, ohjelmistot

Esimerkkejä metatietojen dokumentoinnista README –tiedostojen avulla mallilomakkeineen:

Aineiston järjestäminen ja nimeäminen

Laadukas aineisto on hyvin järjestetty, jäsennelty, nimetty ja versioitu, koska se helpottaa datatiedostojen hallintaa. Tutkimusprojektin alussa kannattaa suunnitella tiedon löytymistä ja käyttöä edesauttava kansiorakenne ja johdonmukainen tapa nimetä tiedostot, niin että jo nimi kertoo olennaista tietoa yksittäisistä tiedostoista.

Tutkimusprojektia varten laadittua sopivaa nimeämissysteemiä on syytä käyttää johdonmukaisesti koko projektin ajan. Nimeämissysteemi kannattaa kirjata ja tallentaa osana aineiston kuvailua paikkaan, josta tieto löytyy vaivattomasti. Se helpottaa aineiston ymmärrettävyyttä ja on osa kuvailutyötä.

Tiedostoista kannattaa kirjata seuraavia asioita:

tiedoston nimi
projektin lyhenteet
missä tiedosto sijaitsee (tiedostopolku)
tiedoston koko
tiedostomuoto
millä ohjelmalla tiedosto on tuotettu
milloin tiedosto on tuotettu
kuka tiedoston on tuottanut
tiedoston versio
tiedoston käyttöoikeudet.

Vinkkejä tiedostojen nimeämiseen:

luo merkityksellisiä mutta lyhyitä nimiä
käytä tiedostojen nimiä luokitellaksesi laajempia tiedostotyyppikokonaisuuksia
vältä välilyöntien ja erikoismerkkien käyttöä
merkitse aikamääre järjestyksessä: vuosi, kuukausi, päivä (VVVVKKPP (esim. 20200901) tai VVVV-KK-PP (esim. 2020-09-01) tai tarvittaessa vielä tarkemmin: tunnit, minuutit, sekunnit (TTMMSS tai TT:MM:SS).
hallitse eri versioita lisäämällä V kirjain tiedostonimeen käyttäen vähintään kahta numeroa (esim. V02).

Vinkkejä kansiorakenteeseen:

oma kansio jokaiselle projektille
omat kansiot datalle, hallinnolliselle aineistolle, menetelmille jne.
pääsyoikeudet
kansiohierarkia: tasapaino syvän ja matalan hierarkian välillä
tunnisteet (avain- ja asiasanat): tiedostojen linkittäminen useaan kontekstiin.

Tässä CSC:n tuottamassa videossa pureudutaan tiedostojen hallintaan ja niiden nimeämiseen (kesto 11:41). Video on englanniksi suomenkielisin tekstityksin: Manage well and get preserved – 6. Managing files and file naming

Pohdittavaksi

Mitä dokumentaatio tarkoittaa omalla tutkimusalallasi?
Onko omalla tutkimusalallasi käytössä kuvailuun liittyviä standardeja?
Millaista aineistoon ja sen käsittelyyn liittyvää tietoa tarvitset itse tutkimusprojektin aikana, jotta arkinen tutkimustyö sujuu mahdollisimman vaivattomasti?
Mitä aineistoon ja sen käsittelyyn liittyvää tietoa tarvitaan tutkimuksen jälkeen, jotta aineisto on ymmärrettävää itsellesi ja/tai muille?
Miten kuvailisit aineistosi perustiedot README-tiedostona?

Qvain kuvailuu, Etsin hakemiseen, pysyvät tunnisteet (PID) linkittämiseen

Standardoitua ja rakenteista kuvailutietoa voi tuottaa mille tahansa aineistolle esimerkiksi Qvain-kuvailutyökalulla riippumatta aineiston tallennus- tai julkaisupaikasta. Qvaimen avulla aineiston kuvailutiedot voidaan julkaista, minkä jälkeen ne ovat näkyvillä tutkimusaineistojen hakupalvelu Etsimessä. Qvain ja Etsin kuuluvat CSC:n tuottamaan kansalliseen Fairdata.fi-palvelukokonaisuuteen.

Qvain

Qvaimen käyttöoppaasta löytyy tietoa mm. kuvailutietojen vähimmäisvaatimuksista. Tarjolla on myös Qvain-ohjevideo (CSC) sekä UEFin oma pikaopas Qvaimen käyttöön.

Qvaimessa kerrottavat tiedot eli kentät ovat seuraavat:

Kuvailutietojen ylläpito-oikeudet organisaatiolle
Datalähde
Lisenssi ja pääsyoikeus
Otsikko, kuvaus ja muut perustiedot
Toimijat
Aineistoon liittyvät julkaisut ja muut tuotokset
Maantieteellinen alue (spatial)
Ajanjakso (temporal)
Infrastruktuuri
Historiatiedot ja tapahtumat (provenienssi)
Projekti ja rahoitus

Osa kentistä tai kunkin kentän alla olevista tarkennuksista on pakollisia. Qvaimessa on ohjeet kenttien täyttöön.

Etsin

Fairdata Etsin-hakupalvelusta voi etsiä tutkimusaineistojen metatietoja ja siten löytää aineistoja, jotka on joko kuvailtu Qvaimella tai löytyvät Fairdata.fi-palvelukokonaisuuden ulkopuolisilta sivustoilta tai julkaisualustoilta. Etsin siis myös haravoi (kopioi) muualla olevia aineistokuvailuja esimerkiksi Tietoarkistosta tai Kielipankista. Vastaavasti Etsimestä haravoidaan kuvailutietoja muualle kuten Itä-Suomen yliopiston eRepositorioon (eRepo).

Pysyvät tunnisteet

Pysyvä tunniste (persistent identifier eli PID) on yksilöivä ja ainutkertainen verkkoympäristössä toimiva tunniste. Niillä voidaan yksilöidä esimerkiksi tutkimusjulkaisu, tutkimusaineisto tai henkilö. Pysyvä tunniste toimii linkin tavoin, vaikka kohteen verkkosijainti muuttuisikin.

Tyypilliset pysyvät tunnisteet julkaisuiden ja aineistojen kohdalla ovat esimerkiksi DOI, URN ja Handle. Julkaisijat ja datarepositoriot (ks. luku 5) tuottavat pysyvän tunnisteen julkaisulle tai aineistolle. Tutkijoiden pysyvä tunniste on ORCID, jonka tutkija hankkii itse.

Katso video

Metadata on keskeistä aineiston löydettävyydelle: The Elements of FAIR – Findable, CSC (8:49).

Lyhyesti sanottuna

hyvä kuvailu sisältää tiivistä tietoa esimerkiksi

aineistonkeruun kontekstista (esim. tutkimusprojektin tavoitteet, tiedot tutkimuksesta, jota varten aineisto on kerätty)
aineistonkeruun menetelmistä (esim. näytteenotto/otanta, keruuprosessi, käytetyt laitteet ja ohjelmistot)
tiedostojen rakenteesta
laadunvarmistusmenetelmistä
versionhallinnasta
pääsy- ja käyttöehdoista tai aineistojen luottamuksellisuudesta
muuttujista ja tietueista (arvojen nimet, merkinnät, kuvaukset)
käytetyistä koodeista ja luokitusjärjestelmistä (selitys tai määritelmä)
käytetyistä erikoistermeistä tai lyhenteistä
puuttuvista arvoista (koodit, syyt).

Lisätietoa

_(2026-07)

_{Edellinen: 2. Tutkimusaineiston kerääminen ja käyttäminen}

_{Seuraavaksi: 4.}_{Tutkimusaineiston tallennus, varmuuskopiointi ja jakaminen tutkimuksen aikana}