核函数验证
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 管道模板的一部分。
我们要感谢主要贡献者,包括(但不限于):