3. Tutkimusaineiston kuvailu (dokumentointi, metadata)

Tutkimusaineiston huolellinen 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 edistää merkittävästi löydettävyyttä ja jatkokäyttöä. Ilman asianmukaista kuvailua tutkimusaineisto on vain kokoelma yksittäisiä tiedostoja, numeroita ja merkkejä, ja sen käyttö ja uudelleenkäyttö voi olla mahdotonta. Tutkimusaineiston kuvailu on siten avain FAIR-periaatteiden toteuttamiseen käytännössä.

Kuvailuun panostaminen projektin aikana säästää myös aikaa tutkimusaineistojen julkaisuhetkellä. On hyvä muistaa, että vaikka itse tutkimusaineistoja ei jostain syystä voida avata, kuvailutietojen julkaisemista suositellaan periaatteessa aina tutkimuksen näkyvyyden lisäämiseksi.

Kuvailutietoa voi syntyä automaattisesti esimerkiksi käytetyistä latteista, 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.

Termeistä: 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 toisinaan 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ö muille ymmärrettävässä muodossa.

Dokumentaatiolla (englanniksi data documentation) voidaan ymmärtää ennen kaikkea tutkimuksenaikaista tietojen ylös kirjaamista, joka lisää tutkimuksen läpinäkyvyyttä ja toistettavuutta. Se voidaan tehdä esimerkiksi käyttämällä tutkimuspäiväkirjaa tai excel-taulukkoa, johon kirjataan aineiston käsittelyn eri vaiheita.

Metadata (metatieto) liitetään 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.

Löydettävyys, metadatastandardi

Tutkimusaloilla saattaa olla aineiston kuvailuun omia vakiintuneita tapoja, 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 voi hyödyntää täyttämällä lomakkeen, joka noudattaa tiettyä rakennetta ja muodostuu esimerkiksi jonkin palvelun verkkosivulla olevista pakollisista ja vapaaehtoisista kentistä. Lomakkeessa voidaan ohjata jokaista lomakkeen täyttäjää kertomaan määrätyllä tavalla vaikkapa tuotoksen nimi, tekijä, aika ja paikka, jolloin halutut metatiedot ovat samankaltaisessa muodossa (formaatissa). 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 tai Research Data Alliance -yhteisön ylläpitämistä luetteloista. Monissa datarepositoriossa tai arkistoissa on käytössä jokin metadatastandardi. Esimerkiksi Tietoarkistossa sovelletaan DDI-metadatastandardia (Data Documentation Initiative), joka on kehitetty erityisesti yhteiskuntatieteellisen data-aineiston kuvailun tarpeita silmällä pitäen.

Metadata tekstimuodossa (README-tiedosto)

Tutkimusaineistojen metadataa voi tallentaa vapaamuotoisesti tavallisena tekstitiedostona eli README–tyyppisenä tiedostona aineiston yhteyteen. Siihen voi kirjata esimerkiksi jäsennellyt aineiston perustiedot, miten aineisto on kerätty ja mitä varten, miten ja missä aineistoa säilytetään tai miten tutkimus on toteutettu. Alla on pari esimerkkiä, miten tutkimusaineistoa voi kuvata README –tiedostona.

Aineiston perustietoihin kannattaa sisällyttää seuraavat tiedot:

aineiston nimi
tieteenala
tekijät eli henkilöt, jotka ovat vastuussa aineiston ajatuksellisen sisällön kehittelystä (yleensä hankkeen vetäjät) ja joista kerrotaan nimi, sähköposti, organisaatio ja yksikkö
muut aineiston kerääjät, tallentajat ja käsittelijät (nimi ja organisaatio)
rahoittajat.

Tutkimuksen toteutuksen kuvailu voi sisältää seuraavia tietoja:

alkuperäinen käyttötarkoitus eli tiedot projektista, mitä varten aineisto on kerätty
aineistonkeruun ajankohta: alkamis- ja päättymispäivät
millaista aineistoa on kerätty ja miten: kuvataan kerätty aineisto sekä aineistonkeruussa käytetty menetelmä(t)
aineiston määrä ja tiedostojen kuvailu: kuvataan, miten paljon aineistoa on määrällisesti ja aineistoon kuuluvat tiedostot hakemistona (tiedoston nimi, formaatti + mitä sisältää).
aineiston muokkaus: kuvataan, miten aineistoa on muokattu, esim. anonymisointi, aineisto-osien tai muuttujien poisto jne.
julkaisut, jotka pohjautuvat aineistoon.

Esimerkkejä metatietojen dokumentoinnista README –tiedostojen avulla mallilomakkeineen:

Pohdittavaksi

Mitä dokumentaatio tarkoittaa omalla tutkimusalallasi?
Miten dokumentoit omaa aineistoasi?
Millaista metadataa tarvitset tutkimusprojektisi aikana ja sen jälkeen?
Miten kuvailisit aineistosi perustiedot README-tiedostona?

Qvain-kuvailutyökalu ja Etsin-hakupalvelu

Standardoitua ja rakenteista kuvailutietoa voi tuottaa mille tahansa aineistolle esimerkiksi Fairdata Qvain-kuvailutyökalulla riippumatta aineiston tallennus- tai julkaisupaikasta. Qvaimen avulla aineiston kuvailutiedot voidaan julkaista, minkä jälkeen ne ovat näkyvillä tutkimusaineistojen hakupalvelu Etsimessä. Qvaimen käyttöoppaasta löytyy tietoa mm. kuvailutietojen vähimmäisvaatimuksista. Katso myös Qvain-ohjevideo (CSC).

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. Toisin sanoen Etsin myös haravoi (kopioi) muualla olevia aineistokuvailuja esimerkiksi Tietoarkistosta tai Kielipankista. Vastaavasti Etsimestä haravoidaan kuvailutietoja muualle kuten Itä-Suomen yliopiston eRepositorioon (eRepo). Siksi on tärkeää, että kaikki UEFissa tuotettu data kuvaillaan Etsimeen.

Qvain ja Etsin kuuluvat kansalliseen Fairdata.fi-palvelukokonaisuuteen, josta on kerrottu oppimateriaalin luvussa 1.

Katso video

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

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ä edesauttava kansiorakenne, ja johdonmukainen tapa nimetä tiedostot, niin että jo nimi kertoo olennaista tietoa tiedostoista. Tutkimusprojektia varten laadittua sopivaa nimeämissysteemiä kannattaa käyttää johdonmukaisesti koko projektin ajan. Nimeämissysteemi on hyvä kirjata ja tallentaa osana aineiston kuvailua. 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
tiedostoformaatti
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).

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

_(2025-08)

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

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