Плагин 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 есть выделенный канал Slack для проверки nf.
Этот плагин был написан на основе кода, изначально написанного сообществом nf-core, как часть шаблона конвейера nf-core.
Мы хотели бы поблагодарить ключевых участников, в число которых входят (но не ограничиваются):