Die Bedeutung von README-Dateien und ihre Bestandteile

Eine README-Datei ist ein Textdokument zur Beschreibung eines Replication Packages. Sie erläutert die darin enthaltene Sammlung aus Daten, Code und weiteren Materialien, die einem (empirischen) Forschungsartikel beigefügt wird, und erklärt Schritt für Schritt, wie die Ergebnisse reproduziert werden können. In den Wirtschaftswissenschaften ist eine aussagekräftige README-Datei der wichtigste Bestandteil eines Replication Packages. Ohne sie verlieren selbst vollständig geteilte Daten und Code an Wert, da zentrale Informationen für die Interpretation, Validierung und Nachnutzung fehlen.

README-Dateien sind vor allem für empirische Artikel relevant, können aber in anderen Kontexten ebenfalls sinnvoll sein: etwa wenn theoretische Modelle numerisch gelöst oder Simulationen durchgeführt werden und der zugehörige Code dokumentiert werden muss.

Viele führende wirtschaftswissenschaftliche Journals (wie zum Beispiel Journals der American Economic Association (AEA) und das Review of Economic Studies) verlangen eine README-Datei bereits als verbindlichen Bestandteil eines Replication Packages. Die Anforderungen der Journals sind weitgehend deckungsgleich und umfassen für README-Dateien empirischer Artikel die folgenden Elemente:

  1. Überblick
  2. Data Availability Statement (DAS)
  3. Statement about Rights
  4. Systemanforderungen
  5. Anleitung zur Reproduktion
  6. Zuordnung von Code zu Outputs
  7. Beschreibung der Programmdateien
  8. Ordnerstruktur