nf validation Télécharger - nf validation Téléchargement du code source

nf validation

Autre code source

Version 1.1.4 - Kushiro

Télécharger

Un plugin Nextflow pour travailler avec la validation des paramètres du pipeline et des exemples de feuilles.

Important

`nf-validation` a maintenant été renommé `nf-schema` .

Le plugin nf-validation ne recevra aucune mise à jour future. Veuillez mettre à jour vos pipelines pour utiliser nf-schema à la place.

Voir https://github.com/nextflow-io/nf-schema pour plus de détails.

Ce changement était nécessaire pour empêcher les anciennes versions des pipelines nf-core avec des références de plugin non épinglées de se briser lors de la mise à jour vers la dernière version de nf-validation . Veuillez épingler la version de nf-schema dans le fichier nextflow.config de votre pipeline :

plugins { id ' [email protected] ' }

Introduction

Ce plugin Nextflow fournit un certain nombre de fonctions qui peuvent être incluses dans un script de pipeline Nextflow pour travailler avec un schéma de paramètres et de feuille d'exemple. En utilisant ces fonctions, vous pouvez :

? Imprimer les instructions d'utilisation sur le terminal (à utiliser avec --help )
✍️ Imprimer la sortie du journal montrant les paramètres avec des valeurs autres que celles par défaut
✅ Valider les paramètres fournis par rapport au schéma du pipeline
? Valider le contenu des fichiers de feuilles d'échantillons fournis
?️ Créez un canal Nextflow avec un exemple de feuille analysée

Les formats de feuilles d'échantillons pris en charge sont CSV, TSV et YAML (simple).

Démarrage rapide

Déclarez le plugin dans votre fichier de configuration de pipeline Nextflow :

plugins {
  id ' nf-validation '
}

C'est tout ce dont vous avez besoin - Nextflow récupérera automatiquement le code du plugin au moment de l'exécution.

Note

L'extrait ci-dessus essaiera toujours d'installer la dernière version, ce qui est bon pour s'assurer que les dernières corrections de bugs sont incluses ! Cependant, cela peut entraîner des difficultés en cas d'exécution hors ligne. Vous pouvez épingler une version spécifique en utilisant la syntaxe [email protected]

Vous pouvez désormais inclure les fonctions d'assistance du plugin dans votre 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 " )