Zum Inhalt springen
RepoReady
Registrieren
Menü
Menü der Dokumentation

Software-Wiederverwendung: Code, auf dem andere aufbauen

Wiederverwendung fragt, ob sich ein benannter Algorithmus oder ein Paket über Ihr Paper hinaus nutzen und anpassen lässt. RepoReady prüft das noch nicht; die Stufe des Papers ändert es nie.

Zuletzt aktualisiert

Wiederverwendung betrifft die eigene Software eines Repositorys, neben der Stufe des Papers.
Bezug zur StufeSeparate Achse · noch nicht geprüft

Eine Methode, die andere installieren und auf eigene Daten anwenden können, reicht weiter als das Paper. Die Prüfkriterien von JOSS sind eine gute Checkliste: Dokumentation, Installation, Anwendungsbeispiele, Tests und eine Lizenz.

Installation

Was zählt
Die Software lässt sich mit einem Standardbefehl aus einem Paketindex oder dem Repository installieren, mit deklarierten Abhängigkeiten.
Häufige Lücken
Code, der nur im Analyseordner läuft, mit Pfaden zu Ihren eigenen Daten.
So beheben Sie es
Verpacken Sie die Methode getrennt von der Analyse, mit einer pyproject.toml oder einer R-DESCRIPTION:
pyproject.toml
[project]
name = "cellfilter"
version = "1.2.0"
description = "Quality filtering for single-cell count matrices"
requires-python = ">=3.10"
dependencies = ["numpy>=1.26", "anndata>=0.10"]
license = "MIT"

[project.optional-dependencies]
test = ["pytest"]

Dokumentierte Schnittstelle und Beispiele

Was zählt
Ein README oder eine Dokumentationsseite erklärt Eingaben, Ausgaben und Optionen, mit einem kurzen Beispiel auf Testdaten.
Häufige Lücken
Funktionen, die nur im Methodenteil des Papers beschrieben sind.
So beheben Sie es
Dokumentieren Sie die öffentlichen Funktionen und liefern Sie einen kleinen Beispieldatensatz mit einem durchgerechneten Beispiel.

Automatisierte Tests

Was zählt
Tests prüfen die Kernfunktionen auf kleinen, mitgelieferten Daten, idealerweise gegen bekannte Ergebnisse.
Häufige Lücken
Tests, die Ihren vollständigen Datensatz oder Ihren Cluster brauchen, sodass sie niemand sonst ausführen kann.
So beheben Sie es
Ergänzen Sie Tests, die in Sekunden auf mitgelieferten Daten laufen, und führen Sie sie bei jeder Änderung aus.

Releases und Lizenz

Was zählt
Nummerierte Releases mit Änderungsprotokoll, jedes mit DOI archiviert, unter einer offenen Lizenz. Die Lizenz wird einmal geprüft, unter der Zeitschriftenrichtlinie; dieser Bereich zeigt das Ergebnis.
Häufige Lücken
Ein einziger Stand für das Paper, ohne Hinweis, was sich ändern darf.
So beheben Sie es
Veröffentlichen Sie mit Versionsnummern, notieren Sie Änderungen je Release und archivieren Sie jedes, etwa mit Zenodo.

Sehen Sie, wo Ihr Projekt steht

Starten Sie die Analyse für Ihr Paper oder Repository. Jeder Befund nennt seinen Bereich und verweist hierher.

Jetzt starten