nf 検証のダウンロード - nf 検証のソースコードのダウンロード

NF検証

その他のソースコード

Version 1.1.4 - Kushiro

ダウンロード

パイプラインパラメーターとサンプルシートの検証を操作する Nextflow プラグイン。

重要

`nf-validation`名前は`nf-schema`に変更されました。

nf-validationプラグインは今後の更新を受信しません。代わりにnf-schema使用するようにパイプラインを更新してください。

詳細については、https://github.com/nextflow-io/nf-schema を参照してください。

この変更は、最新バージョンのnf-validationに更新するときに、固定されていないプラグイン参照を持つ古いバージョンのnf-coreパイプラインが壊れるのを防ぐために必要でした。パイプラインのnextflow.configファイルにnf-schemaのバージョンを固定してください。

plugins { id ' [email protected] ' }

導入

この Nextflow プラグインは、パラメーターとサンプルシートスキーマを操作するために Nextflow パイプラインスクリプトに組み込むことができる多数の関数を提供します。これらの関数を使用すると、次のことが可能になります。

?使用方法を端末に出力します ( --helpで使用)
✍️ デフォルト以外の値を持つパラメーターを示すログ出力を印刷します。
✅ 提供されたパラメータをパイプラインスキーマに対して検証します
?提供されたサンプルシートファイルの内容を検証する
?️ 解析されたサンプルシートを使用して Nextflow チャネルを作成する

サポートされているサンプルシートの形式は、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 " )