Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.76 KB

README.md

File metadata and controls

78 lines (53 loc) · 2.76 KB
Raw

nf-schema

📚 Docs 👉🏻 https://nextflow-io.github.io/nf-schema

A Nextflow plugin to work with validation of pipeline parameters and sample sheets.

Introduction

This Nextflow plugin provides a number of functions that can be included into a Nextflow pipeline script to work with parameter and sample sheet schema. Using these functions you can:

  • 📖 Print usage instructions to the terminal (for use with --help)
  • ✍️ Print log output showing parameters with non-default values
  • ✅ Validate supplied parameters against the pipeline schema
  • 📋 Validate the contents of supplied sample sheet files
  • 🛠️ Create a Nextflow channel with a parsed sample sheet

Supported sample sheet formats are CSV, TSV, JSON and YAML.

Quick Start

Declare the plugin in your Nextflow pipeline configuration file:

plugins {
  id 'nf-schema'
}

This is all that is needed - Nextflow will automatically fetch the plugin code at run time.

Note

The snippet above will always try to install the latest version, good to make sure that the latest bug fixes are included! However, this can cause difficulties if running offline. You can pin a specific release using the syntax nf-schema@2.0.0

You can now include the plugin helper functions into your Nextflow pipeline:

include { validateParameters; paramsHelp; paramsSummaryLog; fromSamplesheet } from 'plugin/nf-schema'

// 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")

Dependencies

Slack channel

There is a dedicated nf-validation Slack channel in the Nextflow Slack workspace.

Credits

This plugin was written based on code initially written within the nf-core community, as part of the nf-core pipeline template.

We would like to thank the key contributors who include (but are not limited to):