validação nf

Um plugin Nextflow para trabalhar com validação de parâmetros de pipeline e planilhas de amostras.

Importante

nf-validation agora foi renomeado para nf-schema .

O plugin nf-validation não receberá nenhuma atualização futura. Atualize seus pipelines para usar nf-schema .

Consulte https://github.com/nextflow-io/nf-schema para obter detalhes.

Essa alteração foi necessária para evitar que versões mais antigas de pipelines nf-core com referências de plug-ins não fixadas quebrassem ao atualizar para a versão mais recente de nf-validation . Fixe a versão do nf-schema no arquivo nextflow.config do seu pipeline:

plugins { id ' [email protected] ' }

Introdução

Este plug-in Nextflow fornece uma série de funções que podem ser incluídas em um script de pipeline Nextflow para trabalhar com parâmetros e esquema de planilha de amostra. Usando essas funções você pode:

• ? Imprima instruções de uso no terminal (para usar com --help )
• ✍️ Imprimir saída de log mostrando parâmetros com valores não padrão
• ✅ Valide os parâmetros fornecidos em relação ao esquema do pipeline
• ? Valide o conteúdo dos arquivos de planilhas de amostras fornecidos
• ?️ Crie um canal Nextflow com uma planilha de amostra analisada

Os formatos de planilha de amostra suportados são CSV, TSV e YAML (simples).

Início rápido

Declare o plugin em seu arquivo de configuração do pipeline Nextflow:

plugins {
  id ' nf-validation '
}

Isso é tudo que é necessário - o Nextflow buscará automaticamente o código do plugin em tempo de execução.

Observação

O trecho acima sempre tentará instalar a versão mais recente, é bom ter certeza de que as correções de bugs mais recentes estão incluídas! No entanto, isso pode causar dificuldades se for executado offline. Você pode fixar uma versão específica usando a sintaxe [email protected]

Agora você pode incluir as funções auxiliares do plug-in em seu pipeline 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 " )

Dependências

• Java 11 ou posterior
• https://github.com/everit-org/json-schema

Canal Slack

Há um canal Slack de validação nf dedicado no espaço de trabalho Nextflow Slack.

Créditos

Este plugin foi escrito com base no código inicialmente escrito na comunidade nf-core, como parte do modelo de pipeline nf-core.

Gostaríamos de agradecer aos principais colaboradores que incluem (mas não estão limitados a):

• Júlia Mir Pedrol (@mirpedrol)
• Nicolas Vannieuwkerke (@nvnieuwk)
• Kevin Menden (@KevinMenden)
• Phil Ewels (@ewels)