nf-core/samplesheetparser/validate @ 0.0.0-4b801f9
Summary
Validate an Illumina SampleSheet.csv (V1 or V2) for index, adapter, and structural issues. Format is auto-detected. Exits 0 if valid, 1 if errors are found — causing the pipeline to fail early with a clear message rather than discovering demultiplexing problems downstream.
Get started
Add the following snippet to your workflow script to include this module.
include { SAMPLESHEETPARSER_VALIDATE } from 'nf-core/samplesheetparser/validate'
License
MIT License
Process
Name
|
SAMPLESHEETPARSER_VALIDATE |
|---|
Input
1 channel
#1
tuple
meta
map
|
Groovy Map containing sample information. Use [ id:'run_id' ] to identify the sheet. |
|---|---|
samplesheet
file
|
Illumina SampleSheet.csv (V1 or V2 format) *.{csv,CSV}
|
Output
2 channels
#1
json
tuple
meta
map
|
Groovy Map containing sample information |
|---|---|
*.validation.json
file
|
Structured JSON validation report with is_valid, errors, warnings, and min_hamming_distance fields. *.validation.json
|
#2
versions_samplesheetparser
tuple
${task.process}
string
|
The name of the process |
|---|---|
samplesheet-parser
string
|
The name of the tool |
samplesheet --version | sed 's/samplesheet-parser //'
eval
|
The expression to obtain the version of the tool |
| Tool | Description | Homepage |
|---|---|---|
| samplesheet-parser | Format-agnostic parser for Illumina SampleSheet.csv files. Supports IEM V1 (bcl2fastq) and BCLConvert V2 with auto-detection, bidirectional conversion, index validation, and Hamming distance checking. | https://github.com/chaitanyakasaraneni/samplesheet-parser |
| Version | 0.0.0-4b801f9 |
|---|---|
| Commit ID | 4b801f99cf081cfbc00d202272385817636e6dfd |
| Release Date | 15 May 2026 15:00:20 (UTC) |
| Download URL | https://registry.nextflow.io/api/v1/modules/nf-core%2Fsamplesheetparser%2Fvalidate/0.0.0-4b801f9/download |
| OCI Store URL | https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/samplesheetparser/validate/blobs/sha256:9dbcf51c9fedae38db11cc91d6e84d069a2b64924edae7dbc2682ce292cd2043 |
| Size | 2.5 KB |
| Checksum | sha256:9dbcf51c9fedae38db11cc91d6e84d069a2b64924edae7dbc2682ce292cd2043 |
| Downloads | 0 |
| Version | Date | Status | Downloads | Size | Diff |
|---|---|---|---|---|---|
| 0.0.0-4b801f9 | 15 May 2026 15:00:20 (UTC) | 0 | 2.5 KB | - |