Menü der Dokumentation
Anforderungen und Leitfäden
Sehen Sie, was eine Stufe verlangt oder was wir in jedem Bereich untersuchen. Jede Anforderung verweist auf ihren Abschnitt im Leitfaden des Bereichs.
Zuletzt aktualisiert
Stufen verbinden Nachweise aus mehreren Bereichen. Öffnen Sie eine Stufe für ihre eigenen Anforderungen; höhere Stufen brauchen zusätzlich die darunter.
L0Materialien unvollständigEine bestätigte Materiallücke
L0 hat keine eigenen Anforderungen: Die Stufe hält fest, dass ein wesentliches Material nachweislich fehlt. Der Leitfaden Materialien hilft beim Beheben.
L1Materialien verfügbarAnforderungen dieser Stufe
Erforderlicher Code, Eingaben und Software sind im geprüften Umfang erfasst, mit Nachweisen zur Verfügbarkeit oder einem glaubwürdigen Zugangsweg.
Öffentlicher Code berechnet die Werte hinter jedem Kernergebnis.
PrüfbereichMaterialienBezug zur StufeErforderlich für L1Jede Datei, die der Code liest, ist geteilt, hinterlegt oder hat eine dokumentierte Quelle.
PrüfbereichMaterialienBezug zur StufeErforderlich für L1Neben dem eigenen Code der Autoren ist jedes Paket, Werkzeug und Modell, von dem er abhängt, etwa scanpy oder ein vortrainiertes Modell, erhältlich, auch kommerzielle.
PrüfbereichMaterialienBezug zur StufeErforderlich für L1
L2Arbeitsablauf dokumentiertAnforderungen dieser Stufe
L1 plus vollständige Anleitung, Versionen, Aufbereitung und Ergebniszuordnung. Bestätigte Manuskriptwidersprüche blockieren diese Stufe.
Eine Abhängigkeitsdatei listet jedes importierte Paket mit Version oder Versionsbereich.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Eine unveränderliche Code-Version ist zitiert, genannte Werkzeugversionen passen zum Code.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Jeder Datensatz hat eine dauerhafte, versionierte Kennung und einen beschriebenen Zugangsweg.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Jede Eingabe, die kein geteilter Code erzeugt, kommt mit ihren Aufbereitungsschritten.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Jede zentrale Abbildung und Tabelle nennt das eine Skript, das sie erzeugt.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Die Anleitung nennt Einrichtung, Ablageort der Eingaben, Reihenfolge und manuelle Schritte.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Jeder dokumentierte Befehl, jede Datei, Option und jeder Paketname passt zum Repository.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Ergebniscode enthält keine rechnerspezifischen Pfade und keine unerklärte Plattformbindung.
PrüfbereichDokumentationBezug zur StufeErforderlich für L2Methoden, Parameter, Statistik und berichtete Zahlen entsprechen dem, was der Code tut.
PrüfbereichManuskriptkonsistenzBezug zur StufeBestätigte Widersprüche blockieren L2
Separate BewertungenErhöhen die Stufe nicht
Automatisierung, Zugang und Archivierung, Software-Wiederverwendung sowie Richtlinien und gute Praxis bleiben neben der Stufe sichtbar. Sie ersetzen nie erforderliche Materialien oder Dokumentation.
Ein dokumentierter Befehl erzeugt alle Kernergebnisse neu, ohne manuelle Schritte.
PrüfbereichAutomatisierungBezug zur StufeUnabhängig von der StufeExakte Versionen aller Pakete, der Laufzeit und des Basis-Images sind fixiert.
PrüfbereichAutomatisierungBezug zur StufeUnabhängig von der StufeDer Startbefehl lädt und prüft seine Eingaben, ohne manuelle Downloads.
PrüfbereichAutomatisierungBezug zur StufeUnabhängig von der StufeZufallsziehungen haben Seeds, Schwankungen zwischen Läufen sind gesteuert oder dokumentiert.
PrüfbereichAutomatisierungBezug zur StufeUnabhängig von der StufeLizenz, Zitationsdatei und Quelldaten, die Richtlinien von Fachzeitschriften verlangen.
PrüfbereichRichtlinien und gute PraxisBezug zur StufeUnabhängig von der StufeHinweise jenseits der Stufen: aufgeräumtes Repository, Tests und ein stimmiges Paper.
PrüfbereichRichtlinien und gute PraxisBezug zur StufeUnabhängig von der Stufe
Was eine Prüfung umfasst
Eine Prüfung liest verfügbaren Code, Paper, Daten und Dokumentation; der Code wird nicht ausgeführt. Anleitungen können Repository, Paper und verlinkte Supplemente umfassen. Bereiche, die eine Prüfung nicht untersucht hat, bleiben „nicht geprüft“.