Zum Inhalt springen
RepoReady
Registrieren
Menü
Menü der Dokumentation

Materialien: Code, Eingaben und Software

L1 Materialien verfügbar braucht für jedes Kernergebnis drei Dinge: den Code, der es berechnet, die Eingaben, die er liest, und die Software, die er braucht.

Zuletzt aktualisiert

Eine Eingabe fehlt nachweislich. Das Projekt bleibt auf L0, bis sie verfügbar ist.
Bezug zur StufeErforderlich für L1

Ohne Code, Daten und Software hinter einem Ergebnis kann keine Dokumentation es prüfbar machen, deshalb entscheiden die Materialien über L1. Ergänzende Ergebnisse, etwa Abbildungen im Supplement, zählen eine Stufe tiefer: Ihre Lücken blockieren L2. Die FAIR-Prinzipien verlangen Daten, die sich über eine dauerhafte Kennung abrufen lassen.

Code for each result is available

Was zählt
Öffentlicher Code in einem Repository oder Archiv berechnet die Werte jeder zentralen Abbildung, Tabelle und jedes Datensatzes. Statistik in Plot-Skripten zählt, rein gestalterischer Plot-Code nicht.
Häufige Lücken
Kein verlinkter Code, ein nie geteiltes Notebook, Code, der eine andere Größe berechnet, oder Code, zuletzt lange vor der Annahme geändert (eine Warnung).
So beheben Sie es
Teilen Sie jedes Skript, das einen berichteten Wert berechnet, auch Analysen aus der Revision, und nennen Sie es im README.

Input data can be obtained

Was zählt
Jede Datei, die der Code liest, liegt im Repository, entsteht durch den Code oder ist mit funktionierender Kennung hinterlegt. Kontrollierte Daten zählen mit dokumentiertem Zugangsweg.
Häufige Lücken
Eine gelesene Datei, nirgends geteilt, ein Depot ohne sie, ein toter Link oder „auf Anfrage“. Daten, die nur Skripte ohne Ergebnis lesen: eine Warnung.
So beheben Sie es
Hinterlegen Sie selbst erzeugte Daten in einem Archiv mit DOIs. Nennen Sie für kontrollierte Daten das Komitee, den Antragsweg und den Ablageort:
README.md
## Daten

| Datensatz        | Quelle  | Kennung                | Version | Zugang                |
|------------------|---------|------------------------|---------|-----------------------|
| Rohdaten         | Zenodo  | 10.5281/zenodo.0000000 | v2      | offen                 |
| Patientenkohorte | EGA     | EGAD00000000000        | 2024-03 | Data Access Committee |
| Referenz         | Ensembl | GRCh38                 | 110     | offen                 |

Required software can be obtained

Was zählt
Neben Ihrem eigenen Code ist jedes Paket, Werkzeug, Modell und jeder Dienst, von dem er abhängt, etwa scanpy oder ein vortrainiertes Modell, über einen Paketindex, Model Hub, ein öffentliches Repository oder Archiv erhältlich. Kommerzielle Software zählt.
Häufige Lücken
Ein nie veröffentlichtes internes Paket, fehlende Modellgewichte, ein gelöschtes Repository ohne Archiv. Schritte, die kommerzielle Software brauchen: eine Warnung.
So beheben Sie es
Veröffentlichen Sie interne Werkzeuge und Gewichte oder archivieren Sie die genutzten Versionen. Nennen Sie kommerzielle Software mit Version, Hersteller und den Schritten, die sie brauchen.

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