파이프라인 매개변수 및 샘플 시트의 검증 작업을 위한 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
와 함께 사용).지원되는 샘플 시트 형식은 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 검증 Slack 채널이 있습니다.
이 플러그인은 nf-core 파이프라인 템플릿의 일부로 nf-core 커뮤니티 내에서 처음 작성된 코드를 기반으로 작성되었습니다.
다음을 포함하되 이에 국한되지 않는 주요 기여자들에게 감사의 말씀을 전하고 싶습니다.