Un complemento de Nextflow para trabajar con la validación de parámetros de canalización y hojas de muestra.
Importante
nf-validation
a nf-schema
. El complemento nf-validation
no recibirá actualizaciones futuras. Actualice sus canalizaciones para utilizar nf-schema
en su lugar.
Consulte https://github.com/nextflow-io/nf-schema para obtener más detalles.
Este cambio fue necesario para evitar que las versiones anteriores de las canalizaciones de nf-core
con referencias de complementos no fijadas se rompieran al actualizar a la última versión de nf-validation
. Fije la versión de nf-schema
en el archivo nextflow.config
de su canalización:
plugins { id ' [email protected] ' }
Este complemento de Nextflow proporciona una serie de funciones que se pueden incluir en un script de canalización de Nextflow para trabajar con parámetros y esquemas de hojas de muestra. Usando estas funciones puedes:
--help
)Los formatos de hojas de muestra admitidos son CSV, TSV y YAML (simple).
Declare el complemento en su archivo de configuración de canalización de Nextflow:
plugins {
id ' nf-validation '
}
Esto es todo lo que se necesita: Nextflow buscará automáticamente el código del complemento en tiempo de ejecución.
Nota
El fragmento anterior siempre intentará instalar la última versión, ¡es bueno asegurarse de que se incluyan las últimas correcciones de errores! Sin embargo, esto puede causar dificultades si se ejecuta sin conexión. Puede fijar una versión específica usando la sintaxis [email protected]
Ahora puede incluir las funciones auxiliares del complemento en su canalización de 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 " )
Hay un canal Slack de validación nf dedicado en el espacio de trabajo de Nextflow Slack.
Este complemento se escribió en base al código escrito inicialmente dentro de la comunidad nf-core, como parte de la plantilla de canalización de nf-core.
Nos gustaría agradecer a los contribuyentes clave que incluyen (pero no se limitan a):