Stel: je onderzoek is af. Je hebt data, code, figuren, een paper. Alles klopt.
▶Inhoudsopgave
Maar dan vraagt iemand: "Kun je laten zien hoe je hier bent gekomen?" En ineens ligt alles verspreid over vijftien mappen, drie laptops en een USB-stick die nergens meer in past.
Daarvoor bestaat een research compendium. Geen ingewikkeld systeem, maar gewoon een map waar alles in komt wat bij jouw onderzoek hoort: data, code, tekst, instructies. Alles bij elkaar. Alles georganiseerd. Zodat jij — of iemand anders — later precies kan zien, nabouwen en controleren wat je hebt gedaan. In dit artikel lees je wat een research compendium precies is, waarom het tijd bespaart (en je onderzoek sterker maakt), en hoe je er zelf één opzet. Stap voor stap. Geen voorkennis nodig.
Wat is een research compendium precies?
Een research compendium is een gestructureerde verzameling van alle bestanden die bij één onderzoek horen. Denk aan:
- Ruwe en bewerkte data
- Analysecode (bijvoorbeeld in R, Python of Julia)
- Figuren en tabellen
- Het manuscript of rapport
- Uitleg over hoe alles werkt
Het idee is simpel: als iemand jouw onderzoek wil controleren of hergebruiken, hoeft die persoon maar één map te openen. Alles zit erin. Alles is te vinden. De term is populair geworden binnen de Open Science-beweging, maar eigenlijk is het gewoon goede onderzoekspraktijk. Of je nu werkt aan een PhD, een beleidsrapport of een data-analyse voor je werkgever — een compendium maakt je werk beter navolgbaar. En dat is precies waarom universiteiten, fondsenverstrekkers en tijdschriften er steeds vaker om vragen.
Waarom maak je een research compendium?
Goede vraag. Want het kost tijd om alles netjes te organiseren, toch? Klopt.
1. Jouw toekomstige zelf zal je bedanken
Maar die tijd verdien je terug. En dan heb ik het niet eens over de carrot — de beloningen van open werken — maar gewoon over praktisch voordeel.
2. Reproduceerbaarheid is geen luxe meer
Onderzoek duurt lang. Twee jaar na het afronden van een project weet je niet meer waar je die ene script hebt opgeslagen. Of waarom je die variabele hebt hernoemd. Een goed compendium voorkomt die frustratie.
De zogenaamde reproduceerbaarheidscrisis is reëel. Studies laten zien dat een groot deel van wetenschappelijke bevindingen niet te herhalen is.
3. Fondsenverstrekkers en tijdschriften vragen erom
Een research compendium is een van de eenvoudigste manieren om daar verandering in te brengen. Als jij het zelf kunt reproduceren, kunnen anderen dat ook. NWO, ZonMw, de EU — ze willen steeds vaker zien dat onderzoeksdata en code goed worden beheerd.
Een compendium laat precies zien dat je dat doet. Het maakt je subsidieaanvraag sterker en je publicatie geloofwaardiger.
4. Samenwerken wordt makkelijker
Werken in een team? Dan is een gedeelde, gestructureerde map goud waard.
Iedereen weet waar alles staat. Geen e-mailverzoeken meer om "de nieuwste versie van het script".
Hoe ziet een research compendium eruit?
Er is geen officiële standaard, maar er zijn wel best practices die veel worden gebruikt.
mijn-onderzoek/
├── data/
│ ├── raw/ # onbewerkte data (niet aanpassen!)
│ └── processed/ # opgeschoonde, analyseklaare data
├── R/ of scripts/ # analysecode
├── figures/ # gegenereerde figuren
├── manuscript/ # paper of rapport
├── README.md # uitleg over het hele project
└── DESCRIPTION of metadata.json # projectinformatie
De meeste compendia volgen een vergelijkbare structuur: De README is misschien wel het belangrijkste bestand. Leer hoe je een README schrijft die anderen écht helpt om jouw code te begrijpen, de samenhang te zien en de analyse te herhalen. Zonder README is een compendium maar half waard. Er zijn twee soorten compendia die je tegenkomt: Alles bij elkaar, maar niet direct uitvoerbaar. Iemand moet zelf de scripts in de juiste volgorde draaien.
Dit is al een enorme stap vooruit vergeleken met een rommelige map op je bureaublad. Hierbij kan iemand met één commando de hele analyse laten draaien.
Basic compendium
Denk aan tools als Make, targets (in R) of Snakemake (in Python).
Executable compendium
Dit is de gold standard, maar vergt wat meer technische kennis.
Stap voor stap: zo maak je zelf een research compendium
Genoeg achtergrond. Laten we aan de slag.
Stap 1: Kies je tooling
Hieronder vind je een praktisch stappenplan dat werkt voor vrijwel elk project. Je hebt geen speciale software nodig. Een research compendium is in principe gewoon een map op je computer. Maar bepaalde tools maken het een stuk makkelijker:
- R gebruikers: kijk naar het rrtools-pakket van Anna Krystalli. Hiermee genereer je met een paar commando's een complete compendium-structuur.
- Python gebruikers: cookiecutter heeft templates voor reproduceerbare projecten.
- Algemeen: The Turing Way (een open handleiding van het Alan Turing Institute) beschrijft uitgebreid hoe je een compendium opzet, ongeacht je programmeertaal.
Stap 2: Maak de mappenstructuur aan
Maak de map aan die hierboven beschreven staat. Niet ingewikkeld — gewoon data/raw, data/processed, R/, figures/, enzovoort.
Stap 3: Schrijf een README
Belangrijk: raak de ruwe data nooit aan. Bewerk alleen kopieën. Open een tekstbestand, noem het README.md, en schrijf op:
- Wat is het doel van dit project?
- Welke bestanden zitten erin en waarvoor dienen ze?
- Hoe draai je de analyse?
- Welke software en versies heb je gebruikt?
Schrijf het alsof je het aan een collega uitlegt die het project nog nooit heeft gezien. Want dat ben je over zes maanden zelf. Een compendium zonder context is moeilijk te begrijpen.
Stap 4: Voeg metadata toe
Voeg een DESCRIPTION-bestand (in R) of een metadata.json toe met informatie over de auteur, datum, licentie en gebruikte softwareversies. Dit maakt je werk vindbaar en herbruikbaar.
Stap 5: Maak het reproduceerbaar
Test jezelf: kun je op een andere computer de hele analyse draaien? Zo niet, dan is er werk aan de winkel. Let op: Een compendium op je eigen laptop is nuttig.
- Gebruik relatieve paden, geen absolute paden zoals
C:\Users\Johan\Documents\... - Leg in je code welke pakketten en versies nodig zijn
- Overweg een renv (R) of requirements.txt (Python) om de exacte softwareomgeving vast te leggen
Stap 6: Deel het
Een compendium dat je deelt, is waardevol. Overweeg om je compendium te publiceren op:
- Zenodo — koppelt automatisch aan GitHub en geeft je een DOI
- Figshare — populair bij veel universiteiten
- OSF (Open Science Framework) — ideaal voor grotere projecten met meerdere bestanden
Door een compendium te delen, wordt je onderzoek niet alleen transparant — het wordt ook citeerbaar. Dat telt mee bij je h-index. Maak je onderzoekscode herbruikbaar voor anderen.
Begin klein, begin nu
Je hoeft niet meteen een perfect, geautomatiseerd, executable compendium te bouwen. Begin met wat je hebt: maak een map, stop je data en code erin, schrijf een README en zorg dat je Jupyter notebook over vijf jaar nog werkt.
Dat is al een enorme verbetering. De beste tijd om een research compendium te maken, is aan het begin van je project. De op één na beste tijd is nu. Want reproduceerbaarheid is geen extraatje — het is de kern van goed onderzoek. En een compendium is de eenvoudigste manier om daarvoor te zorgen.
Veelgestelde vragen
Hoe begin ik met het opzetten van een research compendium?
Begin met het creëren van een centrale map voor je onderzoek. Binnen deze map maak je submappen voor verschillende categorieën, zoals data, code, figuren en rapporten.
Waarom is het belangrijk om een research compendium te maken, zelfs als het tijd kost?
Zorg ervoor dat je bestanden duidelijk en consistent benoemt, zodat je ze later gemakkelijk kunt vinden en hergebruiken.
Wat gebeurt er als ik mijn onderzoek niet goed georganiseerd bewaar?
Het opzetten van een compendium is een investering in de toekomst van je onderzoek. Door je bestanden georganiseerd te houden, voorkom je frustratie en verlies van tijd bij het herhalen of uitbreiden van je werk, en draag je bij aan de reproduceerbaarheid van je onderzoek. Zonder een compendium kan het lastig zijn om terug te kijken op je onderzoek, waardoor je belangrijke details of stappen kunt vergeten.
Hoe kan een research compendium mijn onderzoek versterken in de ogen van bijvoorbeeld universiteiten of tijdschriften?
Dit kan leiden tot problemen bij het reproduceren van je resultaten of het delen van je werk met anderen, en kan de geloofwaardigheid van je onderzoek ondermijnen. Een goed georganiseerd compendium toont aan dat je je onderzoekspraktijken serieus neemt en dat je aandacht hebt voor de transparantie en reproduceerbaarheid van je werk.
Wat moet er allemaal in een research compendium zitten?
Dit is steeds vaker een vereiste voor subsidies, publicaties en andere vormen van wetenschappelijke erkenning. Een research compendium moet alle relevante bestanden bevatten die bij je onderzoek horen, waaronder de ruwe en bewerkte data, de analysecode (zoals R, Python of Julia), figuren en tabellen, het manuscript of rapport, en een uitleg over hoe alles werkt. Denk aan een complete 'reisgids' voor je onderzoek.