snakemake - Dalam talian di Awan

JADUAL:

NAMA

snakemake - bahasa berasaskan Python dan persekitaran pelaksanaan untuk aliran kerja GNU Makelike

DESCRIPTION

penggunaan: snakemake [-h] [--snakefile FAIL] [--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]
[--sentuh] [--terus-teruskan] [--paksa] [--paksa semua] [--paksa lari SASARAN [SASARAN ...]]
[--utamakan SASARAN [SASARAN ...]] [--benarkan-kekaburan] [--cluster CMD |
--segerak-kelompok CMD | --drmaa [ARGS]] [--cluster-config FILE] [--serah segera]
[--SKRIP skrip kerja] [--nama kerja NAMA] [--sebab] [--fail statistik] [--nocolor]
[--senyap] [--nolock] [--unlock] [--cleanup-metadata [FAIL [FAIL ...]]]
[--rerun-incomplete] [--ignore-incomplete] [--list-version-changes]
[--list-code-changes] [--list-input-changes] [--list-params-changes]
[--latency-tunggu SECONDS] [--tunggu-untuk-fail [FAIL [FAIL ...]]] [--penanda aras-berulang
N] [--notemp] [--keep-target-files] [--allowed-rules ALLOWED_RULES [ALLOWED_RULES
...]] [--cap masa] [--keserakahan TAMAK] [--cetak-kompilasi]
[--overwrite-shellcmd OVERWRITE_SHELLCMD] [--verbose] [--debug] [--profile FAIL]
[--bash-completion] [--version] [sasaran [sasaran ...]]

kedudukannya hujah:
sasaran Sasaran untuk dibina. Mungkin peraturan atau fail.

pilihan hujah:
-h, - membantu
tunjukkan mesej bantuan ini dan keluar

--filem ular FAIL, -s FAIL
Definisi aliran kerja dalam snakefile.

--gui [PORT]
Layankan antara muka pengguna berasaskan HTML ke port yang diberikan (lalai: 8000). Jika boleh,
tetingkap penyemak imbas dibuka.

--teras [N], --pekerjaan [N], -j [N]
Gunakan paling banyak teras N secara selari (lalai: 1). Jika N diabaikan, had ditetapkan kepada
bilangan teras yang tersedia.

--sumber [NAME=INT [NAME=INT ...]], --res [NAME=INT [NAME=INT ...]]
Tentukan sumber tambahan yang akan mengekang penjadualan secara analog
benang (lihat di atas). Sumber ditakrifkan sebagai nama dan nilai integer. Cth
--sumber gpu=1. Peraturan boleh menggunakan sumber dengan mentakrifkan kata kunci sumber, mis
sumber: gpu=1. Jika sekarang dua peraturan memerlukan 1 daripada 'gpu' sumber, ia tidak akan menjadi
dijalankan secara selari oleh penjadual.

--config [KEY=VALUE [KEY=VALUE ...]]
Tetapkan atau tulis ganti nilai dalam objek konfigurasi aliran kerja. Objek konfigurasi aliran kerja
boleh diakses sebagai konfigurasi pembolehubah di dalam aliran kerja. Nilai lalai boleh ditetapkan oleh
menyediakan fail JSON (lihat Dokumentasi).

--configfile FAIL
Tentukan atau tulis ganti fail konfigurasi aliran kerja (lihat dokumen). Nilai
dinyatakan dalam format JSON atau YAML tersedia dalam kamus konfigurasi global
dalam aliran kerja.

--senarai, -l
Tunjukkan peraturan yang tersedia dalam Snakefile yang diberikan.

--list-target-rules, --lt
Tunjukkan peraturan sasaran yang tersedia dalam Snakefile yang diberikan.

--direktori DIR, -d DIR
Tentukan direktori kerja (laluan relatif dalam snakefile akan menggunakan ini sebagai
asal usul).

--dryrun, -n
Jangan laksanakan apa-apa.

--printshellcmds, -p
Cetak arahan shell yang akan dilaksanakan.

--dag Jangan laksanakan apa-apa dan cetak graf akiklik kerja yang diarahkan dalam titik
bahasa. Penggunaan yang disyorkan pada sistem Unix: snakemake --dag | titik | paparan

--graf peraturan
Jangan laksanakan apa-apa dan cetak graf pergantungan peraturan dalam titik
bahasa. Ini akan menjadi kurang sesak daripada pekerjaan di atas DAG, tetapi juga menunjukkan kurang
maklumat. Ambil perhatian bahawa setiap peraturan dipaparkan sekali, oleh itu graf yang dipaparkan akan
menjadi kitaran jika peraturan muncul dalam beberapa langkah aliran kerja. Gunakan ini jika di atas
pilihan membawa kepada DAG yang terlalu besar. Penggunaan yang disyorkan pada sistem Unix:
buat ular --graf peraturan | titik | paparan

--d3dag
Cetak DAG dalam format JSON yang serasi dengan D3.js.

--ringkasan, -S
Cetak ringkasan semua fail yang dibuat oleh aliran kerja. The mempunyai yang berikut
lajur: nama fail, masa pengubahsuaian, versi peraturan, status, pelan. Dengan itu memerintah
versi mengandungi versi fail yang dibuat dengan (lihat kata kunci versi
peraturan), dan status menandakan sama ada fail itu tiada, fail inputnya lebih baharu
atau jika versi atau pelaksanaan peraturan berubah sejak penciptaan fail. Akhirnya
lajur terakhir menandakan sama ada fail itu akan dikemas kini atau dibuat semasa berikutnya
pelaksanaan aliran kerja.

--ringkasan-terperinci, -D
Cetak ringkasan semua fail yang dibuat oleh aliran kerja. The mempunyai yang berikut
lajur: nama fail, masa pengubahsuaian, versi peraturan, fail input, arahan shell,
status, rancangan. Oleh itu versi peraturan mengandungi versi fail yang dibuat dengan
(lihat kata kunci versi peraturan), dan status menandakan sama ada fail itu tiada,
fail inputnya lebih baharu atau jika versi atau pelaksanaan peraturan berubah sejak itu
penciptaan fail. Fail input dan lajur arahan shell adalah penjelasan sendiri.
Akhirnya lajur terakhir menandakan sama ada fail akan dikemas kini atau dibuat semasa
pelaksanaan aliran kerja seterusnya.

--sentuh, -t
Sentuh fail output (tandai ia terkini tanpa benar-benar mengubahnya) dan bukannya
menjalankan perintah mereka. Ini digunakan untuk berpura-pura bahawa peraturan telah dilaksanakan, dalam
untuk memperdayakan seruan snakemake di masa hadapan. Gagal jika fail belum wujud.

--teruskan, -k
Teruskan kerja bebas jika pekerjaan gagal.

- kekuatan, -f
Paksa pelaksanaan sasaran yang dipilih atau peraturan pertama tanpa mengira sudah
output yang dicipta.

--paksa, -F
Paksa pelaksanaan peraturan yang dipilih (atau yang pertama) dan semua peraturan itu
bergantung kepada tanpa mengira output yang telah dibuat.

--forcerun SASARAN [SASARAN ...], -R SASARAN [SASARAN ...]
Paksa pelaksanaan semula atau penciptaan peraturan atau fail yang diberikan. Gunakan pilihan ini jika
anda menukar peraturan dan ingin mengemas kini semua outputnya dalam aliran kerja anda.

--utamakan SASARAN [SASARAN ...], -P SASARAN [SASARAN ...]
Beritahu penjadual untuk menetapkan penciptaan sasaran yang diberikan (dan semua kebergantungan mereka)
keutamaan tertinggi. (PERCUBAAN)

--benarkan-kekaburan, -a
Jangan semak peraturan yang samar-samar dan hanya gunakan yang pertama jika beberapa boleh menghasilkan
fail yang sama. Ini membolehkan pengguna untuk mengutamakan peraturan mengikut susunan mereka dalam
kikir ular.

--kelompok cmd, -c CMD
Laksanakan peraturan snakemake dengan arahan hantar yang diberikan, cth qsub. Buat ular
menyusun kerja ke dalam skrip yang diserahkan kepada kluster dengan yang diberikan
arahan, setelah semua fail input untuk kerja tertentu hadir. Perintah hantar
boleh dihias untuk menyedari sifat pekerjaan tertentu (input, output, params,
kad bebas, log, benang dan kebergantungan (lihat hujah di bawah)), cth: $
buat ular --kelompok 'qsub -pe berulir {benang}'.

--segerak-kelompok CMD
arahan penyerahan kluster akan menyekat, mengembalikan status keluar jauh apabila jauh
penamatan (contohnya, ini harus digunakan jika arahan kluster ialah 'qsub -segerak
y' (SGE)

--drmaa [ARGS]
Laksanakan snakemake pada kluster yang diakses melalui DRMAA, Snakemake menyusun kerja ke dalamnya
skrip yang diserahkan kepada kluster dengan arahan yang diberikan, setelah semua input
fail untuk kerja tertentu ada. ARGS boleh digunakan untuk menentukan pilihan bagi
sistem kluster yang mendasari, dengan itu menggunakan input sifat kerja, output, params,
kad bebas, log, benang dan kebergantungan, cth: --drmaa ' -pe berulir {benang}'.
Ambil perhatian bahawa ARGS mesti diberikan dalam petikan dan dengan ruang putih terkemuka.

--cluster-config FAIL, -u FAIL
Fail JSON atau YAML yang mentakrifkan kad bebas yang digunakan dalam 'kelompok'untuk peraturan tertentu,
bukannya menetapkannya dalam Snakefile. Contohnya, untuk peraturan 'pekerjaan' anda
boleh mentakrifkan: { 'job' : { 'time' : '24:00:00' } } untuk menentukan masa untuk peraturan 'job'.

--serah-segera, --ialah
Segera serahkan semua kerja kepada kluster dan bukannya menunggu input semasa
fail. Ini akan gagal, melainkan anda menyedarkan kluster tentang kebergantungan pekerjaan, cth
melalui: $ snakemake --kelompok 'sbatch --pergantungan {kebergantungan}. Dengan mengandaikan bahawa anda
serahkan skrip (di sini sbatch) mengeluarkan id kerja yang dihasilkan ke baris stdout pertama,
{dependencies} akan diisi dengan id kerja yang diasingkan ruang bergantung pada tugas ini.

--surat kerja SKRIP, --js SCRIPT
Sediakan skrip kerja tersuai untuk diserahkan kepada kluster. Skrip lalai
berada sebagai 'jobscript.sh' dalam direktori pemasangan.

--nama kerja NAMA, --jn NAMA
Sediakan nama tersuai untuk skrip kerja yang diserahkan kepada kluster (lihat
--kelompok). NAME ialah "snakejob.{rulename}.{jobid}.sh" setiap lalai. Kad bebas
{jobid} perlu hadir dalam nama.

--sebab, -r
Cetak sebab bagi setiap peraturan yang dilaksanakan.

--statistik FAIL
Tulis statistik tentang pelaksanaan Snakefile dalam format JSON ke fail yang diberikan.

--tiada warna
Jangan gunakan output berwarna.

--senyap, -q
Jangan keluarkan sebarang kemajuan atau maklumat peraturan.

--nolock
Jangan kunci direktori kerja

--buka kunci
Keluarkan kunci pada direktori kerja.

--metadata pembersihan [FAIL [FAIL ...]], --cm [FAIL [FAIL ...]]
Bersihkan metadata fail yang diberikan. Ini bermakna snakemake mengalih keluar sebarang jejak
maklumat versi, dan sebarang tanda bahawa fail tidak lengkap.

--semula-tidak lengkap, --ri
Jalankan semula semua kerja yang outputnya diiktiraf sebagai tidak lengkap.

--abaikan-tidak lengkap, --ii
Abaikan sebarang kerja yang tidak lengkap.

--list-version-changes, --lv
Senaraikan semua fail output yang telah dibuat dengan versi berbeza (sebagai
ditentukan oleh kata kunci versi).

--list-code-changes, --lc
Senaraikan semua fail output yang badan peraturan (run atau shell) telah berubah dalam
file ular.

--list-input-changes, --li
Senaraikan semua fail output yang mana fail input yang ditentukan telah berubah dalam
Snakefile (cth fail input baharu telah ditambahkan dalam definisi peraturan atau fail adalah
dinamakan semula). Untuk menyenaraikan pengubahsuaian fail input dalam sistem fail, gunakan --ringkasan.

--list-params-changes, --lp
Senaraikan semua fail output yang mana params yang ditentukan telah berubah dalam Snakefile.

--kependaman-tunggu DETIK, --output-tunggu DETIK, -w SEKIAN
Tunggu beberapa saat jika fail output kerja tidak hadir selepas kerja
selesai. Ini membantu jika sistem fail anda mengalami kependaman (lalai 5).

--tunggu-untuk-fail [FAIL [FAIL ...]]
Tunggu --kependaman-tunggu saat untuk fail ini hadir sebelum melaksanakan
aliran kerja. Pilihan ini digunakan secara dalaman untuk mengendalikan kependaman sistem fail dalam kelompok
persekitaran.

--penanda aras-berulang N
Ulangi kerja N kali jika ditandakan untuk penanda aras (lalai 1).

--notemp, --nt
Abaikan pengisytiharan temp(). Ini berguna apabila menjalankan hanya sebahagian daripada
aliran kerja, kerana temp() akan membawa kepada pemadaman fail yang mungkin diperlukan oleh orang lain
bahagian aliran kerja.

--simpan-sasaran-fail
Jangan laraskan laluan fail sasaran yang diberikan berbanding dengan direktori kerja.

--peraturan-dibenarkan DIBENARKAN_PERATURAN [DIBENARKAN_PERATURAN ...]
Hanya gunakan peraturan yang diberikan. Jika ditinggalkan, semua peraturan dalam Snakefile digunakan.

--cap masa, -T
Tambahkan cap masa pada semua output pengelogan

--ketamakan TAMAK
Tetapkan kerakusan penjadualan. Nilai antara 0 dan 1 ini menentukan sejauh mana berhati-hati
pekerjaan dipilih untuk dilaksanakan. Nilai lalai (1.0) memberikan kelajuan terbaik
dan kualiti penjadualan masih boleh diterima.

--cetak-penyusunan
Cetak perwakilan python aliran kerja.

--tulis ganti-shellcmd OVERWRITE_SHELCMD
Sediakan arahan shell yang akan dilaksanakan dan bukannya yang diberikan dalam
aliran kerja. Ini adalah untuk tujuan penyahpepijatan sahaja.

--verbose
Cetak output penyahpepijatan.

--nyahpepijat
Benarkan seseorang menyahpepijat peraturan dengan cth PDB. Bendera ini membenarkan untuk menetapkan titik putus dalam larian
Blok.

--profil FAIL
Profil Snakemake dan tulis output ke FILE. Ini memerlukan yappi
dipasang.

--bash-completion
Kod keluaran untuk mendaftar penyiapan bash untuk snakemake. Letakkan yang berikut dalam anda
.bashrc (termasuk aksen): `snakemake --bash-completion` atau mengeluarkannya dalam
sesi terminal terbuka.

--versi, -v
tunjukkan nombor versi program dan keluar

Gunakan snakemake dalam talian menggunakan perkhidmatan onworks.net