samplesheet-parser 2.4.0__tar.gz → 2.5.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/.github/workflows/ci.yml +2 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/.gitignore +0 -2
- samplesheet_parser-2.5.1/.zenodo.json +31 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/CHANGELOG.md +35 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/CITATION.cff +14 -7
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/CONTRIBUTING.md +18 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/Makefile +12 -4
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/PKG-INFO +24 -6
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/README.md +22 -4
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/api.md +7 -3
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/cli.md +8 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/validation.md +5 -3
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/convert/environment.yml +1 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/convert/main.nf +2 -2
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/environment.yml +1 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/main.nf +2 -2
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test.snap +6 -6
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/filter/environment.yml +1 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/filter/main.nf +2 -2
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/environment.yml +1 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/main.nf +2 -2
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/tests/main.nf.test.snap +6 -6
- samplesheet_parser-2.5.1/modules/nf-core/samplesheetparser/merge/environment.yml +6 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/merge/main.nf +2 -2
- samplesheet_parser-2.5.1/modules/nf-core/samplesheetparser/split/environment.yml +6 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/split/main.nf +2 -2
- samplesheet_parser-2.5.1/modules/nf-core/samplesheetparser/validate/environment.yml +6 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/validate/main.nf +2 -2
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test.snap +8 -8
- samplesheet_parser-2.5.1/paper.bib +71 -0
- samplesheet_parser-2.5.1/paper.md +110 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/pyproject.toml +1 -1
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/cli.py +28 -3
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/validators.py +33 -3
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_cli.py +118 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_validators/test_validators.py +27 -1
- samplesheet_parser-2.4.0/.zenodo.json +0 -30
- samplesheet_parser-2.4.0/modules/nf-core/samplesheetparser/merge/environment.yml +0 -6
- samplesheet_parser-2.4.0/modules/nf-core/samplesheetparser/split/environment.yml +0 -6
- samplesheet_parser-2.4.0/modules/nf-core/samplesheetparser/validate/environment.yml +0 -6
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/.github/workflows/copilot-instructions.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/.pre-commit-config.yaml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/.readthedocs.yaml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/CODE_OF_CONDUCT.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/LICENSE +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/changelog.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/ci.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/contributing.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/examples.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/conversion.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/diffing.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/filtering.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/index_utils.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/merging.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/parsing.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/quickstart.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/splitting.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/guide/writing.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/index.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/installation.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/docs/requirements.txt +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/FINDINGS.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/README.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/generate_corpus.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/reference_rules.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/eval/run_eval.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_color_balance.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_converter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_diff.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_element_aviti.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_filter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_index_utils.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_merger.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_splitter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/demo_writer.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/parse_examples.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/ProjectAlpha_SampleSheet.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/ProjectBeta_SampleSheet.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/ProjectDelta_SampleSheet_collision.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/ProjectGamma_SampleSheet.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/README.md +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/combined_clean.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/combined_collision_forced.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/combined_mixed_formats.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/element_aviti_RunManifest.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v1_dual_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v1_multi_lane.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v1_single_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v1_with_lab_qc_settings.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v1_with_manifests.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_nextseq_single_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_novaseq_x_dual_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_with_cloud_settings.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_with_index_umi.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_with_pipeline_settings.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/examples/sample_sheets/v2_with_read_umi.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/images/samplesheet_parser_arch_v03.png +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/images/samplesheet_parser_arch_v2.3.png +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/images/samplesheet_parser_overview.png +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/mkdocs.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/convert/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/convert/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/filter/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/filter/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/filter/tests/nextflow.config +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/merge/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/merge/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/split/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/split/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/validate/meta.yml +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/chemistry.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/converter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/diff.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/enums.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/factory.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/filter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/index_utils.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/instruments.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/merger.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/parsers/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/parsers/element.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/parsers/v1.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/parsers/v2.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/protocol.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/py.typed +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/splitter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/samplesheet_parser/writer.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/scripts/demo_converter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/scripts/demo_diff.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/scripts/demo_writer.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/conftest.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/fixtures/SampleSheet_v1_dual_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/fixtures/SampleSheet_v2_dual_index.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/fixtures/SampleSheet_v2_modified.csv +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_chemistry.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_converter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_diff.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_eval.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_factory.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_filter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_index_utils.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_instruments.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_merger.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_parsers/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_parsers/test_element.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_parsers/test_v1.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_parsers/test_v2.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_reference_rules.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_splitter.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_validators/__init__.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_validators/test_hamming.py +0 -0
- {samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/tests/test_writer.py +0 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"title": "samplesheet-parser: A multi-vendor parser, validator, and converter for sequencing sample sheets",
|
|
3
|
+
"description": "Dependency-free Python library and CLI for parsing, validating, converting, diffing, and merging sequencing sample sheets across vendors — Illumina IEM V1 (bcl2fastq), Illumina BCLConvert V2, and Element AVITI run manifests. Provides format auto-detection behind a shared interface, bidirectional V1/V2 conversion, structural and index-integrity validation, and instrument-aware optical color-balance checking.",
|
|
4
|
+
"upload_type": "software",
|
|
5
|
+
"access_right": "open",
|
|
6
|
+
"license": "Apache-2.0",
|
|
7
|
+
"version": "2.5.1",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"bioinformatics", "Illumina", "Element AVITI", "avidity", "SampleSheet",
|
|
10
|
+
"BCLConvert", "color balance", "multi-vendor", "demultiplexing",
|
|
11
|
+
"genomics", "sequencing", "Python"
|
|
12
|
+
],
|
|
13
|
+
"creators": [
|
|
14
|
+
{
|
|
15
|
+
"name": "Kasaraneni, Chaitanya Krishna",
|
|
16
|
+
"orcid": "0000-0001-5792-1095"
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"related_identifiers": [
|
|
20
|
+
{
|
|
21
|
+
"identifier": "https://github.com/chaitanyakasaraneni/samplesheet-parser",
|
|
22
|
+
"relation": "isSupplementTo",
|
|
23
|
+
"scheme": "url"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"identifier": "https://pypi.org/project/samplesheet-parser/",
|
|
27
|
+
"relation": "isIdenticalTo",
|
|
28
|
+
"scheme": "url"
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
}
|
|
@@ -10,6 +10,41 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
|
10
10
|
|
|
11
11
|
_No unreleased changes._
|
|
12
12
|
|
|
13
|
+
## [2.5.1] - 2026-08-23
|
|
14
|
+
|
|
15
|
+
### Fixed
|
|
16
|
+
|
|
17
|
+
- **JSON output now emits basenames instead of absolute paths** for written
|
|
18
|
+
files: `output_path` in `merge` and `filter`, and the `files` values in
|
|
19
|
+
`split`. The absolute paths made the machine-readable reports depend on the
|
|
20
|
+
working directory, which broke reproducible/snapshot-based pipeline tests
|
|
21
|
+
(e.g. nf-core nf-test). The `MergeResult`/`FilterResult.output_path`
|
|
22
|
+
attributes are unchanged and still hold the full `Path`.
|
|
23
|
+
|
|
24
|
+
## [2.5.0] - 2026-08-10
|
|
25
|
+
|
|
26
|
+
### Added
|
|
27
|
+
|
|
28
|
+
- **CLI `--color-balance-mode` option** on `samplesheet validate`
|
|
29
|
+
(`vendor_faithful` default, or `conservative`), exposing the color-balance
|
|
30
|
+
strictness that was previously reachable only through the library. JSON output
|
|
31
|
+
now reports `color_balance_mode` when color balance is checked.
|
|
32
|
+
- **`ValidationResult.notes`** informational channel (with `add_note()`, included
|
|
33
|
+
in `to_dict()` and CLI text/JSON output). Notes do not affect `is_valid`.
|
|
34
|
+
|
|
35
|
+
### Changed (behavioral)
|
|
36
|
+
|
|
37
|
+
- **Color balance no longer skips silently on an unknown instrument.** When
|
|
38
|
+
`--color-balance` (or `check_color_balance=True`) is requested but the
|
|
39
|
+
instrument chemistry cannot be resolved, the validator now emits a
|
|
40
|
+
`COLOR_BALANCE_SKIPPED` note instead of only a debug log, so a clean result is
|
|
41
|
+
not mistaken for a passed color-balance check.
|
|
42
|
+
|
|
43
|
+
### CI
|
|
44
|
+
|
|
45
|
+
- **CI now tests the full supported Python range (3.10-3.13)** via a matrix,
|
|
46
|
+
matching the `pyproject.toml` classifiers (previously only 3.12 ran).
|
|
47
|
+
|
|
13
48
|
## [2.4.0] - 2026-06-21
|
|
14
49
|
|
|
15
50
|
### Changed (behavioral)
|
|
@@ -3,13 +3,16 @@ message: "If you use this software, please cite it using the metadata below."
|
|
|
3
3
|
type: software
|
|
4
4
|
title: "samplesheet-parser"
|
|
5
5
|
abstract: >
|
|
6
|
-
A Python library for parsing, validating,
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
6
|
+
A dependency-free Python library and CLI for parsing, validating,
|
|
7
|
+
converting, diffing, and merging sequencing sample sheets across vendors:
|
|
8
|
+
Illumina IEM V1 (bcl2fastq), Illumina BCLConvert V2, and Element AVITI
|
|
9
|
+
run manifests. Provides format auto-detection behind one shared interface,
|
|
10
|
+
bidirectional V1/V2 conversion, structural and index-integrity validation
|
|
11
|
+
(including wildcard-aware Hamming-distance collision detection), and
|
|
12
|
+
instrument-aware optical color-balance checking for four-, two-, and
|
|
13
|
+
one-channel Illumina chemistries and Element AVITI avidity chemistry.
|
|
14
|
+
version: 2.5.1
|
|
15
|
+
date-released: 2026-08-23
|
|
13
16
|
license: Apache-2.0
|
|
14
17
|
url: "https://github.com/chaitanyakasaraneni/samplesheet-parser"
|
|
15
18
|
repository-code: "https://github.com/chaitanyakasaraneni/samplesheet-parser"
|
|
@@ -17,9 +20,13 @@ repository-artifact: "https://pypi.org/project/samplesheet-parser/"
|
|
|
17
20
|
keywords:
|
|
18
21
|
- bioinformatics
|
|
19
22
|
- Illumina
|
|
23
|
+
- Element AVITI
|
|
24
|
+
- avidity
|
|
20
25
|
- SampleSheet
|
|
21
26
|
- BCLConvert
|
|
22
27
|
- bcl2fastq
|
|
28
|
+
- color balance
|
|
29
|
+
- multi-vendor
|
|
23
30
|
- demultiplexing
|
|
24
31
|
- genomics
|
|
25
32
|
- sequencing
|
|
@@ -4,6 +4,23 @@ Thanks for contributing! This guide explains how to set up a local development e
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
+
## Reporting issues and getting support
|
|
8
|
+
|
|
9
|
+
- **Found a bug or have a feature request?** Open an issue on the
|
|
10
|
+
[GitHub issue tracker](https://github.com/chaitanyakasaraneni/samplesheet-parser/issues).
|
|
11
|
+
For bugs, please include the `samplesheet-parser` version, your Python
|
|
12
|
+
version, a minimal sample sheet that reproduces the problem (with any
|
|
13
|
+
sensitive sample IDs redacted), and the full command or code plus the
|
|
14
|
+
output you got versus what you expected.
|
|
15
|
+
- **Have a usage question or want to discuss an idea?** Open an issue on the
|
|
16
|
+
[tracker](https://github.com/chaitanyakasaraneni/samplesheet-parser/issues)
|
|
17
|
+
and label it as a question — the maintainer monitors issues and is happy to
|
|
18
|
+
help.
|
|
19
|
+
- **Security-sensitive reports** should not be filed as public issues. Please
|
|
20
|
+
email the maintainer directly at kc.kasaraneni@gmail.com instead.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
7
24
|
## Table of contents
|
|
8
25
|
|
|
9
26
|
- [Contributing to samplesheet-parser](#contributing-to-samplesheet-parser)
|
|
@@ -28,7 +45,7 @@ Thanks for contributing! This guide explains how to set up a local development e
|
|
|
28
45
|
git clone https://github.com/chaitanyakasaraneni/samplesheet-parser.git
|
|
29
46
|
cd samplesheet-parser
|
|
30
47
|
|
|
31
|
-
# 2. Create a virtual environment (Python 3.
|
|
48
|
+
# 2. Create a virtual environment (Python 3.10+)
|
|
32
49
|
python -m venv .venv
|
|
33
50
|
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
|
34
51
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Makefile for samplesheet-parser
|
|
2
|
-
# Keeps the version in sync across pyproject.toml, CITATION.cff,
|
|
2
|
+
# Keeps the version in sync across pyproject.toml, CITATION.cff, .zenodo.json, and uv.lock.
|
|
3
3
|
# Portable to GNU Make 3.81 (macOS default) — recipes are single POSIX-sh lines.
|
|
4
4
|
|
|
5
5
|
PKG := samplesheet_parser
|
|
@@ -11,12 +11,12 @@ CHANGELOG := CHANGELOG.md
|
|
|
11
11
|
CURRENT_VERSION := $(shell sed -n -E 's/^version = "([0-9]+\.[0-9]+\.[0-9]+)".*/\1/p' $(PYPROJECT) | head -1)
|
|
12
12
|
|
|
13
13
|
.DEFAULT_GOAL := help
|
|
14
|
-
.PHONY: help version major minor patch tag test lint build clean
|
|
14
|
+
.PHONY: help version major minor patch tag lock test lint build clean
|
|
15
15
|
|
|
16
16
|
help:
|
|
17
17
|
@echo "samplesheet-parser — current version: $(CURRENT_VERSION)"
|
|
18
18
|
@echo ""
|
|
19
|
-
@echo "Version bumping (syncs $(PYPROJECT), $(CITATION), $(ZENODO); rolls $(CHANGELOG)):"
|
|
19
|
+
@echo "Version bumping (syncs $(PYPROJECT), $(CITATION), $(ZENODO), uv.lock; rolls $(CHANGELOG)):"
|
|
20
20
|
@echo " make patch patch bump (x.y.Z)"
|
|
21
21
|
@echo " make minor minor bump (x.Y.0)"
|
|
22
22
|
@echo " make major major bump (X.0.0)"
|
|
@@ -24,6 +24,7 @@ help:
|
|
|
24
24
|
@echo "Other targets:"
|
|
25
25
|
@echo " make version print the current version"
|
|
26
26
|
@echo " make tag create git tag v$(CURRENT_VERSION)"
|
|
27
|
+
@echo " make lock refresh uv.lock (uv lock)"
|
|
27
28
|
@echo " make test run pytest"
|
|
28
29
|
@echo " make lint run ruff"
|
|
29
30
|
@echo " make build build sdist + wheel"
|
|
@@ -50,6 +51,9 @@ _bump:
|
|
|
50
51
|
sed -E 's/^version = "[0-9]+\.[0-9]+\.[0-9]+"/version = "'"$$new"'"/' $(PYPROJECT) > $(PYPROJECT).tmp && mv $(PYPROJECT).tmp $(PYPROJECT); \
|
|
51
52
|
sed -E -e 's/^version: .*/version: '"$$new"'/' -e 's/^date-released: .*/date-released: '"$$today"'/' $(CITATION) > $(CITATION).tmp && mv $(CITATION).tmp $(CITATION); \
|
|
52
53
|
sed -E 's/("version": )"[0-9]+\.[0-9]+\.[0-9]+"/\1"'"$$new"'"/' $(ZENODO) > $(ZENODO).tmp && mv $(ZENODO).tmp $(ZENODO); \
|
|
54
|
+
if command -v uv >/dev/null 2>&1; then \
|
|
55
|
+
if uv lock >/dev/null 2>&1; then lock_note=", uv.lock"; else lock_note=" (warning: uv lock failed)"; fi; \
|
|
56
|
+
else lock_note=" (uv not found — uv.lock not refreshed)"; fi; \
|
|
53
57
|
cl_note=""; \
|
|
54
58
|
if [ -f $(CHANGELOG) ] && grep -q '^## \[Unreleased\]' $(CHANGELOG); then \
|
|
55
59
|
awk -v v="$$new" -v d="$$today" '!done && /^## \[Unreleased\]/ {print "## [Unreleased]"; print ""; print "_No unreleased changes._"; print ""; print "## [" v "] - " d; done=1; next} {print}' $(CHANGELOG) > $(CHANGELOG).tmp && mv $(CHANGELOG).tmp $(CHANGELOG); \
|
|
@@ -58,7 +62,7 @@ _bump:
|
|
|
58
62
|
cl_note=" (warning: no [Unreleased] section in $(CHANGELOG) — not rolled)"; \
|
|
59
63
|
fi; \
|
|
60
64
|
echo "Bumped $$cur -> $$new (date-released: $$today)"; \
|
|
61
|
-
echo " updated: $(PYPROJECT), $(CITATION), $(ZENODO)$$cl_note"; \
|
|
65
|
+
echo " updated: $(PYPROJECT), $(CITATION), $(ZENODO)$$lock_note$$cl_note"; \
|
|
62
66
|
echo "Next: review $(CHANGELOG), then: git commit -am \"release v$$new\" && make tag && git push --follow-tags"
|
|
63
67
|
|
|
64
68
|
tag:
|
|
@@ -67,6 +71,10 @@ tag:
|
|
|
67
71
|
git tag -a "v$$v" -m "Release v$$v"; \
|
|
68
72
|
echo "created annotated tag v$$v (push with: git push --follow-tags)"
|
|
69
73
|
|
|
74
|
+
lock:
|
|
75
|
+
@command -v uv >/dev/null 2>&1 || { echo "error: uv not found (https://docs.astral.sh/uv/)"; exit 1; }; \
|
|
76
|
+
uv lock && echo "uv.lock refreshed to $(CURRENT_VERSION)"
|
|
77
|
+
|
|
70
78
|
test:
|
|
71
79
|
@pytest
|
|
72
80
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
2
|
Name: samplesheet-parser
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.5.1
|
|
4
4
|
Summary: Multi-vendor, format-agnostic parser for sequencing sample sheets — Illumina IEM V1 & BCLConvert V2 plus Element AVITI run manifests, with index validation and color-balance checking
|
|
5
5
|
Project-URL: Homepage, https://github.com/chaitanyakasaraneni/samplesheet-parser
|
|
6
6
|
Project-URL: Documentation, https://samplesheet-parser.readthedocs.io
|
|
@@ -430,8 +430,9 @@ for err in result.errors:
|
|
|
430
430
|
```
|
|
431
431
|
|
|
432
432
|
The chemistry is resolved from the instrument name; the check is **off by
|
|
433
|
-
default** (it can legitimately fail a low-plex pool) and
|
|
434
|
-
|
|
433
|
+
default** (it can legitimately fail a low-plex pool) and, for an unknown
|
|
434
|
+
instrument, is not run but reported as a `COLOR_BALANCE_SKIPPED` note rather than
|
|
435
|
+
passing silently. The same analysis is available standalone:
|
|
435
436
|
|
|
436
437
|
```python
|
|
437
438
|
from samplesheet_parser import analyze_color_balance, chemistry_for_instrument
|
|
@@ -448,12 +449,20 @@ From the CLI:
|
|
|
448
449
|
```bash
|
|
449
450
|
samplesheet validate SampleSheet.csv --color-balance
|
|
450
451
|
samplesheet validate SampleSheet.csv --color-balance --instrument NovaSeqXSeries
|
|
452
|
+
samplesheet validate SampleSheet.csv --color-balance --color-balance-mode conservative
|
|
451
453
|
```
|
|
452
454
|
|
|
455
|
+
When `--color-balance` is requested but the instrument cannot be resolved, the
|
|
456
|
+
check is not run (guessing the chemistry would be misleading). This is surfaced
|
|
457
|
+
as a `COLOR_BALANCE_SKIPPED` note (in text and JSON output) rather than a silent
|
|
458
|
+
pass, so a clean result is never mistaken for a passed color-balance check. Pass
|
|
459
|
+
`--instrument` to enable the check.
|
|
460
|
+
|
|
453
461
|
#### Modes: `vendor_faithful` (default) and `conservative`
|
|
454
462
|
|
|
455
|
-
Color balance has two modes, selectable via
|
|
456
|
-
|
|
463
|
+
Color balance has two modes, selectable on the CLI via
|
|
464
|
+
`--color-balance-mode {vendor_faithful,conservative}` or in the library via
|
|
465
|
+
`validate(..., color_balance_mode=...)` / `analyze_color_balance(..., mode=...)`:
|
|
457
466
|
|
|
458
467
|
- **`vendor_faithful`** (default) encodes each platform's *published* rule
|
|
459
468
|
exactly — Illumina's "signal in at least one channel" minimum for 2-channel,
|
|
@@ -821,6 +830,15 @@ Apache 2.0 — see [LICENSE](LICENSE).
|
|
|
821
830
|
|
|
822
831
|
---
|
|
823
832
|
|
|
833
|
+
## AI-assisted development
|
|
834
|
+
|
|
835
|
+
Parts of this project's code, tests, and documentation were developed with the
|
|
836
|
+
assistance of generative AI tools (including GitHub Copilot). All AI-generated
|
|
837
|
+
output was reviewed, edited, and verified by the author, who is responsible for
|
|
838
|
+
the correctness of the final software.
|
|
839
|
+
|
|
840
|
+
---
|
|
841
|
+
|
|
824
842
|
## Related resources
|
|
825
843
|
|
|
826
844
|
- [Illumina IEM V1 SampleSheet reference (Knowledge Article #2204)](https://knowledge.illumina.com/software/on-premises-software/software-on-premises-software-reference_material-list/000002204)
|
|
@@ -374,8 +374,9 @@ for err in result.errors:
|
|
|
374
374
|
```
|
|
375
375
|
|
|
376
376
|
The chemistry is resolved from the instrument name; the check is **off by
|
|
377
|
-
default** (it can legitimately fail a low-plex pool) and
|
|
378
|
-
|
|
377
|
+
default** (it can legitimately fail a low-plex pool) and, for an unknown
|
|
378
|
+
instrument, is not run but reported as a `COLOR_BALANCE_SKIPPED` note rather than
|
|
379
|
+
passing silently. The same analysis is available standalone:
|
|
379
380
|
|
|
380
381
|
```python
|
|
381
382
|
from samplesheet_parser import analyze_color_balance, chemistry_for_instrument
|
|
@@ -392,12 +393,20 @@ From the CLI:
|
|
|
392
393
|
```bash
|
|
393
394
|
samplesheet validate SampleSheet.csv --color-balance
|
|
394
395
|
samplesheet validate SampleSheet.csv --color-balance --instrument NovaSeqXSeries
|
|
396
|
+
samplesheet validate SampleSheet.csv --color-balance --color-balance-mode conservative
|
|
395
397
|
```
|
|
396
398
|
|
|
399
|
+
When `--color-balance` is requested but the instrument cannot be resolved, the
|
|
400
|
+
check is not run (guessing the chemistry would be misleading). This is surfaced
|
|
401
|
+
as a `COLOR_BALANCE_SKIPPED` note (in text and JSON output) rather than a silent
|
|
402
|
+
pass, so a clean result is never mistaken for a passed color-balance check. Pass
|
|
403
|
+
`--instrument` to enable the check.
|
|
404
|
+
|
|
397
405
|
#### Modes: `vendor_faithful` (default) and `conservative`
|
|
398
406
|
|
|
399
|
-
Color balance has two modes, selectable via
|
|
400
|
-
|
|
407
|
+
Color balance has two modes, selectable on the CLI via
|
|
408
|
+
`--color-balance-mode {vendor_faithful,conservative}` or in the library via
|
|
409
|
+
`validate(..., color_balance_mode=...)` / `analyze_color_balance(..., mode=...)`:
|
|
401
410
|
|
|
402
411
|
- **`vendor_faithful`** (default) encodes each platform's *published* rule
|
|
403
412
|
exactly — Illumina's "signal in at least one channel" minimum for 2-channel,
|
|
@@ -765,6 +774,15 @@ Apache 2.0 — see [LICENSE](LICENSE).
|
|
|
765
774
|
|
|
766
775
|
---
|
|
767
776
|
|
|
777
|
+
## AI-assisted development
|
|
778
|
+
|
|
779
|
+
Parts of this project's code, tests, and documentation were developed with the
|
|
780
|
+
assistance of generative AI tools (including GitHub Copilot). All AI-generated
|
|
781
|
+
output was reviewed, edited, and verified by the author, who is responsible for
|
|
782
|
+
the correctness of the final software.
|
|
783
|
+
|
|
784
|
+
---
|
|
785
|
+
|
|
768
786
|
## Related resources
|
|
769
787
|
|
|
770
788
|
- [Illumina IEM V1 SampleSheet reference (Knowledge Article #2204)](https://knowledge.illumina.com/software/on-premises-software/software-on-premises-software-reference_material-list/000002204)
|
|
@@ -131,11 +131,13 @@ from samplesheet_parser.instruments import (
|
|
|
131
131
|
|
|
132
132
|
Color-balance checking is **opt-in** via `check_color_balance=True`. The
|
|
133
133
|
instrument is read from the sheet header when present, or supplied with
|
|
134
|
-
`instrument=`; the check is
|
|
134
|
+
`instrument=`; for an unknown instrument the check is not run and a
|
|
135
|
+
`COLOR_BALANCE_SKIPPED` note is added (rather than passing silently).
|
|
135
136
|
`color_balance_mode` is `"vendor_faithful"` (default) or `"conservative"` (see
|
|
136
137
|
[`ColorBalanceMode`](#samplesheet_parserchemistry)). It emits
|
|
137
|
-
`COLOR_BALANCE_NO_SIGNAL` (error), `COLOR_BALANCE_LOW` (warning),
|
|
138
|
-
`COLOR_BALANCE_ADVISORY` (warning, AVITI)
|
|
138
|
+
`COLOR_BALANCE_NO_SIGNAL` (error), `COLOR_BALANCE_LOW` (warning),
|
|
139
|
+
`COLOR_BALANCE_ADVISORY` (warning, AVITI), and `COLOR_BALANCE_SKIPPED` (note)
|
|
140
|
+
issues — see
|
|
139
141
|
[Validation → Color-balance checking](guide/validation.md#color-balance-checking).
|
|
140
142
|
|
|
141
143
|
### ValidationResult
|
|
@@ -145,6 +147,8 @@ instrument is read from the sheet header when present, or supplied with
|
|
|
145
147
|
| `is_valid` | `bool` | `False` if any errors present |
|
|
146
148
|
| `errors` | `list[ValidationIssue]` | Structured error records |
|
|
147
149
|
| `warnings` | `list[ValidationIssue]` | Structured warning records |
|
|
150
|
+
| `notes` | `list[ValidationIssue]` | Informational records (e.g. a skipped check); do not affect `is_valid` |
|
|
151
|
+
| `to_dict()` | `dict` | Serializable `is_valid` / `errors` / `warnings` / `notes` |
|
|
148
152
|
| `summary()` | `str` | One-line human-readable summary |
|
|
149
153
|
|
|
150
154
|
### ValidationIssue
|
|
@@ -81,6 +81,7 @@ samplesheet validate SampleSheet.csv --format json
|
|
|
81
81
|
samplesheet validate SampleSheet.csv --min-hamming 4
|
|
82
82
|
samplesheet validate SampleSheet.csv --color-balance
|
|
83
83
|
samplesheet validate SampleSheet.csv --color-balance --instrument "NovaSeq X"
|
|
84
|
+
samplesheet validate SampleSheet.csv --color-balance --color-balance-mode conservative
|
|
84
85
|
```
|
|
85
86
|
|
|
86
87
|
**Options:**
|
|
@@ -89,9 +90,15 @@ samplesheet validate SampleSheet.csv --color-balance --instrument "NovaSeq X"
|
|
|
89
90
|
|---|---|---|
|
|
90
91
|
| `--format` / `-f` | `text` | Output format: `text` or `json` |
|
|
91
92
|
| `--min-hamming` | `3` | Minimum Hamming distance between indexes |
|
|
92
|
-
| `--color-balance` / `--no-color-balance` | off | Also run per-cycle color-balance checking against the instrument's optical chemistry (opt-in
|
|
93
|
+
| `--color-balance` / `--no-color-balance` | off | Also run per-cycle color-balance checking against the instrument's optical chemistry (opt-in) |
|
|
94
|
+
| `--color-balance-mode` | `vendor_faithful` | Strictness of the color-balance check: `vendor_faithful` (each platform's published rule) or `conservative` (also fails single-channel and low-diversity cycles the vendor minimum permits) |
|
|
93
95
|
| `--instrument` | from header | Instrument name used to resolve chemistry for the color-balance check |
|
|
94
96
|
|
|
97
|
+
When `--color-balance` is requested but the instrument cannot be resolved, the
|
|
98
|
+
check is not run and a `COLOR_BALANCE_SKIPPED` note is emitted (in both text and
|
|
99
|
+
JSON output) rather than passing silently, so a clean result is not mistaken for
|
|
100
|
+
a passed color-balance check. Pass `--instrument` to enable the check.
|
|
101
|
+
|
|
95
102
|
**Exit codes:** `0` = valid, `1` = errors found, `2` = parse/usage error.
|
|
96
103
|
|
|
97
104
|
---
|
|
@@ -34,8 +34,9 @@ for w in result.warnings:
|
|
|
34
34
|
| `COLOR_BALANCE_NO_SIGNAL` | error | An index cycle has no optical signal (2-/1-channel dark, or a 4-channel laser absent), or a conservative-mode escalation (opt-in) |
|
|
35
35
|
| `COLOR_BALANCE_LOW` | warning | An index cycle has weak or single-channel signal (opt-in) |
|
|
36
36
|
| `COLOR_BALANCE_ADVISORY` | warning | AVITI low-diversity advisory in `vendor_faithful` mode (opt-in) |
|
|
37
|
+
| `COLOR_BALANCE_SKIPPED` | note | Color balance was requested but the instrument chemistry could not be resolved, so the check was not run (opt-in) |
|
|
37
38
|
|
|
38
|
-
The
|
|
39
|
+
The color-balance checks are **opt-in** — see [Color-balance checking](#color-balance-checking) below. Notes are informational and do not affect `is_valid`; they appear in a `notes` list on the result (and in JSON output).
|
|
39
40
|
|
|
40
41
|
## Index distance checking
|
|
41
42
|
|
|
@@ -80,12 +81,13 @@ result = SampleSheetValidator().validate(
|
|
|
80
81
|
- **Two-/one-channel**: an all-`G` (no-signal) cycle is a `COLOR_BALANCE_NO_SIGNAL` error in both modes. A single-channel cycle (one channel present, the other dark) meets Illumina's "at least one channel" minimum, so it is a `COLOR_BALANCE_LOW` warning in `vendor_faithful` but an error in `conservative`. A both-present-but-faint channel (below `min_signal_fraction`, default 0.10) is a `COLOR_BALANCE_LOW` warning.
|
|
81
82
|
- **Four-channel** (Illumina MiSeq/HiSeq): the green laser reads `{G,T}` and the red laser reads `{A,C}`; a cycle missing either laser group (e.g. all-`G`, or `G/T`-only) is a `COLOR_BALANCE_NO_SIGNAL` error in **both** modes.
|
|
82
83
|
- **Avidity** (Element AVITI): each base has its own dye and there is no laser-pair constraint, so low diversity never fails. In `vendor_faithful` it is a `COLOR_BALANCE_ADVISORY` warning (first cycles only); in `conservative` it is escalated to an error.
|
|
83
|
-
- If the instrument is unknown, the check is
|
|
84
|
+
- If the instrument is unknown, the check is not run (guessing the chemistry would be misleading), and a `COLOR_BALANCE_SKIPPED` note is added so a clean result is not mistaken for a passed check.
|
|
84
85
|
|
|
85
|
-
The CLI exposes the same check:
|
|
86
|
+
The CLI exposes the same check, including the mode:
|
|
86
87
|
|
|
87
88
|
```bash
|
|
88
89
|
samplesheet validate SampleSheet.csv --color-balance --instrument "NovaSeq X"
|
|
90
|
+
samplesheet validate SampleSheet.csv --color-balance --color-balance-mode conservative
|
|
89
91
|
```
|
|
90
92
|
|
|
91
93
|
The underlying API — `Chemistry`, `ColorBalanceMode`, `chemistry_for_instrument()`, and `analyze_color_balance(..., mode=...)` returning a `ColorBalanceReport` — is public and usable on its own.
|
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_CONVERT {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(samplesheet)
|
{samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/diff/main.nf
RENAMED
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_DIFF {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(old_sheet, stageAs: "old/*"), path(new_sheet, stageAs: "new/*")
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
[
|
|
15
15
|
"SAMPLESHEETPARSER_DIFF",
|
|
16
16
|
"samplesheet-parser",
|
|
17
|
-
"
|
|
17
|
+
"2.5.0"
|
|
18
18
|
]
|
|
19
19
|
]
|
|
20
20
|
}
|
|
21
21
|
],
|
|
22
|
-
"timestamp": "2026-
|
|
22
|
+
"timestamp": "2026-08-22T18:33:02.437949",
|
|
23
23
|
"meta": {
|
|
24
24
|
"nf-test": "0.9.5",
|
|
25
25
|
"nextflow": "25.10.4"
|
|
@@ -40,12 +40,12 @@
|
|
|
40
40
|
[
|
|
41
41
|
"SAMPLESHEETPARSER_DIFF",
|
|
42
42
|
"samplesheet-parser",
|
|
43
|
-
"
|
|
43
|
+
"2.5.0"
|
|
44
44
|
]
|
|
45
45
|
]
|
|
46
46
|
}
|
|
47
47
|
],
|
|
48
|
-
"timestamp": "2026-
|
|
48
|
+
"timestamp": "2026-08-22T18:33:11.038032",
|
|
49
49
|
"meta": {
|
|
50
50
|
"nf-test": "0.9.5",
|
|
51
51
|
"nextflow": "25.10.4"
|
|
@@ -66,12 +66,12 @@
|
|
|
66
66
|
[
|
|
67
67
|
"SAMPLESHEETPARSER_DIFF",
|
|
68
68
|
"samplesheet-parser",
|
|
69
|
-
"
|
|
69
|
+
"2.5.0"
|
|
70
70
|
]
|
|
71
71
|
]
|
|
72
72
|
}
|
|
73
73
|
],
|
|
74
|
-
"timestamp": "2026-
|
|
74
|
+
"timestamp": "2026-08-22T18:32:53.382754",
|
|
75
75
|
"meta": {
|
|
76
76
|
"nf-test": "0.9.5",
|
|
77
77
|
"nextflow": "25.10.4"
|
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_FILTER {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(samplesheet)
|
{samplesheet_parser-2.4.0 → samplesheet_parser-2.5.1}/modules/nf-core/samplesheetparser/info/main.nf
RENAMED
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_INFO {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(samplesheet)
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
[
|
|
15
15
|
"SAMPLESHEETPARSER_INFO",
|
|
16
16
|
"samplesheet-parser",
|
|
17
|
-
"
|
|
17
|
+
"2.5.0"
|
|
18
18
|
]
|
|
19
19
|
]
|
|
20
20
|
}
|
|
21
21
|
],
|
|
22
|
-
"timestamp": "2026-
|
|
22
|
+
"timestamp": "2026-08-22T18:33:19.188856",
|
|
23
23
|
"meta": {
|
|
24
24
|
"nf-test": "0.9.5",
|
|
25
25
|
"nextflow": "25.10.4"
|
|
@@ -40,12 +40,12 @@
|
|
|
40
40
|
[
|
|
41
41
|
"SAMPLESHEETPARSER_INFO",
|
|
42
42
|
"samplesheet-parser",
|
|
43
|
-
"
|
|
43
|
+
"2.5.0"
|
|
44
44
|
]
|
|
45
45
|
]
|
|
46
46
|
}
|
|
47
47
|
],
|
|
48
|
-
"timestamp": "2026-
|
|
48
|
+
"timestamp": "2026-08-22T18:33:27.427592",
|
|
49
49
|
"meta": {
|
|
50
50
|
"nf-test": "0.9.5",
|
|
51
51
|
"nextflow": "25.10.4"
|
|
@@ -66,12 +66,12 @@
|
|
|
66
66
|
[
|
|
67
67
|
"SAMPLESHEETPARSER_INFO",
|
|
68
68
|
"samplesheet-parser",
|
|
69
|
-
"
|
|
69
|
+
"2.5.0"
|
|
70
70
|
]
|
|
71
71
|
]
|
|
72
72
|
}
|
|
73
73
|
],
|
|
74
|
-
"timestamp": "2026-
|
|
74
|
+
"timestamp": "2026-08-22T18:33:35.47839",
|
|
75
75
|
"meta": {
|
|
76
76
|
"nf-test": "0.9.5",
|
|
77
77
|
"nextflow": "25.10.4"
|
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_MERGE {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(samplesheets)
|
|
@@ -4,8 +4,8 @@ process SAMPLESHEETPARSER_SPLIT {
|
|
|
4
4
|
|
|
5
5
|
conda "${moduleDir}/environment.yml"
|
|
6
6
|
container "${ workflow.containerEngine in ['singularity', 'apptainer'] && !task.ext.singularity_pull_docker_container ?
|
|
7
|
-
'https://depot.galaxyproject.org/singularity/samplesheet-parser:
|
|
8
|
-
'quay.io/biocontainers/samplesheet-parser:
|
|
7
|
+
'https://depot.galaxyproject.org/singularity/samplesheet-parser:2.5.0--pyhdfd78af_0' :
|
|
8
|
+
'quay.io/biocontainers/samplesheet-parser:2.5.0--pyhdfd78af_0' }"
|
|
9
9
|
|
|
10
10
|
input:
|
|
11
11
|
tuple val(meta), path(samplesheet)
|