aws-samples / aws-samples/aws-healthomics-tutorials
create_parameter_json_from_nfcore_schema.py - issue
- Dominant language
- Python
- Stars
- 94
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Firstly, thank you for the useful script.
[create_parameter_json_from_nfcore_schema.py](https://github.com/aws-samples/amazon-omics-tutorials/blob/main/utils/scripts/create_parameter_json_from_nfcore_schema.py)
Using this script with the latest version of the schema in nf-core/sarek creates requirements that currently prevent registration with AWS HealthOmics.
https://github.com/nf-core/sarek/blob/3.4.2/nextflow_schema.json
The following specifications are currently not allowed in AWS HealthOmics. So it seems like we need something to either check this as an error or guide us to fix it.
- Long sentence
- Special characters
---
> $ aws omics create-workflow --name sarek --definition-uri s3://{bucket}/workflow.zip --parameter-template file://nextflow-sarek-parameter.json --engine NEXTFLOW
>
> An error occurred (ValidationException) when calling the CreateWorkflow operation: 4 validation errors detected: Value 'Runs Mutect2 in joint (multi-sample) mode for better concordance among variant calls of tumor samples from the same patient. Mutect2 outputs will be stored in a subfolder named with patient ID under `variant_calling/mutect2/` folder. Only a single normal sample per patient is allowed. Tumor-only mode is also supported.' at 'parameterTemplate.joint_mutect2.member.description' failed to satisfy constraint: Member must have length less than or equal to 256; Value 'If you use AWS iGenomes, this has already been set for you appropriately.
>
> 1st label string for VariantRecalibration (haplotypecaller joint variant calling)' at 'parameterTemplate.known_indels_vqsr.member.description' failed to satisfy constraint: Member must satisfy regular expression pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+; Value 'If you use AWS iGenomes, this has already been set for you appropriately.
>
> label string for VariantRecalibration (haplotypecaller joint variant calling)' at 'parameterTemplate.known_snps_vqsr.member.description' failed to satisfy constraint: Member must satisfy regular expression pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+; Value 'If you use AWS iGenomes, this has already been set for you appropriately.
>
> Path to known snps file.' at 'parameterTemplate.known_snps.member.description' failed to satisfy constraint: Member must satisfy regular expression pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
Contributor guide
Research direction
Start with utils/scripts/create_parameter_json_from_nfcore_schema.py and compare its output for nf-core/sarek 3.4.2 with the AWS HealthOmics create-workflow validation errors. Check how descriptions are transformed, then verify that the generated nextflow-sarek-parameter.json satisfies the reported length and character constraints when used with the shown AWS CLI command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, python
- Domain
- cloud, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100