samplesheet-parser 2.2.0__tar.gz → 2.4.0__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.2.0 → samplesheet_parser-2.4.0}/.gitignore +6 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/.zenodo.json +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/CHANGELOG.md +58 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/CITATION.cff +2 -2
- samplesheet_parser-2.4.0/CODE_OF_CONDUCT.md +128 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/PKG-INFO +132 -21
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/README.md +128 -17
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/api.md +100 -5
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/cli.md +4 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/examples.md +29 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/parsing.md +7 -6
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/quickstart.md +2 -2
- samplesheet_parser-2.4.0/docs/guide/validation.md +103 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/index.md +10 -8
- samplesheet_parser-2.4.0/eval/FINDINGS.md +194 -0
- samplesheet_parser-2.4.0/eval/README.md +130 -0
- samplesheet_parser-2.4.0/eval/__init__.py +8 -0
- samplesheet_parser-2.4.0/eval/generate_corpus.py +580 -0
- samplesheet_parser-2.4.0/eval/reference_rules.py +233 -0
- samplesheet_parser-2.4.0/eval/run_eval.py +533 -0
- samplesheet_parser-2.4.0/examples/demo_color_balance.py +85 -0
- samplesheet_parser-2.4.0/examples/demo_element_aviti.py +57 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/README.md +35 -4
- samplesheet_parser-2.4.0/examples/sample_sheets/element_aviti_RunManifest.csv +16 -0
- samplesheet_parser-2.4.0/images/samplesheet_parser_arch_v2.3.png +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/mkdocs.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/convert/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/diff/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/filter/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/info/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/merge/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/split/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/validate/meta.yml +1 -1
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/pyproject.toml +4 -3
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/__init__.py +16 -1
- samplesheet_parser-2.4.0/samplesheet_parser/chemistry.py +467 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/cli.py +30 -3
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/enums.py +7 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/factory.py +11 -1
- samplesheet_parser-2.4.0/samplesheet_parser/parsers/element.py +329 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/validators.py +214 -0
- samplesheet_parser-2.4.0/tests/test_chemistry.py +171 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_cli.py +0 -9
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_converter.py +0 -5
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_diff.py +0 -1
- samplesheet_parser-2.4.0/tests/test_eval.py +200 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_factory.py +1 -5
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_index_utils.py +2 -7
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_instruments.py +0 -3
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_merger.py +0 -18
- samplesheet_parser-2.4.0/tests/test_parsers/test_element.py +115 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_parsers/test_v1.py +2 -9
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_parsers/test_v2.py +2 -10
- samplesheet_parser-2.4.0/tests/test_reference_rules.py +136 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_validators/test_validators.py +111 -9
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_writer.py +0 -5
- samplesheet_parser-2.2.0/docs/guide/validation.md +0 -63
- samplesheet_parser-2.2.0/recipes/meta.yaml +0 -56
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/.github/workflows/ci.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/.github/workflows/copilot-instructions.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/.pre-commit-config.yaml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/.readthedocs.yaml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/CONTRIBUTING.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/LICENSE +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/Makefile +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/changelog.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/ci.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/contributing.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/conversion.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/diffing.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/filtering.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/index_utils.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/merging.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/splitting.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/guide/writing.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/installation.md +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/docs/requirements.txt +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_converter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_diff.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_filter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_index_utils.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_merger.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_splitter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/demo_writer.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/parse_examples.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/ProjectAlpha_SampleSheet.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/ProjectBeta_SampleSheet.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/ProjectDelta_SampleSheet_collision.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/ProjectGamma_SampleSheet.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/combined_clean.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/combined_collision_forced.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/combined_mixed_formats.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v1_dual_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v1_multi_lane.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v1_single_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v1_with_lab_qc_settings.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v1_with_manifests.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_nextseq_single_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_novaseq_x_dual_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_with_cloud_settings.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_with_index_umi.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_with_pipeline_settings.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/examples/sample_sheets/v2_with_read_umi.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/images/samplesheet_parser_arch_v03.png +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/images/samplesheet_parser_overview.png +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/convert/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/convert/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/convert/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/diff/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/diff/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/diff/tests/main.nf.test.snap +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/filter/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/filter/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/filter/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/filter/tests/nextflow.config +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/info/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/info/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/info/tests/main.nf.test.snap +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/merge/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/merge/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/merge/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/split/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/split/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/split/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/validate/environment.yml +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/validate/main.nf +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/modules/nf-core/samplesheetparser/validate/tests/main.nf.test.snap +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/converter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/diff.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/filter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/index_utils.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/instruments.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/merger.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/parsers/__init__.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/parsers/v1.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/parsers/v2.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/protocol.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/py.typed +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/splitter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/samplesheet_parser/writer.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/scripts/demo_converter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/scripts/demo_diff.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/scripts/demo_writer.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/__init__.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/conftest.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/fixtures/SampleSheet_v1_dual_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/fixtures/SampleSheet_v2_dual_index.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/fixtures/SampleSheet_v2_modified.csv +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_filter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_parsers/__init__.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_splitter.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_validators/__init__.py +0 -0
- {samplesheet_parser-2.2.0 → samplesheet_parser-2.4.0}/tests/test_validators/test_hamming.py +0 -0
|
@@ -4,6 +4,12 @@ tests/fixtures/outputs/
|
|
|
4
4
|
demo_output.txt
|
|
5
5
|
**/CSBJ Submission/
|
|
6
6
|
**/.claude/
|
|
7
|
+
eval/results/
|
|
8
|
+
corpus/**
|
|
9
|
+
paper.md
|
|
10
|
+
paper.bib
|
|
11
|
+
images/gen_arch_excalidraw.py
|
|
12
|
+
images/samplesheet_parser_arch_v2.3.excalidraw
|
|
7
13
|
|
|
8
14
|
# Cache and build artifacts
|
|
9
15
|
__pycache__/
|
|
@@ -10,6 +10,64 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
|
10
10
|
|
|
11
11
|
_No unreleased changes._
|
|
12
12
|
|
|
13
|
+
## [2.4.0] - 2026-06-21
|
|
14
|
+
|
|
15
|
+
### Changed (behavioral)
|
|
16
|
+
|
|
17
|
+
- **Color-balance checking now has two modes: `vendor_faithful` (new default)
|
|
18
|
+
and `conservative`.** `vendor_faithful` encodes each platform's published
|
|
19
|
+
rule exactly; `conservative` is the previous, stricter behavior (single-channel
|
|
20
|
+
2-channel cycles and AVITI low-diversity treated as failures). Selectable via
|
|
21
|
+
`analyze_color_balance(..., mode=...)` and `SampleSheetValidator.validate(...,
|
|
22
|
+
color_balance_mode=...)`. **Callers relying on the old stricter results should
|
|
23
|
+
pass `color_balance_mode="conservative"`.**
|
|
24
|
+
- **Fixed a 4-channel color-balance bug (both modes):** Illumina four-channel
|
|
25
|
+
cycles are now failed when either laser group is absent (green `{G,T}` / red
|
|
26
|
+
`{A,C}`), e.g. an all-`G` or `G/T`-only cycle (red laser dark). Previously only
|
|
27
|
+
zero-diversity cycles were flagged.
|
|
28
|
+
- **Element AVITI is now modelled as its own `Chemistry.AVIDITY`** (per-base dye,
|
|
29
|
+
no laser-pair constraint), distinct from Illumina `FOUR_CHANNEL`;
|
|
30
|
+
`chemistry_for_instrument("AVITI")` now returns `Chemistry.AVIDITY`. AVITI low
|
|
31
|
+
diversity is an advisory (`COLOR_BALANCE_ADVISORY`), never a failure, in
|
|
32
|
+
`vendor_faithful` mode.
|
|
33
|
+
|
|
34
|
+
### Documentation
|
|
35
|
+
|
|
36
|
+
- Refreshed stale docs after the multi-vendor / color-balance release: updated
|
|
37
|
+
the README tagline, format-detection steps (now vendor-aware), and citation
|
|
38
|
+
block (DOI); documented the `chemistry` module, `ElementRunManifest`,
|
|
39
|
+
the `SampleSheetVersion.ELEMENT_AVITI` enum, the `validate(...)`
|
|
40
|
+
color-balance parameters, and the `--color-balance` / `--instrument` CLI flags
|
|
41
|
+
in the API and CLI references.
|
|
42
|
+
|
|
43
|
+
## [2.3.0] - 2026-06-15
|
|
44
|
+
|
|
45
|
+
### Added
|
|
46
|
+
|
|
47
|
+
- **Per-cycle color-balance validation (`samplesheet_parser.chemistry`).** Models
|
|
48
|
+
the optical detection chemistry of each instrument (4-channel, 2-channel,
|
|
49
|
+
1-channel) and scores an index pool cycle-by-cycle for signal balance. On
|
|
50
|
+
2-/1-channel chemistry (NextSeq, NovaSeq, NovaSeq X, iSeq), a cycle where the
|
|
51
|
+
whole pool reads the dark base `G` produces no optical signal and fails to
|
|
52
|
+
register; the validator now reports this as a `COLOR_BALANCE_NO_SIGNAL` error.
|
|
53
|
+
Four-channel instruments (MiSeq/HiSeq and Element AVITI, which images four
|
|
54
|
+
avidite dyes per cycle) have no dark base, so zero-diversity index cycles are
|
|
55
|
+
reported as `COLOR_BALANCE_LOW` warnings instead. The check is **opt-in** via
|
|
56
|
+
`SampleSheetValidator.validate(..., check_color_balance=True)` and the
|
|
57
|
+
`samplesheet validate --color-balance` CLI flag, and is skipped silently for
|
|
58
|
+
unknown instruments. New public API: `Chemistry`, `chemistry_for_instrument`,
|
|
59
|
+
`analyze_color_balance`, `ColorBalanceReport`.
|
|
60
|
+
- **Multi-vendor support: Element Biosciences AVITI.** `SampleSheetFactory` now
|
|
61
|
+
auto-detects Element AVITI `RunManifest.csv` files and parses them through a
|
|
62
|
+
new `ElementRunManifest` parser that satisfies the existing
|
|
63
|
+
`SampleSheetParser` protocol, mapping manifest columns to the shared sample
|
|
64
|
+
schema. The validator (including color balance, with AVITI modelled as a
|
|
65
|
+
four-channel platform), diff, and filter tooling work across vendors without
|
|
66
|
+
special-casing. New format enum value: `SampleSheetVersion.ELEMENT_AVITI`.
|
|
67
|
+
- New examples: `examples/demo_color_balance.py`,
|
|
68
|
+
`examples/demo_element_aviti.py`, and
|
|
69
|
+
`examples/sample_sheets/element_aviti_RunManifest.csv`.
|
|
70
|
+
|
|
13
71
|
## [2.2.0] - 2026-06-10
|
|
14
72
|
|
|
15
73
|
### Fixed
|
|
@@ -8,8 +8,8 @@ abstract: >
|
|
|
8
8
|
Provides format auto-detection, bidirectional V1/V2 conversion,
|
|
9
9
|
structural and index validation, sheet diffing, and cross-project
|
|
10
10
|
merging with Hamming-distance collision detection.
|
|
11
|
-
version: 2.
|
|
12
|
-
date-released: 2026-06-
|
|
11
|
+
version: 2.4.0
|
|
12
|
+
date-released: 2026-06-21
|
|
13
13
|
license: Apache-2.0
|
|
14
14
|
url: "https://github.com/chaitanyakasaraneni/samplesheet-parser"
|
|
15
15
|
repository-code: "https://github.com/chaitanyakasaraneni/samplesheet-parser"
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
+
and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
contact.ckasaraneni@gmail.com.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
+
the community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
119
|
+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
+
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
https://www.contributor-covenant.org/faq. Translations are available at
|
|
128
|
+
https://www.contributor-covenant.org/translations.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: samplesheet-parser
|
|
3
|
-
Version: 2.
|
|
4
|
-
Summary:
|
|
3
|
+
Version: 2.4.0
|
|
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
|
-
Project-URL: Documentation, https://
|
|
6
|
+
Project-URL: Documentation, https://samplesheet-parser.readthedocs.io
|
|
7
7
|
Project-URL: Repository, https://github.com/chaitanyakasaraneni/samplesheet-parser
|
|
8
8
|
Project-URL: Issues, https://github.com/chaitanyakasaraneni/samplesheet-parser/issues
|
|
9
9
|
Author-email: Chaitanya Kasaraneni <kc.kasaraneni@gmail.com>
|
|
@@ -27,7 +27,7 @@ License: Apache License
|
|
|
27
27
|
See the License for the specific language governing permissions and
|
|
28
28
|
limitations under the License.
|
|
29
29
|
License-File: LICENSE
|
|
30
|
-
Keywords: bcl2fastq,bclconvert,bioinformatics,demultiplexing,genomics,illumina,ngs,samplesheet,sequencing
|
|
30
|
+
Keywords: aviti,bcl2fastq,bclconvert,bioinformatics,color-balance,demultiplexing,element,genomics,illumina,multi-vendor,ngs,run-manifest,samplesheet,sequencing
|
|
31
31
|
Classifier: Development Status :: 5 - Production/Stable
|
|
32
32
|
Classifier: Intended Audience :: Developers
|
|
33
33
|
Classifier: Intended Audience :: Science/Research
|
|
@@ -56,9 +56,9 @@ Description-Content-Type: text/markdown
|
|
|
56
56
|
|
|
57
57
|
# samplesheet-parser
|
|
58
58
|
|
|
59
|
-
**
|
|
59
|
+
**Multi-vendor, format-agnostic parser for sequencing sample sheets.**
|
|
60
60
|
|
|
61
|
-
Supports both the classic IEM V1 format (bcl2fastq era) and the modern BCLConvert V2 format (NovaSeq X series) — with automatic format detection, bidirectional conversion, index validation, Hamming distance checking, diff comparison, multi-sheet merging, programmatic sheet creation, and a full-featured CLI.
|
|
61
|
+
Supports both the classic IEM V1 format (bcl2fastq era) and the modern BCLConvert V2 format (NovaSeq X series) — plus non-Illumina **Element AVITI** run manifests — with automatic format detection, bidirectional conversion, index validation, Hamming distance checking, **per-cycle color-balance validation** against the instrument's optical chemistry, diff comparison, multi-sheet merging, programmatic sheet creation, and a full-featured CLI.
|
|
62
62
|
|
|
63
63
|
[](https://pypi.org/project/samplesheet-parser/)
|
|
64
64
|
[](https://www.python.org/downloads/)
|
|
@@ -67,22 +67,22 @@ Supports both the classic IEM V1 format (bcl2fastq era) and the modern BCLConver
|
|
|
67
67
|
|
|
68
68
|
[](https://github.com/chaitanyakasaraneni/samplesheet-parser/actions)
|
|
69
69
|
[](https://codecov.io/gh/chaitanyakasaraneni/samplesheet-parser)
|
|
70
|
-
[](https://samplesheet-parser.readthedocs.io)
|
|
71
71
|
[](https://doi.org/10.5281/zenodo.18989694)
|
|
72
72
|
|
|
73
|
-
**Docs:** https://
|
|
73
|
+
**Docs:** https://samplesheet-parser.readthedocs.io/ | **PyPI:** https://pypi.org/project/samplesheet-parser/
|
|
74
74
|
|
|
75
|
-

|
|
76
76
|
|
|
77
|
-
*`SampleSheetFactory` auto-detects the format and routes to the correct parser.
|
|
77
|
+
*`SampleSheetFactory` auto-detects the format — Illumina V1/V2 or an Element AVITI run manifest — and routes to the correct parser. All formats share a common interface — `SampleSheetConverter` handles bidirectional conversion between the Illumina formats, `SampleSheetValidator` catches index, adapter, and color-balance issues, `SampleSheetDiff` compares two sheets across any combination of formats, `SampleSheetMerger` combines multiple per-project sheets into one, and `SampleSheetWriter` builds or edits sheets programmatically. The `samplesheet` CLI exposes all of this from the shell.*
|
|
78
78
|
|
|
79
79
|
---
|
|
80
80
|
|
|
81
81
|
## The problem this solves
|
|
82
82
|
|
|
83
|
-
Labs running mixed instrument fleets — older NovaSeq 6000 alongside newer NovaSeq X series — produce
|
|
83
|
+
Labs running mixed instrument fleets — older NovaSeq 6000 alongside newer NovaSeq X series, and increasingly non-Illumina platforms like the Element AVITI — produce several incompatible sample-sheet formats. BCLConvert V2 sheets use `[BCLConvert_Settings]` / `[BCLConvert_Data]` sections, `OverrideCycles` for UMI encoding, and `FileFormatVersion` in the header. IEM V1 sheets use `IEMFileVersion` and a flat `[Data]` section. Element AVITI ships a `RunManifest.csv` with an entirely different layout.
|
|
84
84
|
|
|
85
|
-
Existing tools either hard-code one format or require the caller to know which format they have. `samplesheet-parser` auto-detects the format, exposes a consistent interface for
|
|
85
|
+
Existing tools either hard-code one vendor's format or require the caller to know which format they have. `samplesheet-parser` auto-detects the format across vendors, exposes a consistent interface for all of them, converts between the Illumina formats, validates index integrity (including Hamming distance and per-cycle color balance against each instrument's optical chemistry), diffs sheets to catch accidental changes before a run starts, and writes new sheets programmatically — so you never have to hand-edit a CSV again.
|
|
86
86
|
|
|
87
87
|
---
|
|
88
88
|
|
|
@@ -110,7 +110,7 @@ from samplesheet_parser import SampleSheetFactory
|
|
|
110
110
|
factory = SampleSheetFactory()
|
|
111
111
|
sheet = factory.create_parser("SampleSheet.csv", parse=True)
|
|
112
112
|
|
|
113
|
-
print(factory.version) # SampleSheetVersion.V1 or .
|
|
113
|
+
print(factory.version) # SampleSheetVersion.V1, .V2, or .ELEMENT_AVITI
|
|
114
114
|
print(sheet.index_type()) # "dual", "single", or "none"
|
|
115
115
|
|
|
116
116
|
for sample in sheet.samples():
|
|
@@ -345,13 +345,14 @@ samplesheet merge ProjectA.csv ProjectB.csv --output combined.csv --format json
|
|
|
345
345
|
|
|
346
346
|
## Format detection logic
|
|
347
347
|
|
|
348
|
-
The factory
|
|
348
|
+
The factory detects the format across vendors — no format hints required from the caller:
|
|
349
349
|
|
|
350
|
-
1. **
|
|
351
|
-
2. **
|
|
352
|
-
3. **
|
|
350
|
+
1. **Vendor manifest check** — recognise a non-Illumina Element AVITI `RunManifest.csv` by its `[SAMPLES]` section combined with a `[RUNVALUES]` section or a `SampleName` column (→ `ELEMENT_AVITI`)
|
|
351
|
+
2. **Header discriminator** — scan `[Header]` for `FileFormatVersion` (→ V2) or `IEMFileVersion` (→ V1)
|
|
352
|
+
3. **Section name scan** — if no header key found, look for `[BCLConvert_Settings]` / `[BCLConvert_Data]` in the full file (→ V2)
|
|
353
|
+
4. **Default** — fall back to V1 (broadest compatibility with legacy files)
|
|
353
354
|
|
|
354
|
-
|
|
355
|
+
For Illumina sheets the detector reads only as much of the file as needed — stopping after `[Header]` in the common case.
|
|
355
356
|
|
|
356
357
|
---
|
|
357
358
|
|
|
@@ -368,6 +369,8 @@ The detector reads only as much of the file as needed — stopping after `[Heade
|
|
|
368
369
|
| `INDEX_DISTANCE_TOO_LOW` | warning | Two indexes in the same lane have Hamming distance < 3, risking demultiplexing bleed-through |
|
|
369
370
|
| `NO_ADAPTERS` | warning | No adapter sequences configured |
|
|
370
371
|
| `ADAPTER_MISMATCH` | warning | Adapter is non-standard |
|
|
372
|
+
| `COLOR_BALANCE_NO_SIGNAL` | error | An index cycle has no signal in an optical channel (2-/1-channel chemistry) — the index read will fail. *Opt-in.* |
|
|
373
|
+
| `COLOR_BALANCE_LOW` | warning | An index cycle has weak signal in a channel, or no base diversity (4-channel) — degraded base calls. *Opt-in.* |
|
|
371
374
|
|
|
372
375
|
### Index distance checking
|
|
373
376
|
|
|
@@ -397,6 +400,111 @@ result = ValidationResult()
|
|
|
397
400
|
SampleSheetValidator()._check_index_distances(samples, result, min_distance=4)
|
|
398
401
|
```
|
|
399
402
|
|
|
403
|
+
### Color-balance checking (opt-in)
|
|
404
|
+
|
|
405
|
+
On 2-channel instruments (NextSeq, NovaSeq, NovaSeq X) and 1-channel
|
|
406
|
+
instruments (iSeq), bases are called from optical signal: `A` lights
|
|
407
|
+
both channels, `C` only red, `T` only green, and **`G` is a dark base with no
|
|
408
|
+
signal at all**. A cycle where the whole index pool reads `G` produces no
|
|
409
|
+
signal, so the instrument cannot register the tile and the index read fails —
|
|
410
|
+
a real, common cause of wrecked runs that a Hamming-distance check cannot see.
|
|
411
|
+
|
|
412
|
+
Because the sample sheet already contains every sample's index, this can be
|
|
413
|
+
predicted *before the run starts* with no sequencing data. The validator scores
|
|
414
|
+
the pool cycle-by-cycle against the instrument's chemistry, with the exact rule
|
|
415
|
+
depending on the chemistry and the selected mode (see below).
|
|
416
|
+
|
|
417
|
+
```python
|
|
418
|
+
from samplesheet_parser import SampleSheetFactory, SampleSheetValidator
|
|
419
|
+
|
|
420
|
+
sheet = SampleSheetFactory().create_parser("SampleSheet.csv", parse=True)
|
|
421
|
+
|
|
422
|
+
# Opt in; the instrument is read from the sheet header (or pass instrument=...)
|
|
423
|
+
result = SampleSheetValidator().validate(sheet, check_color_balance=True)
|
|
424
|
+
|
|
425
|
+
for err in result.errors:
|
|
426
|
+
print(err)
|
|
427
|
+
# [ERROR] COLOR_BALANCE_NO_SIGNAL: On 2-channel chemistry (NovaSeqXSeries),
|
|
428
|
+
# index1 cycle 4 has no red or green signal across the pool: no sample
|
|
429
|
+
# carries a red or green base (A/C/T) at this cycle ... the index read will fail.
|
|
430
|
+
```
|
|
431
|
+
|
|
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 is skipped silently
|
|
434
|
+
for unknown instruments. The same analysis is available standalone:
|
|
435
|
+
|
|
436
|
+
```python
|
|
437
|
+
from samplesheet_parser import analyze_color_balance, chemistry_for_instrument
|
|
438
|
+
|
|
439
|
+
chem = chemistry_for_instrument("NovaSeqXSeries") # Chemistry.TWO_CHANNEL
|
|
440
|
+
report = analyze_color_balance(["ATGGCTAC", "CAGGTACG", "TCGGACGT", "GATGGCTA"],
|
|
441
|
+
chemistry=chem)
|
|
442
|
+
for cb in report.dark_cycles:
|
|
443
|
+
print(cb.read, cb.cycle, cb.base_counts) # index1 4 {'G': 4}
|
|
444
|
+
```
|
|
445
|
+
|
|
446
|
+
From the CLI:
|
|
447
|
+
|
|
448
|
+
```bash
|
|
449
|
+
samplesheet validate SampleSheet.csv --color-balance
|
|
450
|
+
samplesheet validate SampleSheet.csv --color-balance --instrument NovaSeqXSeries
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
#### Modes: `vendor_faithful` (default) and `conservative`
|
|
454
|
+
|
|
455
|
+
Color balance has two modes, selectable via
|
|
456
|
+
`validate(..., color_balance_mode=...)` or `analyze_color_balance(..., mode=...)`:
|
|
457
|
+
|
|
458
|
+
- **`vendor_faithful`** (default) encodes each platform's *published* rule
|
|
459
|
+
exactly — Illumina's "signal in at least one channel" minimum for 2-channel,
|
|
460
|
+
the both-lasers rule for 4-channel, and Element's permissive low-diversity
|
|
461
|
+
stance for AVITI.
|
|
462
|
+
- **`conservative`** is stricter than the published minimum: it also fails
|
|
463
|
+
single-channel 2-channel cycles and AVITI low-diversity cycles. (This was the
|
|
464
|
+
behavior before modes existed — pass `color_balance_mode="conservative"` to
|
|
465
|
+
keep it.)
|
|
466
|
+
|
|
467
|
+
| Chemistry | Instruments | Failure rule (both modes) | Stricter in `conservative` |
|
|
468
|
+
|---|---|---|---|
|
|
469
|
+
| 4-channel | MiSeq, HiSeq 2000/2500/3000/4000 | a green `{G,T}` or red `{A,C}` laser is entirely absent | — |
|
|
470
|
+
| 2-channel | NextSeq, NovaSeq 6000, NovaSeq X, MiniSeq | all-`G` cycle (no signal either channel) | single-channel cycle also fails |
|
|
471
|
+
| 1-channel | iSeq 100 | all-`G` cycle | single-channel cycle also fails |
|
|
472
|
+
| avidity | Element AVITI | (no dark/laser failure) | low-diversity cycle fails |
|
|
473
|
+
|
|
474
|
+
Element AVITI uses avidity chemistry — each base has its own avidite dye
|
|
475
|
+
([Arslan et al., *Nat. Biotechnol.* 2023](https://www.nature.com/articles/s41587-023-01750-7))
|
|
476
|
+
— so it has no dark base and no laser-pair constraint. In `vendor_faithful`
|
|
477
|
+
mode, AVITI low diversity in the first cycles is an advisory
|
|
478
|
+
(`COLOR_BALANCE_ADVISORY`), never a failure.
|
|
479
|
+
|
|
480
|
+
---
|
|
481
|
+
|
|
482
|
+
## Multi-vendor support
|
|
483
|
+
|
|
484
|
+
The factory is not limited to Illumina. Any parser that implements the
|
|
485
|
+
`SampleSheetParser` protocol can be auto-detected, and **Element Biosciences
|
|
486
|
+
AVITI `RunManifest.csv`** files are supported out of the box — the same
|
|
487
|
+
`SampleSheetFactory` recognises them and returns a parser with the identical
|
|
488
|
+
interface:
|
|
489
|
+
|
|
490
|
+
```python
|
|
491
|
+
from samplesheet_parser import SampleSheetFactory
|
|
492
|
+
|
|
493
|
+
factory = SampleSheetFactory()
|
|
494
|
+
sheet = factory.create_parser("RunManifest.csv", parse=True)
|
|
495
|
+
|
|
496
|
+
print(factory.version) # SampleSheetVersion.ELEMENT_AVITI
|
|
497
|
+
print(sheet.index_type()) # "dual"
|
|
498
|
+
for s in sheet.samples(): # same schema as Illumina: sample_id, index, index2, ...
|
|
499
|
+
print(s["sample_id"], s["index"], s["index2"])
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
AVITI is a four-channel avidity platform, so color-balance validation applies
|
|
503
|
+
to it too (flagging low-diversity index cycles). Manifest columns
|
|
504
|
+
(`SampleName`, `Index1`, `Index2`, `Lane`, `Project`, `ExternalID`) are mapped
|
|
505
|
+
to the shared sample schema, so the validator, diff, and filter tooling work
|
|
506
|
+
across vendors without special-casing.
|
|
507
|
+
|
|
400
508
|
---
|
|
401
509
|
|
|
402
510
|
## Merger conflict and warning codes
|
|
@@ -694,14 +802,17 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for the full local testing guide and PR c
|
|
|
694
802
|
|
|
695
803
|
```bibtex
|
|
696
804
|
@software{kasaraneni2026samplesheetparser,
|
|
697
|
-
author = {Kasaraneni, Chaitanya},
|
|
698
|
-
title = {samplesheet-parser:
|
|
805
|
+
author = {Kasaraneni, Chaitanya Krishna},
|
|
806
|
+
title = {samplesheet-parser: A multi-vendor parser, validator, and converter for sequencing sample sheets},
|
|
699
807
|
year = {2026},
|
|
700
808
|
url = {https://github.com/chaitanyakasaraneni/samplesheet-parser},
|
|
701
|
-
|
|
809
|
+
doi = {10.5281/zenodo.18989694},
|
|
810
|
+
version = {2.4.0}
|
|
702
811
|
}
|
|
703
812
|
```
|
|
704
813
|
|
|
814
|
+
See [`CITATION.cff`](CITATION.cff) for machine-readable citation metadata.
|
|
815
|
+
|
|
705
816
|
---
|
|
706
817
|
|
|
707
818
|
## License
|