V2 SampleSheet Maker
Generate an Illumina SampleSheet CSV from JSON.
Supported Sections
Sections currently supported:
- Header
- Reads
- BCLConvert_Settings
- BCLConvert_Data
Installation
Installation from pypi
pip install v2-samplesheet-maker
Alternatively one may use the docker container ghcr.io/umccr/v2-samplesheet-maker:latest
Usage
Usage:
v2-samplesheet-maker <input-json> <output-csv>
Use - for input-json parameter to parse json from stdin,
Use - for output-json parameter to parse output samplesheet csv to stdout.
Examples
See examples/ for more info
Input JSON
Click to expand!
{
"header": {
"file_format_version": 2,
"run_name": "my-illumina-sequencing-run",
"run_description": "A test run",
"instrument_platform": "NovaSeq 6000",
"instrument_type": "NovaSeq"
},
"reads": {
"read_1_cycles": 151,
"read_2_cycles": 151,
"index_1_cycles": 10,
"index_2_cycles": 10
},
"bclconvert_settings": {
"adapter_behavior": "trim",
"adapter_read_1": null,
"adapter_read_2": null,
"adapter_stringency": null,
"barcode_mismatches_index_1": 1,
"barcode_mismatches_index_2": 1,
"minimum_trimmed_read_length": null,
"minimum_adapter_overlap": 2,
"mask_short_reads": null,
"override_cycles": "Y151;Y10;Y8N2;Y151",
"trim_umi": null,
"create_fastq_for_index_reads": false,
"no_lane_splitting": false,
"fastq_compression_format": "gzip",
"find_adapters_with_indels": null,
"independent_index_collision_check": null
},
"bclconvert_data": [
{
"sample_id": "MyFirstSample",
"lane": 1,
"index": "AAAAAAAAAA",
"index2": "CCCCCCCC",
"sample_project": "SampleProject",
"sample_name": null
},
{
"sample_id": "MySecondSample",
"lane": 1,
"index": "GGGGGGGGGG",
"index2": "TTTTTTTT",
"sample_project": "SampleProject",
"sample_name": null
}
]
}
Output CSV
Click to expand!
[Header]
FileFormatVersion,2
RunName,my-illumina-sequencing-run
RunDescription,A test run
InstrumentPlatform,NovaSeq 6000
InstrumentType,NovaSeq
[Reads]
Read1Cycles,151
Read2Cycles,151
Index1Cycles,10
Index2Cycles,10
[BCLConvert_Settings]
AdapterBehavior,trim
BarcodeMismatchesIndex1,1
BarcodeMismatchesIndex2,1
MinimumAdapterOverlap,2
OverrideCycles,Y151;Y10;Y8N2;Y151
CreateFastqForIndexReads,False
NoLaneSplitting,False
FastqCompressionFormat,gzip
[BCLConvert_Data]
Lane,Sample_ID,index,index2,Sample_Project
1,MyFirstSample,AAAAAAAAAA,CCCCCCCC,SampleProject
1,MySecondSample,GGGGGGGGGG,TTTTTTTT,SampleProject
Testing your outputs
The v2-samplesheet-maker will validate that your parameters are the correct type, the correct name AND within the appropriate range. It will NOT however determine if your settings are appropriate or compatible with a BCLConvert run, i.e it will NOT ensure that your indexes have an appropriate hamming distance.
If you wish to validate your output samplesheet with BCLConvert, you can use the following script -
scripts/build-samplesheet-and-validate-with-bcl-convert.sh <input-json> [docker-image]. This will convert the input json to csv and then run the
docker container bclconvert against your samplesheet.
You will need both jq and docker installed for this to work.
Contributing
Is there a missing section you'd like to see?
You can generate your own sections by
- Forking this repository.
- Adding the section pydantic model to the section models module
- Extending the SampleSheel pydantic model in the samplesheet models module
- Generating a class for your section in the section class module
- Extending the SampleSheet class to write out your section in the samplesheet class module
- Add a test for your section in the test_sections module
- Generating a PR back to this repository! ( Please squash your commits :) )
Release Cycles
We try and update this repository for every new Dragen Release (which coincides with a BCLConvert release) and tag accordingly.
Metadata
Release files for v2-samplesheet-maker 4.2.4.post20240205170611
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| v2_samplesheet_maker-4.2.4.post20240205170611.tar.gz | 21.6 kB | Without provenance | Details for v2_samplesheet_maker-4.2.4.post20240205170611.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| v2_samplesheet_maker-4.2.4.post20240205170611-py3-none-any.whl | Python 3 | none | any | Details for v2_samplesheet_maker-4.2.4.post20240205170611-py3-none-any.whl |
Total release size: 50.6 kB
Release files / v2_samplesheet_maker-4.2.4.post20240205170611.tar.gz
| Download URL | v2_samplesheet_maker-4.2.4.post20240205170611.tar.gz |
|---|---|
| Size | 21.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5238ce505f4db180ece8bfc428f94ec615d95685ca45e84671ec1ac38963432b
|
|
BLAKE2b-256 checksum How to use checksums |
f38a6c6f72faa60abf6085b023acf770a6c5df853efdae3e8f21113bc28e0271
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / v2_samplesheet_maker-4.2.4.post20240205170611-py3-none-any.whl
| Download URL | v2_samplesheet_maker-4.2.4.post20240205170611-py3-none-any.whl |
|---|---|
| Size | 29.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
77e5fd7873e9ad8f3786a6fc8775df5afa0043188802d30a180efec32752d7f5
|
|
BLAKE2b-256 checksum How to use checksums |
6da4c731033e7a89b6925cdf35c7713f13925fbb2e2db705f6a248c0a9e62994
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for v2-samplesheet-maker 4.2.4.post20240205170611
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.