Templates & Tools

SCIproj — Forschungskompendien erstellen

Ein Forschungskompendium (Research Compendium) ist ein standardisiertes Projektformat, das Daten, Code und Dokumentation so organisiert, dass Analysen nachvollziehbar, reproduzierbar und nachnutzbar sind. Es bildet die Grundlage für transparente und FAIR-konforme Forschung.

Das R-Paket SCIproj erstellt mit einem einzigen Befehl ein vollständig eingerichtetes Forschungskompendium – inklusive Ordnerstruktur, Versionskontrolle, Abhängigkeitsmanagement und maschinenlesbarer Metadaten.

Hauptmerkmale

  • Standardisierte Projektstruktur – klare Trennung von Rohdaten (data/), aufbereiteten Daten (data_processed/), Code (R/, scripts/), Ergebnissen (output/) und Dokumentation (docs/)
  • Abhängigkeitsmanagement mit renv – exakte Paketversionen werden festgehalten, sodass Analysen auch Jahre später reproduzierbar sind
  • Pipeline-Workflow mit targets – automatische Abhängigkeitsverfolgung und selektive Neuberechnung geänderter Analyseschritte
  • Maschinenlesbare Zitation – CITATION.cff für standardisierte Metadaten (kompatibel mit GitHub, Zenodo, ORCID)
  • Datendokumentation – DATA_SOURCES.md-Template zur Erfassung von Herkunft, Lizenz und DOI aller Datensätze
  • Versionskontrolle – automatische Git-Initialisierung mit sinnvollen .gitignore-Einträgen
  • Optionale Erweiterungen – Docker-Unterstützung, GitHub-Integration und Continuous Integration

Installation

WichtigAuf CRAN verfügbar

Version 1.0.0 wurde am 18. März 2026 auf CRAN veröffentlicht.

# Von CRAN (empfohlen)
install.packages("SCIproj")

# Oder die Entwicklungsversion von GitHub
if (!require("pak")) install.packages("pak")
pak::pkg_install("saskiaotto/SCIproj")

Schnellstart

library("SCIproj")

# Neues Forschungskompendium erstellen
create_proj("mein_forschungsprojekt")

Dies erzeugt ein vollständig eingerichtetes Projektverzeichnis mit allen oben genannten Komponenten. Weitere Optionen und Konfigurationsmöglichkeiten findest du in der Dokumentation auf GitHub.

Hintergrund

SCIproj orientiert sich an etablierten Standards und Empfehlungen für offene und reproduzierbare Forschung: