Snakemake – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

Snakemake – eine Python-basierte Sprache und Ausführungsumgebung für GNU Makelike-Workflows

BESCHREIBUNG

Verwendung: Snakemake [-h] [--snakefile FILE] [--gui [PORT]] [--cores [N]]

[--resources [NAME=INT [NAME=INT ...]]] [--config [KEY=VALUE [KEY=VALUE ...]]]
[--configfile FILE] [--list] [--list-target-rules] [--directory DIR] [--dryrun]
[--printshellcmds] [--dag] [--rulegraph] [--d3dag] [--summary] [--detailed-summary]
[--touch] [--keep-going] [--force] [--forceall] [--forcerun TARGET [TARGET ...]]
[--prioritize TARGET [TARGET ...]] [--allow-ambiguity] [--cluster CMD |
--cluster-sync CMD | --drmaa [ARGS]] [--cluster-config FILE] [--immediate-submit]
[--jobscript SCRIPT] [--jobname NAME] [--reason] [--stats FILE] [--nocolor]
[--quiet] [--nolock] [--unlock] [--cleanup-metadata [DATEI [DATEI ...]]]
[--rerun-incomplete] [--ignore-incomplete] [--list-version-changes]
[--list-code-changes] [--list-input-changes] [--list-params-changes]
[--latency-wait SEKUNDEN] [--wait-for-files [DATEI [DATEI ...]]] [--benchmark-repeats
N] [--notemp] [--keep-target-files] [--allowed-rules ALLOWED_RULES [ALLOWED_RULES
...]] [--timestamp] [--greediness GREEDINESS] [--print-compilation]
[--overwrite-shellcmd OVERWRITE_SHELLCMD] [--verbose] [--debug] [--profile FILE]
[--bash-completion] [--version] [Ziel [Ziel ...]]

positionell Argumente:
Ziel Ziele zum Aufbau. Dies können Regeln oder Dateien sein.

optional Argumente:
-h, --help
Diese Hilfemeldung anzeigen und beenden

--snakefile DATEI, -s FILE
Die Workflow-Definition in einer Schlangendatei.

--gui [HAFEN]
Stellt eine HTML-basierte Benutzeroberfläche für den angegebenen Port bereit (Standard: 8000). Wenn möglich,
ein Browserfenster wird geöffnet.

--Kerne [N], --Arbeitsplätze [N], -j [N]
Maximal N Kerne parallel verwenden (Standard: 1). Wenn N weggelassen wird, wird der Grenzwert auf gesetzt
die Anzahl der verfügbaren Kerne.

--Ressourcen [NAME=INT [NAME=INT ...]], --res [NAME=INT [NAME=INT ...]]
Definieren Sie zusätzliche Ressourcen, die die Planung analog einschränken sollen
Threads (siehe oben). Eine Ressource wird als Name und ganzzahliger Wert definiert. Z.B
--Ressourcen GPU=1. Regeln können Ressourcen verwenden, indem sie das Schlüsselwort „resource“ definieren, z
Ressourcen: GPU=1. Wenn jetzt zwei Regeln 1 der Ressource „GPU“ erfordern, ist dies nicht der Fall
werden vom Scheduler parallel ausgeführt.

--config [SCHLÜSSEL=WERT [SCHLÜSSEL=WERT ...]]
Legen Sie Werte im Workflow-Konfigurationsobjekt fest oder überschreiben Sie sie. Das Workflow-Konfigurationsobjekt
ist als variable Konfiguration innerhalb des Workflows zugänglich. Standardwerte können von festgelegt werden
Bereitstellung einer JSON-Datei (siehe Dokumentation).

--Konfigurationsdatei FILE
Geben Sie die Konfigurationsdatei des Workflows an oder überschreiben Sie sie (siehe Dokumentation). Werte
Die im JSON- oder YAML-Format angegebenen Dateien sind im globalen Konfigurationswörterbuch verfügbar
innerhalb des Workflows.

--aufführen, -l
Verfügbare Regeln in der angegebenen Snakefile anzeigen.

--list-target-rules, --lt
Verfügbare Zielregeln in der angegebenen Snakefile anzeigen.

--Verzeichnis DIR, -d DIR
Geben Sie das Arbeitsverzeichnis an (relative Pfade in der Schlangendatei verwenden dieses als ihr Verzeichnis
Ursprung).

--Probelauf, -n
Führen Sie nichts aus.

--printshellcmds, -p
Drucken Sie die Shell-Befehle aus, die ausgeführt werden.

--dag Führen Sie nichts aus und drucken Sie das gerichtete azyklische Diagramm der Jobs im Punkt aus
Sprache. Empfohlene Verwendung auf Unix-Systemen: Snakemake --dag | Punkt | Anzeige

--rulegraph
Führen Sie nichts aus und drucken Sie das Abhängigkeitsdiagramm der Regeln im Punkt aus
Sprache. Dies wird weniger überfüllt sein als die oben genannten DAG-Stellen, aber es werden auch weniger Stellen angezeigt
Information. Beachten Sie, dass jede Regel einmal angezeigt wird, daher auch das angezeigte Diagramm
zyklisch sein, wenn eine Regel in mehreren Schritten des Workflows vorkommt. Verwenden Sie dies, wenn oben
Die Option führt zu einer zu großen DAG. Empfohlene Verwendung auf Unix-Systemen:
Schlangenmacher --rulegraph | Punkt | Anzeige

--d3dag
Drucken Sie den DAG im D3.js-kompatiblen JSON-Format.

--Zusammenfassung, -S
Drucken Sie eine Zusammenfassung aller durch den Workflow erstellten Dateien. Das hat Folgendes
Spalten: Dateiname, Änderungszeit, Regelversion, Status, Plan. Dadurch herrschen
version enthält die Version, mit der die Datei erstellt wurde (siehe das Schlüsselwort version von
Regeln) und Status gibt an, ob die Datei fehlt, ihre Eingabedateien sind neuer
oder ob sich die Version oder Implementierung der Regel seit der Dateierstellung geändert hat. Endlich
Die letzte Spalte gibt an, ob die Datei beim nächsten Mal aktualisiert oder erstellt wird
Workflow-Ausführung.

--detaillierte-Zusammenfassung, -D
Drucken Sie eine Zusammenfassung aller durch den Workflow erstellten Dateien. Das hat Folgendes
Spalten: Dateiname, Änderungszeit, Regelversion, Eingabedatei(en), Shell-Befehl,
Status, Plan. Dabei enthält die Regelversion die Version, mit der die Datei erstellt wurde
(siehe das Versionsschlüsselwort von Rules), und Status gibt an, ob die Datei fehlt.
seine Eingabedateien neuer sind oder ob sich die Version oder Implementierung der Regel seitdem geändert hat
Dateierstellung. Die Eingabedatei- und Shell-Befehlsspalten sind selbsterklärend.
Schließlich gibt die letzte Spalte an, ob die Datei währenddessen aktualisiert oder erstellt wird
die nächste Workflow-Ausführung.

--berühren, -t
Touch-Ausgabedateien (markieren Sie sie als aktuell, ohne sie wirklich zu ändern) statt
ihre Befehle ausführen. Dies wird verwendet, um vorzutäuschen, dass die Regeln ausgeführt wurden
um zukünftige Aufrufe von Snakemake zu täuschen. Schlägt fehl, wenn eine Datei noch nicht vorhanden ist.

--mach weiter, -k
Fahren Sie mit unabhängigen Jobs fort, wenn ein Job fehlschlägt.

--Macht, -f
Erzwingen Sie die Ausführung des ausgewählten Ziels oder der ersten Regel, unabhängig davon, ob dies bereits der Fall ist
erstellte Ausgabe.

--forceall, -F
Erzwingen Sie die Ausführung der ausgewählten (oder ersten) Regel und aller zugehörigen Regeln
abhängig von der bereits erstellten Ausgabe.

--forcerun ZIEL [ZIEL ...], -R ZIEL [ZIEL ...]
Erzwingen Sie die erneute Ausführung oder Erstellung der angegebenen Regeln oder Dateien. Verwenden Sie diese Option, wenn
Sie haben eine Regel geändert und möchten, dass die gesamte Ausgabe in Ihrem Workflow aktualisiert wird.

--priorisieren ZIEL [ZIEL ...], -P ZIEL [ZIEL ...]
Weisen Sie den Planer an, die Erstellung bestimmter Ziele (und aller ihrer Abhängigkeiten) zuzuweisen.
höchste Priorität. (EXPERIMENTAL)

--allow-ambiguity, -a
Suchen Sie nicht nach mehrdeutigen Regeln und verwenden Sie einfach die erste, wenn mehrere Regeln vorhanden sind
gleiche Datei. Dies ermöglicht dem Benutzer, Regeln nach ihrer Reihenfolge im zu priorisieren
Schlangendatei.

- Cluster cmd, -c CMD
Führen Sie Snakemake-Regeln mit dem angegebenen Submit-Befehl aus, z. B. qsub. Schlangenmacherei
kompiliert Jobs in Skripte, die mit den angegebenen Daten an den Cluster übermittelt werden
Befehl, sobald alle Eingabedateien für einen bestimmten Job vorhanden sind. Der Submit-Befehl
kann dekoriert werden, um bestimmte Jobeigenschaften (Eingabe, Ausgabe, Parameter usw.) zu erkennen.
Platzhalter, Protokoll, Threads und Abhängigkeiten (siehe das Argument unten)), zB: $
Schlangenmacher - Cluster 'qsub -Sport eingefädelt {threads}'.

--cluster-sync CMD
Der Cluster-Übermittlungsbefehl blockiert und gibt den Remote-Exitstatus bei Remote zurück
Beendigung (dies sollte beispielsweise verwendet werden, wenn der Cluster-Befehl „qsub -sync
y' (SGE)

--drmaa [ARGS]
Führen Sie Snakemake auf einem Cluster aus, auf den über DRMAA zugegriffen wird. Snakemake kompiliert darin Jobs
Skripte, die mit dem angegebenen Befehl an den Cluster übermittelt werden, sobald alle Eingaben vorliegen
Dateien für einen bestimmten Job vorhanden sind. Mit ARGS können Optionen angegeben werden
zugrunde liegendes Clustersystem, wobei die Jobeigenschaften Input, Output, Params,
Platzhalter, Protokoll, Threads und Abhängigkeiten, z. B.: --drmaa ' -Sport eingefädelt {threads}'.
Beachten Sie, dass ARGS in Anführungszeichen und mit einem führenden Leerzeichen angegeben werden muss.

--cluster-config DATEI, -u FILE
Eine JSON- oder YAML-Datei, die die in „Cluster“ verwendeten Platzhalter für bestimmte Regeln definiert.
anstatt sie im Snakefile angeben zu lassen. Zum Beispiel für die Regel „Job“.
kann Folgendes definieren: { 'job' : { 'time' : '24:00:00' } }, um die Zeit für die Regel 'job' anzugeben.

--immediate-submit, --Ist
Übermitteln Sie alle Jobs sofort an den Cluster, anstatt auf aktuelle Eingaben zu warten
Dateien. Dies wird fehlschlagen, es sei denn, Sie machen den Cluster auf Jobabhängigkeiten aufmerksam, z
über: $snakemake - Cluster 'sbatch --Abhängigkeit {Abhängigkeiten}. Vorausgesetzt, dass Ihr
Das Submit-Skript (hier Sbatch) gibt die generierte Job-ID in der ersten Standardausgabezeile aus.
{dependencies} wird mit durch Leerzeichen getrennten Job-IDs gefüllt, von denen dieser Job abhängt.

--jobscript SKRIPT, --js SCRIPT
Stellen Sie ein benutzerdefiniertes Jobskript zur Übermittlung an den Cluster bereit. Das Standardskript
befindet sich als „jobscript.sh“ im Installationsverzeichnis.

--Berufsbezeichnung NAME, --jn NAME/FUNKTION
Geben Sie einen benutzerdefinierten Namen für das Jobskript an, das an den Cluster übermittelt wird (siehe
- Cluster). NAME ist standardmäßig „snakejob.{rulename}.{jobid}.sh“. Der Platzhalter
{jobid} muss im Namen vorhanden sein.

--Grund, -r
Drucken Sie den Grund für jede ausgeführte Regel aus.

--Statistiken FILE
Schreiben Sie Statistiken zur Snakefile-Ausführung im JSON-Format in die angegebene Datei.

--keine Farbe
Verwenden Sie keine farbige Ausgabe.

--ruhig, -q
Geben Sie keine Fortschritts- oder Regelinformationen aus.

--kein Schloss
Sperren Sie das Arbeitsverzeichnis nicht

--Freischalten
Entfernen Sie eine Sperre für das Arbeitsverzeichnis.

--cleanup-metadata [DATEI [DATEI ...]], --cm [DATEI [DATEI ...]]
Bereinigen Sie die Metadaten bestimmter Dateien. Das bedeutet, dass Snakemake alle verfolgten Dateien entfernt
Versionsinformationen und alle Hinweise darauf, dass Dateien unvollständig sind.

--rerun-incomplete, --ri
Führen Sie alle Jobs erneut aus, deren Ausgabe als unvollständig erkannt wird.

--ignore-incomplete, --ii
Ignorieren Sie alle unvollständigen Aufträge.

--list-version-changes, --lv
Listen Sie alle Ausgabedateien auf, die mit einer anderen Version (als
wird durch das Versionsschlüsselwort bestimmt).

--list-code-changes, --lc
Listen Sie alle Ausgabedateien auf, für die sich der Regelkörper (Ausführung oder Shell) geändert hat
Schlangendatei.

--list-input-changes, --li
Listen Sie alle Ausgabedateien auf, für die sich die definierten Eingabedateien im geändert haben
Snakefile (z. B. neue Eingabedateien wurden in der Regeldefinition hinzugefügt oder Dateien wurden hinzugefügt).
umbenannt). Um Eingabedateiänderungen im Dateisystem aufzulisten, verwenden Sie --Zusammenfassung.

--list-params-changes, --lp
Listen Sie alle Ausgabedateien auf, für die sich die definierten Parameter in der Snakefile geändert haben.

--latency-wait SEKUNDEN, --output-wait SEKUNDEN, -w SECONDS
Warten Sie einige Sekunden, wenn nach dem Job keine Ausgabedatei eines Jobs vorhanden ist
fertig. Dies hilft, wenn Ihr Dateisystem unter Latenz leidet (Standard 5).

--wait-for-files [DATEI [DATEI ...]]
Wartezeit --latency-wait Es dauert einige Sekunden, bis diese Dateien vorhanden sind, bevor die ausgeführt wird
Arbeitsablauf. Diese Option wird intern verwendet, um die Dateisystemlatenz im Cluster zu bewältigen
Umgebungen.

--benchmark-repeats N
Wiederholen Sie einen Job N-mal, wenn er für das Benchmarking markiert ist (Standard 1).

--notemp, --nt
Ignorieren Sie temp()-Deklarationen. Dies ist nützlich, wenn nur ein Teil davon ausgeführt wird
Workflow, da temp() zum Löschen wahrscheinlich benötigter Dateien durch andere führen würde
Teile des Arbeitsablaufs.

--keep-target-files
Passen Sie die Pfade bestimmter Zieldateien nicht relativ zum Arbeitsverzeichnis an.

--allowed-rules ALLOWED_RULES [ALLOWED_RULES ...]
Verwenden Sie nur vorgegebene Regeln. Wenn es weggelassen wird, werden alle Regeln in Snakefile verwendet.

--Zeitstempel, -T
Fügen Sie allen Protokollierungsausgaben einen Zeitstempel hinzu

--Gier GIER
Legen Sie die Gier der Terminplanung fest. Dieser Wert zwischen 0 und 1 bestimmt, wie vorsichtig
Jobs werden zur Ausführung ausgewählt. Der Standardwert (1.0) bietet die beste Geschwindigkeit
und dennoch akzeptabler Terminqualität.

--print-compilation
Drucken Sie die Python-Darstellung des Workflows.

--overwrite-shellcmd OVERWRITE_SHELLCMD
Geben Sie einen Shell-Befehl an, der anstelle der im angegebenen Befehl ausgeführt werden soll
Arbeitsablauf. Dies dient nur zu Debugzwecken.

- ausführlich
Debugging-Ausgabe drucken.

--debuggen
Ermöglicht das Debuggen von Regeln beispielsweise mit PDB. Dieses Flag ermöglicht das Setzen von Haltepunkten im Lauf
Blöcke

--Profil FILE
Profilieren Sie Snakemake und schreiben Sie die Ausgabe in die Datei. Dies erfordert, dass Yappi vorhanden ist
installiert.

--bash-completion
Ausgabecode zum Registrieren der Bash-Vervollständigung für Snakemake. Geben Sie Folgendes ein
.bashrc (einschließlich der Akzente): `snakemake --bash-completion` oder erteilen Sie es in einem
Öffnen Sie die Terminalsitzung.

--Version, -v
Versionsnummer des Programms anzeigen und beenden

Nutzen Sie Snakemake online über die Dienste von onworks.net