validasi nf

Plugin Nextflow untuk bekerja dengan validasi parameter pipa dan lembar sampel.

Penting

nf-validation kini telah diubah namanya menjadi nf-schema .

Plugin nf-validation tidak akan menerima pembaruan apa pun di masa mendatang. Harap perbarui saluran pipa Anda untuk menggunakan nf-schema .

Lihat https://github.com/nextflow-io/nf-schema untuk detailnya.

Perubahan ini diperlukan untuk mencegah versi lama dari pipa nf-core dengan referensi plugin yang tidak dipasangi pin agar tidak rusak saat memperbarui ke versi terbaru nf-validation . Harap sematkan versi nf-schema di file nextflow.config saluran Anda:

plugins { id ' [email protected] ' }

Perkenalan

Plugin Nextflow ini menyediakan sejumlah fungsi yang dapat dimasukkan ke dalam skrip alur Nextflow untuk bekerja dengan parameter dan skema lembar sampel. Dengan menggunakan fungsi-fungsi ini Anda dapat:

• ? Cetak instruksi penggunaan ke terminal (untuk digunakan dengan --help )
• ✍️ Cetak keluaran log yang menunjukkan parameter dengan nilai non-default
• ✅ Validasi parameter yang disediakan terhadap skema pipa
• ? Validasi konten file lembar sampel yang disediakan
• ?️ Buat saluran Nextflow dengan lembar sampel yang diurai

Contoh format lembar yang didukung adalah CSV, TSV, dan YAML (sederhana).

Mulai Cepat

Deklarasikan plugin di file konfigurasi pipeline Nextflow Anda:

plugins {
  id ' nf-validation '
}

Hanya ini yang diperlukan - Nextflow akan secara otomatis mengambil kode plugin saat run time.

Catatan

Cuplikan di atas akan selalu mencoba menginstal versi terbaru, ada baiknya untuk memastikan bahwa perbaikan bug terbaru disertakan! Namun hal ini dapat menimbulkan kesulitan jika dijalankan secara offline. Anda dapat menyematkan rilis tertentu menggunakan sintaks [email protected]

Anda sekarang dapat menyertakan fungsi pembantu plugin ke dalam saluran Nextflow Anda:

include { validateParameters; paramsHelp; paramsSummaryLog; fromSamplesheet } from ' plugin/nf-validation '

// Print help message, supply typical command line usage for the pipeline
if (params . help) {
   log . info paramsHelp( " nextflow run my_pipeline --input input_file.csv " )
   exit 0
}

// Validate input parameters
validateParameters()

// Print summary of supplied parameters
log . info paramsSummaryLog(workflow)

// Create a new channel of metadata from a sample sheet
// NB: `input` corresponds to `params.input` and associated sample sheet schema
ch_input = Channel . fromSamplesheet( " input " )

Ketergantungan

• Java 11 atau lebih baru
• https://github.com/everit-org/json-schema

Saluran kendur

Ada saluran Slack validasi nf khusus di ruang kerja Nextflow Slack.

Kredit

Plugin ini ditulis berdasarkan kode yang awalnya ditulis dalam komunitas nf-core, sebagai bagian dari templat pipeline nf-core.

Kami ingin mengucapkan terima kasih kepada kontributor utama yang meliputi (namun tidak terbatas pada):

• Júlia Mir Pedrol (@mirpedrol)
• Nicolas Vannieuwkerke (@nvnieuwk)
• Kevin Menden (@KevinMenden)
• Phil Ewels (@ewels)