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
Bereiche beschreiben, was wir untersuchen. Jeder Bereich hat einen Leitfaden: Öffnen Sie einen Bereich für seine Anforderungen und ihren Bezug zu den Stufen.
MaterialienErforderlich für L1
Sind notwendiger Code, Eingaben und Software erfasst? Öffentlicher, kontrollierter und privater Zugang werden separat ausgewiesen.
Ö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
DokumentationErforderlich für L2
Können Prüfende dem Ablauf folgen und seine Ergebnisse zuordnen? Auffindbare Anleitungen dürfen im Paper, Repository oder verlinkten Dokumenten stehen.
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 L2
ManuskriptkonsistenzEin Widerspruch blockiert L2
Eine Materials and workflow-Prüfung vergleicht für jedes Kernergebnis das Paper mit Code und Ausgaben. Bestätigte Widersprüche blockieren L2; ungeklärte Nachweise bleiben sichtbar.
Methoden, Parameter, Statistik und berichtete Zahlen entsprechen dem, was der Code tut.
PrüfbereichManuskriptkonsistenzBezug zur StufeBestätigte Widersprüche blockieren L2
AutomatisierungUnabhängig von der Stufe
Sind Einstiegspunkte, Umgebung, Datenabruf und Zufall gesteuert? Statische Automatisierungsnachweise belegen keine erfolgreiche Ausführung.
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 Stufe
Zugang & ArchivierungUnabhängig von der Stufe
Wie sind Materialien zugänglich und dauerhaft archiviert? Öffentlicher, kontrollierter und privater Zugang sind von der Archivierung zu unterscheiden. Zugangsbedingungen aus der Prüfung werden angezeigt; eine Archivprüfung erfolgt noch nicht.
Software-WiederverwendungSeparate Achse · noch nicht geprüft
Lässt sich ein benannter Algorithmus oder ein Softwarepaket über die Analyse dieser Publikation hinaus verwenden und anpassen? Bewertet wird die Softwarekomponente. Nicht anwendbar erfordert eine ausdrückliche Begründung zum Prüfumfang. Ein Wiederverwendungs-Badge erhöht die Bereitschaftsstufe nicht.
Richtlinien und gute PraxisErhöhen die Stufe nicht
Zeitschriftenrichtlinien (Lizenz, Zitationsdatei, Quelldaten) und gute Praxis (aufgeräumtes Repository, Tests, stimmiges Paper). Ihre Befunde sind Warnungen: Sie ändern die Stufe nie.
Lizenz, 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“.