Onderzoekssoftware en reproduceerbaarheid

Wat is een CITATION.cff bestand en waarom zou jij er nu één aanmaken

Lieke de Vries Lieke de Vries
· · 6 min leestijd

Stel: je hebt maandenlang aan onderzoekssoftware gecodeerd. Iemand anders gebruikt jouw tool in een publicatie, maar citeert het verkeerd — of helemaal niet. Frustrerend, toch?

Inhoudsopgave
  1. Wat is een CITATION.cff bestand eigenlijk?
  2. Waarom zou jij er NU één aanmaken?
  3. Hoe begin je? Zo.
  4. De tijd is nu
  5. Veelgestelde vragen

Een CITATION.cff bestand voorkomt precies dat probleem. En het kost je vijf minuten om er één aan te maken.

Wat is een CITATION.cff bestand eigenlijk?

Een CITATION.cff bestand is een eenvoudig tekstbestand dat in je software-repository staat. Het bevat alle informatie die iemand nodig heeft om jouw software of dataset correct te citeren.

Denk aan de naam van de auteur, de titel, het versienummer, de release datum en eventueel een DOI. Het formaat heet Citation File Format, of kortweg CFF. Het is zowel leesbaar voor mensen als voor machines.

Dat betekent dat platforms als GitHub en Zenodo de informatie er automatisch uit kunnen halen en omzetten in een geformuleerde verwijzing — in APA, MLA, Chicago, of welk formaat de gebruiker maar wil.

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Druskat
    given-names: Stephan
    orcid: https://orcid.org/1234-5678-9101-1121
title: "My Research Software"
version: 2.0.4
identifiers:
  - type: doi
    value: 10.5281/zenodo.1234
date-released: 2021-08-11

Ziet er zo uit: Simpel, leesbaar, en in YAML-formaat. Je hebt geen programmeerkunsten nodig om dit te begrijpen of aan te passen.

Waarom zou jij er NU één aanmaken?

1. Jouw werk verdient erkenning

Onderzoekssoftware is wetenschappelijk werk. Toch wordt software nauwelijks geciteerd in publicaties, terwijl artikelen en boeken wél standaard worden vermeld.

2. GitHub en Zenodo doen het automatisch

Een CITATION.cff bestand maakt het makkelijk voor anderen om jouw bijdrage correct te vermelden.

3. Het verhoogt de vindbaarheid van jouw onderzoek

Geen excuses meer van het type "ik wist niet hoe." GitHub herkent een CITATION.cff bestand in je repository. Er verschijnt dan een knop "Cite this repository" rechtsboven, waarmee bezoekers direct de juiste verwijzing kunnen kopiëren. En als je je repository koppelt aan Zenodo — wat veel onderzoekers doen — dan wordt de citatie-informatie automatisch meegenomen in de DOI-registratie.

Minder handwerk, meer zekerheid. Software die goed geciteerd wordt, is beter vindbaar.

4. Het past bij de FAIR-principes

Dat geldt niet alleen voor anderen die je werk willen gebruiken, maar ook voor jou wanneer je solliciteert, een aanvraag indient, of je impact wilt aantonen. Elke correcte citatie telt mee in je onderzoeksprofiel. Binnen Open Science praten we veel over FAIR data: Findable, Accessible, Interoperable, en Reusable. Software verdient dezelfde behandeling.

Een CITATION.cff bestand draagt direct bij aan de "F" en de "R".

5. Het is ongelooflijk simpel

Het maakt je software vindbaar en herbruikbaar, precies wat de wetenschappelijke gemeenschap nodig heeft. Je hoeft geen bestand te bouken vanuit scratch. Wil je meer weten over hoe je software beschrijft voor machines?

De Citation File Format website biedt een online generator waar je gewoon velden invult. Je vult in wie de auteurs zijn, wat de titel is, welke versie je uitgebracht hebt, en of je een DOI hebt. Klik op genereren, download het bestand, en plaats het in de root van je repository. Klaar.

Hoe begin je? Zo.

Open je repository. Maak een nieuw bestand aan met de naam CITATION.cff.

Vul de velden in met jouw gegevens. Commit en push. Dat is het.

Wil je het extra goed doen? Voeg een ORCID toe, gebruik een DOI van Zenodo of Figshare, en zorg dat je het bestand bijwerkt bij elke nieuwe release. Maar zelfs een minimale versie is al beter dan helemaal niets.

De tijd is nu

We leven in een tijd waarin reproduceerbaarheid en transparantie centraal staan in onderzoek.

Jouw software is een essentieel onderdeel van dat ecosysteem. Een CITATION.cff bestand is de makkelijkste manier om ervoor te zorgen dat jouw werk de krijgt die het verdient. Vijf minuten van je tijd. Een bestandje in je repo.

En vanaf dat moment kan iedereen jouw software correct citeren zonder er over na te hoeven denken. Wat wacht je nog op?

Veelgestelde vragen

Wat is het specifieke doel van een CITATION.cff bestand?

Een CITATION.cff bestand is een simpel tekstbestand dat in je software-repository wordt geplaatst. Het bevat alle essentiële details – zoals auteur, titel, versie en publicatiedatum – zodat anderen je werk correct en consistent kunnen citeren in hun publicaties, ongeacht het gekozen citaatformaat (zoals APA of MLA).

Hoe helpt een CITATION.cff bestand bij het vinden van mijn onderzoek?

Door een CITATION.cff bestand in je repository te plaatsen, maakt GitHub het automatisch mogelijk voor bezoekers om direct een citaat te kopiëren via een knop rechtsboven. Daarnaast, wanneer je je repository koppelt aan Zenodo, wordt de citatie-informatie automatisch opgenomen in de DOI-registratie, wat de vindbaarheid van je onderzoek verder verhoogt. Onderzoekssoftware verdient erkenning, net als artikelen en boeken.

Waarom is het belangrijk om software te citeren, en wat is de rol van een CITATION.cff bestand in dit proces?

Een CITATION.cff bestand zorgt ervoor dat je bijdrage correct wordt vermeld, en draagt bij aan je onderzoeksprofiel en impact, in lijn met de FAIR-principes van vindbaarheid, toegankelijkheid en hergebruik.

Kan ik een CITATION.cff bestand gebruiken voor mijn persoonlijke sollicitaties of aanvragen?

Ja, absoluut! Het correct citeren van je software via een CITATION.cff bestand is niet alleen belangrijk voor wetenschappelijke publicaties, maar ook voor sollicitaties, aanvragen en het aantonen van je onderzoeksprofiel. Het toont aan dat je je werk serieus neemt en dat je de juiste procedures volgt.

Hoe complex is het om een CITATION.cff bestand aan te maken?

Het maken van een CITATION.cff bestand is verrassend eenvoudig! Het is een simpel tekstbestand dat je zelf kunt aanpassen, zonder dat je programmeerkennis nodig hebt. Binnen enkele minuten heb je een bestand dat je software correct kan citeren.


Lieke de Vries
Lieke de Vries
Expert in Open Science principes

Lieke adviseert onderzoekers over het publiceren van FAIR data volgens de nieuwste normen.

Meer over Onderzoekssoftware en reproduceerbaarheid

Bekijk alle 28 artikelen in deze categorie.

Naar categorie →
Lees volgende
Waarom onderzoekssoftware ook FAIR moet zijn en niet alleen jouw data
Lees verder →