{"repo":"nextflow-io/nf-schema","free":true,"listed":false,"github":"https://github.com/nextflow-io/nf-schema","clone":"git clone https://github.com/nextflow-io/nf-schema.git","description":"Functionality for working with pipeline and sample sheet schema files in Nextflow pipelines","language":"Groovy","stars":57,"topics":["bioinformatics","json-schema","nextflow","parameter-validation","params","pipeline","schema","validation","workflow","nextflow-schema"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"📚 Docs 👉🏻 A Nextflow plugin to work with validation of pipeline parameters and sample sheets. Introduction [!IMPORTANT] nf-schema is the new version of the now deprecated nf-validation. Please follow the migration guide to migrate your code to this new version. This Nextflow plugin provides functionality that can be used in a Nextflow pipeline to work with parameter and sample sheet schema. The added functionality is: - 📖 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 type-casted list from 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: 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 specified version. We encourage always pinning the plugin version to make sure the used pipeline will keep working when a new version of nf-schema with breaking changes has been released. You can now include the plugin helper functions into your Nextflow pipeline: Or enable the creation of the help message (using --help ) in the configuration file: Dependencies - Java 17 or later - - Nextflow 25.10.0 or later Slack channel There is a dedicated nf-schema Slack channel in th","default_branch":null,"files":null,"tree":[],"storefront":"/r/nextflow-io","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nextflow-io/nf-schema/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}