nf validation
Version 1.1.4 - Kushiro
Nextflow 插件,用於驗證管道參數和範例表。
重要的
nf-validation
現已重新命名為nf-schema
。 nf-validation
外掛程式將不會收到任何未來的更新。請更新您的管道以使用nf-schema
。
有關詳細信息,請參閱 https://github.com/nextflow-io/nf-schema。
此更改是必要的,以防止舊版本的nf-core
管道在更新到最新版本的nf-validation
時因未固定的插件引用而中斷。請將nf-schema
的版本固定在管道的nextflow.config
檔中:
plugins { id ' [email protected] ' }
此 Nextflow 外掛程式提供了許多可以包含在 Nextflow 管道腳本中的函數,以使用參數和範例表架構。使用這些功能您可以:
--help
一起使用)支援的範例表格式為 CSV、TSV 和 YAML(簡單)。
在 Nextflow 管道設定檔中聲明該插件:
plugins {
id ' nf-validation '
}
這就是所需要的全部 - Nextflow 將在運行時自動獲取插件程式碼。
筆記
上面的程式碼片段將始終嘗試安裝最新版本,這有助於確保包含最新的錯誤修復!但是,如果脫機運行,這可能會導致困難。您可以使用語法[email protected]
固定特定版本
現在您可以將外掛輔助函數包含到您的 Nextflow 管道中:
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 " )
Nextflow Slack 工作區中有一個專用的 nf-validation Slack 通道。
該插件是根據最初在 nf-core 社群內編寫的程式碼編寫的,作為 nf-core 管道模板的一部分。
我們要感謝主要貢獻者,包括(但不限於):