Releases: umccr/cwl-ica
Releases · umccr/cwl-ica
dragen-instrument-run-fastq-to-ora-pipeline/4.2.4__20241115064819
Overview
MD5Sum: d292da07e5425d9879ba869ab58ff316
Documentation
This tool can be used for archiving purposes by first compressing fastqs prior to transfer to a long-term storage location.
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: ora_instrument_run_compression_pipeline_with_reference__4_2_4__20241115064819 / Bundle Version v2__20241115064819
Description
This bundle has been generated by the release of workflows/dragen-instrument-run-fastq-to-ora-pipeline/4.2.4/dragen-instrument-run-fastq-to-ora-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-instrument-run-fastq-to-ora-pipeline/4.2.4__20241115064819.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v2
Bundle ID: 0525e2ef-1cc5-4821-a6c2-e5240d5b82c1
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 38728164-d932-431e-a015-80c019f814f2
Pipeline Code: dragen-instrument-run-fastq-to-ora-pipeline__4_2_4__20241115064819
Projects
- development
- staging
- production
Datasets
- ora_reference_v2
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-instrument-run-fastq-to-ora-pipeline%2F4.2.4__20241115064819/dragen-instrument-run-fastq-to-ora-pipeline__4.2.4__20241115064819.schema.json
# instrument run directory (Required)
# Docs: The directory containing the instrument run. Expected to be in the BCLConvert 4.2.7 output format, with the following structure:
# Reports/
# InterOp/
# Logs/
# Samples/
# Samples/Lane_1/
# Samples/Lane_1/Sample_ID/
# Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R1_001.fastq.gz
# Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R2_001.fastq.gz
# etc...
instrument_run_directory:
class: Directory
location: icav2://project_id/path/to/dir/
# ora check file integrity (Optional)
# Default value: False
# Docs: Set to true to perform and output result of FASTQ file and decompressed FASTQ.ORA integrity check. The default value is false.
ora_check_file_integrity: false
# ora parallel files (Optional)
# Default value: 2
# Docs: The number of files to compress in parallel. If using an FPGA medium instance in the
# run_dragen_instrument_run_fastq_to_ora_step this should be set to 16 / ora_threads_per_file.
ora_parallel_files: 2
# ora print file info (Optional)
# Default value: False
# Docs: Prints file information summary of ORA compressed files.
ora_print_file_info: false
# ora reference (Required)
# Docs: The reference tar to use for the ORA compression
ora_reference:
class: File
location: icav2://project_id/path/to/file
# ora threads per file (Optional)
# Default value: 8
# Docs: The number of threads to use per file. If using an FPGA medium instance in the
# run_dragen_instrument_run_fastq_to_ora_step this should be set to 4 since there are only 16 cores available
ora_threads_per_file: 8
# sample id list (Optional)
# Docs: Optional list of samples to process.
# Samples NOT in this list are NOT compressed AND NOT transferred to the final output directory!
sample_id_list:
- string
Json
Click to expand!
{
"instrument_run_directory": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
},
"ora_check_file_integrity": false,
"ora_parallel_files": 2,
"ora_print_file_info": false,
"ora_reference": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"ora_threads_per_file": 8,
"sample_id_list": [
"string"
]
}
Outputs Template
Click to expand!
{
"output_directory": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
}
}
Overrides Template
Zipped workflow
Click to expand!
[
"workflow.cwl#dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/run_dragen_instrument_run_fastq_to_ora_step"
]
Packed workflow
Click to expand!
[
"#main/run_dragen_instrument_run_fastq_to_ora_step"
]
Inputs
Click to expand!
instrument run directory
ID: instrument_run_directory
Optional: False
Type: Directory
Docs:
The directory containing the instrument run. Expected to be in the BCLConvert 4.2.7 output format, with the following structure:
Reports/
InterOp/
Logs/
Samples/
Samples/Lane_1/
Samples/Lane_1/Sample_ID/
Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R1_001.fastq.gz
Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R2_001.fastq.gz
etc...
ora check file integrity
ID: ora_check_file_integrity
Optional: False
Type: boolean
Docs:
Set to true to perform and output result of FASTQ file and decompressed FASTQ.ORA integrity check. The default value is false.
ora parallel files
ID: ora_parallel_files
Optional: True
Type: int
Docs:
The number of files to compress in parallel. If using an FPGA medium instance in the
run_dragen_instrument_run_fastq_to_ora_step this should be set to 16 / ora_threads_per_file.
ora print file info
ID: ora_print_file_info
Optional: False
Type: boolean
Docs:
Prints file information summary of ORA compressed files.
ora reference
ID: ora_reference
Optional: False
Type: File
Docs:
The reference tar to use for the ORA compression
ora threads per file
ID: ora_threads_per_file
Optional: True
Type: int
Docs:
The number of threads to use per file. If using an FPGA medium instance in the
run_dragen_instrument_run_fastq_to_ora_step this should be set to 4 since there are only 16 cores available
sample id list
ID: sample_id_list
Optional: True
Type: .[]
Docs:
Optional list of samples to process.
Samples NOT in this list are NOT compressed AND NOT transferred to the final output directory!
Steps
Click to expand!
Run Dragen Instrument Run Fastq to ORA
ID: dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/run_dragen_instrument_run_fastq_to_ora_step
Step Type: tool
Docs:
Run the dragen instrument run fastq to ora tool
Outputs
Click to expand!
output directory
ID: dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/output_directory
Optional: False
Output Type: Directory
Docs:
The output directory of the instrument run with fastqs converted to oras
dragen-instrument-run-fastq-to-ora-pipeline/4.2.4__20241115044412
Overview
MD5Sum: 9df445c3fdd3b101f1061ae0a29d7fa0
Documentation
This tool can be used for archiving purposes by first compressing fastqs prior to transfer to a long-term storage location.
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: ora_instrument_run_compression_pipeline_with_reference__4_2_4__20241115044412 / Bundle Version v2__20241115044412
Description
This bundle has been generated by the release of workflows/dragen-instrument-run-fastq-to-ora-pipeline/4.2.4/dragen-instrument-run-fastq-to-ora-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-instrument-run-fastq-to-ora-pipeline/4.2.4__20241115044412.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v2
Bundle ID: 9fb2017a-bb15-4551-8209-a41e436bf808
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 456a1e54-acc7-44bd-a516-b1eb4e91e955
Pipeline Code: dragen-instrument-run-fastq-to-ora-pipeline__4_2_4__20241115044412
Projects
- development
- staging
- production
Datasets
- ora_reference_v2
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-instrument-run-fastq-to-ora-pipeline%2F4.2.4__20241115044412/dragen-instrument-run-fastq-to-ora-pipeline__4.2.4__20241115044412.schema.json
# instrument run directory (Required)
# Docs: The directory containing the instrument run. Expected to be in the BCLConvert 4.2.7 output format, with the following structure:
# Reports/
# InterOp/
# Logs/
# Samples/
# Samples/Lane_1/
# Samples/Lane_1/Sample_ID/
# Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R1_001.fastq.gz
# Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R2_001.fastq.gz
# etc...
instrument_run_directory:
class: Directory
location: icav2://project_id/path/to/dir/
# ora check file integrity (Optional)
# Default value: False
# Docs: Set to true to perform and output result of FASTQ file and decompressed FASTQ.ORA integrity check. The default value is false.
ora_check_file_integrity: false
# ora parallel files (Optional)
# Default value: 2
# Docs: The number of files to compress in parallel. If using an FPGA medium instance in the
# run_dragen_instrument_run_fastq_to_ora_step this should be set to 16 / ora_threads_per_file.
ora_parallel_files: 2
# ora print file info (Optional)
# Default value: False
# Docs: Prints file information summary of ORA compressed files.
ora_print_file_info: false
# ora reference (Required)
# Docs: The reference tar to use for the ORA compression
ora_reference:
class: File
location: icav2://project_id/path/to/file
# ora threads per file (Optional)
# Default value: 8
# Docs: The number of threads to use per file. If using an FPGA medium instance in the
# run_dragen_instrument_run_fastq_to_ora_step this should be set to 4 since there are only 16 cores available
ora_threads_per_file: 8
# sample id list (Optional)
# Docs: Optional list of samples to process.
# Samples NOT in this list are NOT compressed AND NOT transferred to the final output directory!
sample_id_list:
- string
Json
Click to expand!
{
"instrument_run_directory": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
},
"ora_check_file_integrity": false,
"ora_parallel_files": 2,
"ora_print_file_info": false,
"ora_reference": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"ora_threads_per_file": 8,
"sample_id_list": [
"string"
]
}
Outputs Template
Click to expand!
{
"output_directory": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
}
}
Overrides Template
Zipped workflow
Click to expand!
[
"workflow.cwl#dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/run_dragen_instrument_run_fastq_to_ora_step"
]
Packed workflow
Click to expand!
[
"#main/run_dragen_instrument_run_fastq_to_ora_step"
]
Inputs
Click to expand!
instrument run directory
ID: instrument_run_directory
Optional: False
Type: Directory
Docs:
The directory containing the instrument run. Expected to be in the BCLConvert 4.2.7 output format, with the following structure:
Reports/
InterOp/
Logs/
Samples/
Samples/Lane_1/
Samples/Lane_1/Sample_ID/
Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R1_001.fastq.gz
Samples/Lane_1/Sample_ID/Sample_ID_S1_L001_R2_001.fastq.gz
etc...
ora check file integrity
ID: ora_check_file_integrity
Optional: False
Type: boolean
Docs:
Set to true to perform and output result of FASTQ file and decompressed FASTQ.ORA integrity check. The default value is false.
ora parallel files
ID: ora_parallel_files
Optional: True
Type: int
Docs:
The number of files to compress in parallel. If using an FPGA medium instance in the
run_dragen_instrument_run_fastq_to_ora_step this should be set to 16 / ora_threads_per_file.
ora print file info
ID: ora_print_file_info
Optional: False
Type: boolean
Docs:
Prints file information summary of ORA compressed files.
ora reference
ID: ora_reference
Optional: False
Type: File
Docs:
The reference tar to use for the ORA compression
ora threads per file
ID: ora_threads_per_file
Optional: True
Type: int
Docs:
The number of threads to use per file. If using an FPGA medium instance in the
run_dragen_instrument_run_fastq_to_ora_step this should be set to 4 since there are only 16 cores available
sample id list
ID: sample_id_list
Optional: True
Type: .[]
Docs:
Optional list of samples to process.
Samples NOT in this list are NOT compressed AND NOT transferred to the final output directory!
Steps
Click to expand!
Run Dragen Instrument Run Fastq to ORA
ID: dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/run_dragen_instrument_run_fastq_to_ora_step
Step Type: tool
Docs:
Run the dragen instrument run fastq to ora tool
Outputs
Click to expand!
output directory
ID: dragen-instrument-run-fastq-to-ora-pipeline--4.2.4/output_directory
Optional: False
Output Type: Directory
Docs:
The output directory of the instrument run with fastqs converted to oras
dragen-somatic-with-germline-pipeline/4.2.4__20241114110541
Overview
MD5Sum: a4bb1e0adbb53a10308b11c87cfe2f27
Documentation
Documentation for dragen-somatic-with-germline-pipeline
v4.2.4
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_somatic_with_germline_pipeline_with_validation_data__4_2_4__20241114110541 / Bundle Version v9_r3__20241114110541
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.2.4/dragen-somatic-with-germline-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.2.4__20241114110541.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v9_r3
Bundle ID: bf46d893-2084-4cf9-bd34-363790bfa827
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 988af91b-d707-49ed-9107-8994f75cef12
Pipeline Code: dragen-somatic-with-germline-pipeline__4_2_4__20241114110541
Projects
- development
- staging
Datasets
- dragen_hash_table_hg38_alt_masked_v9_r3_linear_cnv_hla_rna
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
- ora_reference_v2
Bundle Name: dragen_somatic_with_germline_pipeline_prod__4_2_4__20241114110541 / Bundle Version v9_r3__20241114110541
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.2.4/dragen-somatic-with-germline-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.2.4__20241114110541.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v9_r3
Bundle ID: f37b2451-f65a-4127-9f5d-29b5c9433a8d
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 988af91b-d707-49ed-9107-8994f75cef12
Pipeline Code: dragen-somatic-with-germline-pipeline__4_2_4__20241114110541
Projects
- production
Datasets
- dragen_hash_table_hg38_alt_masked_v9_r3_linear_cnv_hla_rna
- ora_reference_v2
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-somatic-with-germline-pipeline%2F4.2.4__20241114110541/dragen-somatic-with-germline-pipeline__4.2.4__20241114110541.schema.json
# bam input (Optional)
# Docs: Input a normal BAM file for the variant calling stage
bam_input:
class: File
location: icav2://project_id/path/to/file
# cnv enable self normalization (Optional)
# Docs: Enable CNV self normalization.
# Self Normalization requires that the DRAGEN hash table be generated with the enable-cnv=true option.
cnv_enable_self_normalization: false
# cnv normal b allele vcf (Optional)
# Docs: Specify a matched normal SNV VCF.
cnv_normal_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv normal cnv vcf (Optional)
# Docs: Specify germline CNVs from the matched normal sample.
cnv_normal_cnv_vcf: false
# cnv population b allele vcf (Optional)
# Docs: Specify a population SNP catalog.
cnv_population_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv somatic enable het calling (Optional)
# Docs: Enable HET-calling mode for heterogeneous segments.
cnv_somatic_enable_het_calling: false
# cnv somatic enable lower ploidy limit (Optional)
# Docs: To improve accuracy on the tumor ploidy model estimation, the somatic WGS CNV caller estimates whether the chosen model calls
# homozygous deletions on regions that are likely to reduce the overall fitness of cells,
# which are therefore deemed to be "essential" and under negative selection.
# In the current literature, recent efforts tried to map such cell-essential genes (eg, in 2015 - https://www.science.org/doi/10.1126/science.aac7041).
# The check on essential regions is controlled with --cnv-somatic-enable-lower-ploidy-limit (default true).
cnv_somatic_enable_lower_ploidy_limit: false
# cnv somatic essential genes bed (Optional)
# Docs: Default bedfiles describing the essential regions are provided for hg19, GRCh37, hs37d5, GRCh38,
# but a custom bedfile can also be provided in input through the
# --cnv-somatic-essential-genes-bed=<BEDFILE_PATH> parameter.
# In such case, the feature is automatically enabled.
# A custom essential regions bedfile needs to have the following format: 4-column, tab-separated,
# where the first 3 columns identify the coordinates of the essential region (chromosome, 0-based start, excluded end).
# The fourth column is the region id (string type). For the purpose of the algorithm, currently only the first 3 columns are used.
# However, the fourth might be helpful to investigate manually which regions drove the decisions on model plausibility made by the caller.
cnv_somatic_essential_genes_bed: string
# cnv use somatic vc baf (Optional)
# Docs: If running in tumor-normal mode with the SNV caller enabled, use this option
# to specify the germline heterozygous sites.
cnv_use_somatic_vc_baf: false
# cnv use somatic vc vaf (Optional)
# Docs: Use the variant allele frequencies (VAFs) from the somatic SNVs to help select
# the tumor model for the sample.
cnv_use_somatic_vc_vaf: false
# cram input (Optional)
# Docs: Input a normal CRAM file for the variant calling stage
cram_input:
class: File
location: icav2://project_id/path/to/file
# cram reference (Optional)
# Docs: Path to the reference fasta file for the CRAM input.
# Required only if the input is a cram file AND not the reference in the tarball
cram_reference:
class: File
location: icav2://project_id/path/to/file
# dbsnp annotation (Optional)
# Docs: In Germline, Tumor-Normal somatic, or Tumor-Only somatic modes,
# DRAGEN can look up variant calls in a dbSNP database and add annotations for any matches that it finds there.
# To enable the dbSNP database search, set the --dbsnp option to the full path to the dbSNP database
# VCF or .vcf.gz file, which must be sorted in reference order.
dbsnp_annotation:
class: File
location: icav2://project_id/path/to/file
# deduplicate minimum quality (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual: string
# deduplicate minimum quality germline (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_germline: string
# deduplicate minimum quality somatic (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_somatic: string
# enable cnv calling (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software.
enable_cnv: false
# enable cnv germline (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (somatic only)
enable_cnv_germline: false
# enable cnv somatic (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (germline only)
enable_cnv_somatic: false
# enable duplicate marking (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking: false
# enable duplicate marking germline (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_germline: false
# enable duplicate marking somatic (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_somatic: false
# enable hla (Optional)
# Docs: Enable HLA typing by setting --enable-hla flag to true
enable_hla: false
# enable hrd (Optional)
# Docs: Set to true to enable HRD scoring to quantify genomic instability.
# Requires somatic CNV calls.
enable_hrd: false
# enable map align (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align: false
# enable map align germline (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align_germline: false
# enable map align output (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# running map/align. Default is false if
# running the variant caller.
enable_map_align_output: false
# enable map align output germline (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# running map/align. Default is false if
# running the variant caller.
enable_map_align_output_germline: false
#...
rnasum-pipeline/1.1.5__20241112044604
Overview
MD5Sum: 7fec44c37ab6d7f991a40c3a02925e6a
Documentation
Documentation for rnasum-pipeline v1.1.5
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: rnasum_prod__1_1_5__20241112044604 / Bundle Version 1.0.0__20241112044604
Description
This bundle has been generated by the release of workflows/rnasum-pipeline/1.1.5/rnasum-pipeline__1.1.5.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/rnasum-pipeline/1.1.5__20241112044604.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is 1.0.0
Bundle ID: 83a8ff6f-405a-4068-b22d-a22e1cad63e3
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: c412a2ee-5a92-465d-b619-7516da56b9bf
Pipeline Code: rnasum-pipeline__1_1_5__20241112044604
Projects
- development
- staging
- production
Datasets
- rnasum_1_0_0
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/rnasum-pipeline%2F1.1.5__20241112044604/rnasum-pipeline__1.1.5__20241112044604.schema.json
# arriba directory (Optional)
# Docs: Location of the arriba outputs directory
arriba_dir:
class: Directory
location: icav2://project_id/path/to/dir/
# arriba pdf (Optional)
# Docs: Location of the pdf output from arriba
arriba_pdf:
class: File
location: icav2://project_id/path/to/file
# arriba tsv (Optional)
# Docs: Location of the tsv output from arriba
arriba_tsv:
class: File
location: icav2://project_id/path/to/file
# batch rm (Optional)
# Default value: True
# Docs: Remove batch-associated effects between datasets. Available options are: "TRUE" (default) and "FALSE"
batch_rm: true
# cn gain (Optional)
# Default value: 95
# Docs: CN threshold value to classify genes within gained regions.
cn_gain: 95
# cn loss (Optional)
# Default value: 5
# Docs: CN threshold value to classify genes within lost regions.
cn_loss: 5
# dataset (Optional)
# Default value: PANCAN
# Docs: Reference dataset selection from https://github.com/umccr/RNAsum/blob/master/TCGA_projects_summary.md
dataset: "PANCAN"
# dataset name incl (Optional)
# Docs: Include dataset in the report and sample name.
dataset_name_incl: false
# dragen fusions (Optional)
# Docs: Location of the fusion output from Dragen RNA-seq pipeline
dragen_fusions:
class: File
location: icav2://project_id/path/to/file
# dragen mapping metrics (Optional)
# Docs: Location of the mapping metrics from Dragen RNA-seq pipeline
dragen_mapping_metrics:
class: File
location: icav2://project_id/path/to/file
# dragen transcriptome directory (Optional)
# Docs: Location of the results from Dragen RNA-seq pipeline
dragen_wts_dir:
class: Directory
location: icav2://project_id/path/to/dir/
# drugs (Optional)
# Docs: Include drug matching section in the report.
drugs: false
# filter (Optional)
# Default value: True
# Docs: Filtering out low expressed genes. Available options are: "TRUE" (default) and "FALSE"
filter: true
# immunogram (Optional)
# Docs: Include drug matching section in the report.
immunogram: false
# log (Optional)
# Default value: True
# Docs: Log (base 2) transform data before normalisation. Available options are: "TRUE" (default) and "FALSE"
log: true
# norm (Optional)
# Default value: TMM
# Docs: Normalisation method
norm: "TMM"
# PCGR splice vars (Optional)
# Default value: True
# Docs: Include non-coding splice region variants reported in PCGR. Available options are: "TRUE" (default) and "FALSE"
pcgr_splice_vars: true
# pcgr tier (Optional)
# Default value: 4
# Docs: Tier threshold for reporting variants reported in PCGR.
pcgr_tier: 4
# pcgr tiers tsv (Optional)
# Docs: Location of the tsv output from pcgr
pcgr_tiers_tsv:
class: File
location: icav2://project_id/path/to/file
# project (Optional)
# Docs: Project name. This information is for annotation purposes only
project: string
# purple gene tsv (Optional)
# Docs: Location of the tsv output from purple
purple_gene_tsv:
class: File
location: icav2://project_id/path/to/file
# report dir (Required)
# Docs: Desired location for the outputs
report_dir: string
# salmom (Optional)
# Docs: Location of the quantification output from salmon
salmon:
class: File
location: icav2://project_id/path/to/file
# sample name (Required)
# Docs: Desired sample name to be presented in the report
sample_name: string
# sample source (Optional)
# Docs: Source of investigated sample (e.g. fresh frozen tissue, organoid).
# This information is for annotation purposes only
sample_source: string
# save tables (Optional)
# Default value: True
# Docs: Save interactive summary tables as HTML. Available options are: "TRUE" (default) and "FALSE"
save_tables: true
# scaling (Optional)
# Default value: gene-wise
# Docs: Apply "gene-wise" (default) or "group-wise" data scaling
scaling: "gene-wise"
# subject id (Optional)
# Docs: Subject ID. If umccrise output is specified (flag --umccrise) then Subject ID
# is extracted from there and used to overwrite this argument.
subject_id: string
# structural variants tsv (Optional)
# Docs: Location of the tsv output from SV caller
sv_tsv:
class: File
location: icav2://project_id/path/to/file
# top genes (Optional)
# Default value: 5
# Docs: The number of top ranked genes to be presented.
top_genes: 5
# transform (Optional)
# Default value: CPM
# Docs: Transformation method to be used when converting read counts
transform: "CPM"
# umccrise directory (Optional)
# Docs: The umccrise output directory
umccrise:
class: Directory
location: icav2://project_id/path/to/dir/
Json
Click to expand!
{
"arriba_dir": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
},
"arriba_pdf": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"arriba_tsv": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"batch_rm": true,
"cn_gain": 95,
"cn_loss": 5,
"dataset": "PANCAN",
"dataset_name_incl": false,
"dragen_fusions": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"dragen_mapping_metrics": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"dragen_wts_dir": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
},
"drugs": false,
"filter": true,
"immunogram": false,
"log": true,
"norm": "TMM",
"pcgr_splice_vars": true,
"pcgr_tier": 4,
"pcgr_tiers_tsv": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"project": "string",
"purple_gene_tsv": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"report_dir": "string",
"salmon": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"sample_name": "string",
"sample_source": "string",
"save_tables": true,
"scaling": "gene-wise",
"subject_id": "string",
"sv_tsv": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"top_genes": 5,
"transform": "CPM",
"umccrise": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
}
}
Outputs Template
Click to expand!
{
"rnasum_html": {
"class": "File",
"location": "icav2://project_id/path/to/file"
},
"rnasum_output_directory": {
"class": "Directory",
"location": "icav2://project_id/path/to/dir/"
}
}
Overrides Template
Zipped workflow
Click to expand!
[
"workflow.cwl#rnasum-pipeline--1.1.5/run_rnasum_step"
]
Packed workflow
Click to expand!
[
"#main/run_rnasum_step"
]
Inputs
Click to expand!
arriba directory
ID: arriba_dir
Optional: True
Type: Directory
Docs:
Location of the arriba outputs directory
arriba pdf
ID: arriba_pdf
Optional: True
Type: File
Docs:
Location of the pdf output from arriba
arriba tsv
ID: arriba_tsv
Optional: True
Type: File
Docs:
Location of the tsv output from arriba
batch rm
ID: batch_rm
Optional: True
Type: boolean
Docs:
Remove batch-associated effects between datasets. Available options are: "TRUE" (default) and "FALSE"
cn gain
ID: cn_gain
Optional: True
Type: int
Docs:
CN threshold value to classify genes within gained regions.
cn loss
ID: cn_loss
Optional: True
Type: int
Docs:
CN threshold value to classify genes within lost regions.
dataset
ID: dataset
Optional: False
Type: string
Docs:
Reference dataset selection from https://github.com/umccr/RNAsum/blob/master/TCGA_projects_summary.md
dataset name incl
ID: dat...
dragen-somatic-with-germline-pipeline/4.3.6__20241107061820
Overview
MD5Sum: f6f250deff3ce3eb74c05da342e970ea
Documentation
Documentation for dragen-somatic-with-germline-pipeline
v4.3.6
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_somatic_with_germline_pipeline_with_validation_data__4_3_6__20241107061820 / Bundle Version v10_r4__20241107061820
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.3.6/dragen-somatic-with-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.3.6__20241107061820.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 0ae597fa-eec3-43a0-9674-5c36a79d0cf3
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: a2332db7-caa3-4eb9-81c9-e32a36c94953
Pipeline Code: dragen-somatic-with-germline-pipeline__4_3_6__20241107061820
Projects
- development
- staging
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
Bundle Name: dragen_somatic_with_germline_pipeline_prod__4_3_6__20241107061820 / Bundle Version v10_r4__20241107061820
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.3.6/dragen-somatic-with-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.3.6__20241107061820.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 924f5fa1-7bdd-417d-8ab1-a47d615ae396
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: a2332db7-caa3-4eb9-81c9-e32a36c94953
Pipeline Code: dragen-somatic-with-germline-pipeline__4_3_6__20241107061820
Projects
- production
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-somatic-with-germline-pipeline%2F4.3.6__20241107061820/dragen-somatic-with-germline-pipeline__4.3.6__20241107061820.schema.json
# bam input (Optional)
# Docs: Input a normal BAM file for the variant calling stage
bam_input:
class: File
location: icav2://project_id/path/to/file
# cnv enable self normalization (Optional)
# Docs: Enable CNV self normalization.
# Self Normalization requires that the DRAGEN hash table be generated with the enable-cnv=true option.
cnv_enable_self_normalization: false
# cnv normal b allele vcf (Optional)
# Docs: Specify a matched normal SNV VCF.
cnv_normal_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv normal cnv vcf (Optional)
# Docs: Specify germline CNVs from the matched normal sample.
cnv_normal_cnv_vcf: false
# cnv population b allele vcf (Optional)
# Docs: Specify a population SNP catalog.
cnv_population_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv somatic enable het calling (Optional)
# Docs: Enable HET-calling mode for heterogeneous segments.
cnv_somatic_enable_het_calling: false
# cnv somatic enable lower ploidy limit (Optional)
# Docs: To improve accuracy on the tumor ploidy model estimation, the somatic WGS CNV caller estimates whether the chosen model calls
# homozygous deletions on regions that are likely to reduce the overall fitness of cells,
# which are therefore deemed to be "essential" and under negative selection.
# In the current literature, recent efforts tried to map such cell-essential genes (eg, in 2015 - https://www.science.org/doi/10.1126/science.aac7041).
# The check on essential regions is controlled with --cnv-somatic-enable-lower-ploidy-limit (default true).
cnv_somatic_enable_lower_ploidy_limit: false
# cnv somatic essential genes bed (Optional)
# Docs: Default bedfiles describing the essential regions are provided for hg19, GRCh37, hs37d5, GRCh38,
# but a custom bedfile can also be provided in input through the
# --cnv-somatic-essential-genes-bed=<BEDFILE_PATH> parameter.
# In such case, the feature is automatically enabled.
# A custom essential regions bedfile needs to have the following format: 4-column, tab-separated,
# where the first 3 columns identify the coordinates of the essential region (chromosome, 0-based start, excluded end).
# The fourth column is the region id (string type). For the purpose of the algorithm, currently only the first 3 columns are used.
# However, the fourth might be helpful to investigate manually which regions drove the decisions on model plausibility made by the caller.
cnv_somatic_essential_genes_bed: string
# cnv use somatic vc baf (Optional)
# Docs: If running in tumor-normal mode with the SNV caller enabled, use this option
# to specify the germline heterozygous sites.
cnv_use_somatic_vc_baf: false
# cnv use somatic vc vaf (Optional)
# Docs: Use the variant allele frequencies (VAFs) from the somatic SNVs to help select
# the tumor model for the sample.
cnv_use_somatic_vc_vaf: false
# cram input (Optional)
# Docs: Input a normal CRAM file for the variant calling stage
cram_input:
class: File
location: icav2://project_id/path/to/file
# cram reference (Optional)
# Docs: Path to the reference fasta file for the CRAM input.
# Required only if the input is a cram file AND not the reference in the tarball
cram_reference:
class: File
location: icav2://project_id/path/to/file
# dbsnp annotation (Optional)
# Docs: In Germline, Tumor-Normal somatic, or Tumor-Only somatic modes,
# DRAGEN can look up variant calls in a dbSNP database and add annotations for any matches that it finds there.
# To enable the dbSNP database search, set the --dbsnp option to the full path to the dbSNP database
# VCF or .vcf.gz file, which must be sorted in reference order.
dbsnp_annotation:
class: File
location: icav2://project_id/path/to/file
# deduplicate minimum quality (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual: string
# deduplicate minimum quality germline (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_germline: string
# deduplicate minimum quality somatic (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_somatic: string
# enable cnv calling (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software.
enable_cnv: false
# enable cnv germline (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (somatic only)
enable_cnv_germline: false
# enable cnv somatic (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (germline only)
enable_cnv_somatic: false
# enable duplicate marking (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking: false
# enable duplicate marking germline (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_germline: false
# enable duplicate marking somatic (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_somatic: false
# enable hla (Optional)
# Docs: Enable HLA typing by setting --enable-hla flag to true
enable_hla: false
# enable hrd (Optional)
# Docs: Set to true to enable HRD scoring to quantify genomic instability.
# Requires somatic CNV calls.
enable_hrd: false
# enable map align (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align: false
# enable map align germline (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align_germline: false
# enable map align output (Optional)
# Docs: Enables saving the output from the
# map/align stage....
dragen-somatic-with-germline-pipeline/4.2.4__20241107061831
Overview
MD5Sum: 8bcca124af5ca64c963a42da1b9d985f
Documentation
Documentation for dragen-somatic-with-germline-pipeline
v4.2.4
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_somatic_with_germline_pipeline_with_validation_data__4_2_4__20241107061831 / Bundle Version v9_r3__20241107061831
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.2.4/dragen-somatic-with-germline-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.2.4__20241107061831.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v9_r3
Bundle ID: 96e6b046-6ad1-4148-bcb0-d195f362ce60
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 6ce2b636-ba2f-4004-8065-f3557f286c98
Pipeline Code: dragen-somatic-with-germline-pipeline__4_2_4__20241107061831
Projects
- development
- staging
Datasets
- dragen_hash_table_hg38_alt_masked_v9_r3_linear_cnv_hla_rna
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
Bundle Name: dragen_somatic_with_germline_pipeline_prod__4_2_4__20241107061831 / Bundle Version v9_r3__20241107061831
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.2.4/dragen-somatic-with-germline-pipeline__4.2.4.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.2.4__20241107061831.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v9_r3
Bundle ID: 67fd8601-f442-4592-88cc-d99dbd3b1f4d
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 6ce2b636-ba2f-4004-8065-f3557f286c98
Pipeline Code: dragen-somatic-with-germline-pipeline__4_2_4__20241107061831
Projects
- production
Datasets
- dragen_hash_table_hg38_alt_masked_v9_r3_linear_cnv_hla_rna
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-somatic-with-germline-pipeline%2F4.2.4__20241107061831/dragen-somatic-with-germline-pipeline__4.2.4__20241107061831.schema.json
# bam input (Optional)
# Docs: Input a normal BAM file for the variant calling stage
bam_input:
class: File
location: icav2://project_id/path/to/file
# cnv enable self normalization (Optional)
# Docs: Enable CNV self normalization.
# Self Normalization requires that the DRAGEN hash table be generated with the enable-cnv=true option.
cnv_enable_self_normalization: false
# cnv normal b allele vcf (Optional)
# Docs: Specify a matched normal SNV VCF.
cnv_normal_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv normal cnv vcf (Optional)
# Docs: Specify germline CNVs from the matched normal sample.
cnv_normal_cnv_vcf: false
# cnv population b allele vcf (Optional)
# Docs: Specify a population SNP catalog.
cnv_population_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv somatic enable het calling (Optional)
# Docs: Enable HET-calling mode for heterogeneous segments.
cnv_somatic_enable_het_calling: false
# cnv somatic enable lower ploidy limit (Optional)
# Docs: To improve accuracy on the tumor ploidy model estimation, the somatic WGS CNV caller estimates whether the chosen model calls
# homozygous deletions on regions that are likely to reduce the overall fitness of cells,
# which are therefore deemed to be "essential" and under negative selection.
# In the current literature, recent efforts tried to map such cell-essential genes (eg, in 2015 - https://www.science.org/doi/10.1126/science.aac7041).
# The check on essential regions is controlled with --cnv-somatic-enable-lower-ploidy-limit (default true).
cnv_somatic_enable_lower_ploidy_limit: false
# cnv somatic essential genes bed (Optional)
# Docs: Default bedfiles describing the essential regions are provided for hg19, GRCh37, hs37d5, GRCh38,
# but a custom bedfile can also be provided in input through the
# --cnv-somatic-essential-genes-bed=<BEDFILE_PATH> parameter.
# In such case, the feature is automatically enabled.
# A custom essential regions bedfile needs to have the following format: 4-column, tab-separated,
# where the first 3 columns identify the coordinates of the essential region (chromosome, 0-based start, excluded end).
# The fourth column is the region id (string type). For the purpose of the algorithm, currently only the first 3 columns are used.
# However, the fourth might be helpful to investigate manually which regions drove the decisions on model plausibility made by the caller.
cnv_somatic_essential_genes_bed: string
# cnv use somatic vc baf (Optional)
# Docs: If running in tumor-normal mode with the SNV caller enabled, use this option
# to specify the germline heterozygous sites.
cnv_use_somatic_vc_baf: false
# cnv use somatic vc vaf (Optional)
# Docs: Use the variant allele frequencies (VAFs) from the somatic SNVs to help select
# the tumor model for the sample.
cnv_use_somatic_vc_vaf: false
# cram input (Optional)
# Docs: Input a normal CRAM file for the variant calling stage
cram_input:
class: File
location: icav2://project_id/path/to/file
# cram reference (Optional)
# Docs: Path to the reference fasta file for the CRAM input.
# Required only if the input is a cram file AND not the reference in the tarball
cram_reference:
class: File
location: icav2://project_id/path/to/file
# dbsnp annotation (Optional)
# Docs: In Germline, Tumor-Normal somatic, or Tumor-Only somatic modes,
# DRAGEN can look up variant calls in a dbSNP database and add annotations for any matches that it finds there.
# To enable the dbSNP database search, set the --dbsnp option to the full path to the dbSNP database
# VCF or .vcf.gz file, which must be sorted in reference order.
dbsnp_annotation:
class: File
location: icav2://project_id/path/to/file
# deduplicate minimum quality (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual: string
# deduplicate minimum quality germline (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_germline: string
# deduplicate minimum quality somatic (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_somatic: string
# enable cnv calling (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software.
enable_cnv: false
# enable cnv germline (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (somatic only)
enable_cnv_germline: false
# enable cnv somatic (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software (germline only)
enable_cnv_somatic: false
# enable duplicate marking (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking: false
# enable duplicate marking germline (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_germline: false
# enable duplicate marking somatic (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_somatic: false
# enable hla (Optional)
# Docs: Enable HLA typing by setting --enable-hla flag to true
enable_hla: false
# enable hrd (Optional)
# Docs: Set to true to enable HRD scoring to quantify genomic instability.
# Requires somatic CNV calls.
enable_hrd: false
# enable map align (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align: false
# enable map align germline (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align_germline: false
# enable map align output (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# running map/align. Default is false if
# running the variant caller.
enable_map_align_output: false
# enable map align output germline (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# running map/align. Default is false if
# running the variant caller.
enable_map_align_output_germline: false
# enable map align output somatic (Opti...
dragen-transcriptome-pipeline/4.3.6__20241106102659
Overview
MD5Sum: c9e823dbdf406f61e221a4eee400a8f4
Documentation
Documentation for dragen-transcriptome-pipeline v4.3.6
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_transcriptome_pipeline_with_validation_data__4_3_6__20241106102659 / Bundle Version v10_r4__20241106102659
Description
This bundle has been generated by the release of workflows/dragen-transcriptome-pipeline/4.3.6/dragen-transcriptome-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-transcriptome-pipeline/4.3.6__20241106102659.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: f23b0978-e6d5-44da-b601-398fcc0660d6
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: c309cddb-bb49-4f96-926e-6917ef0b18d6
Pipeline Code: dragen-transcriptome-pipeline__4_3_6__20241106102659
Projects
- development
- staging
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- hg38_fasta
- arriba_2_4_0
- hg38_v39_gencode_annotation
- wts_validation_fastq__SBJ00480
- wts_validation_fastq__SBJ00028
- wts_validation_fastq__SBJ00061
- wts_validation_fastq__SBJ00188
- wts_validation_fastq__SBJ00199
- wts_validation_fastq__SBJ00236
- wts_validation_fastq__SBJ00238
Bundle Name: dragen_transcriptome_pipeline_prod__4_3_6__20241106102659 / Bundle Version v10_r4__20241106102659
Description
This bundle has been generated by the release of workflows/dragen-transcriptome-pipeline/4.3.6/dragen-transcriptome-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-transcriptome-pipeline/4.3.6__20241106102659.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: b5da4efb-449f-4277-bfdd-35251eaac849
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: c309cddb-bb49-4f96-926e-6917ef0b18d6
Pipeline Code: dragen-transcriptome-pipeline__4_3_6__20241106102659
Projects
- production
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- hg38_fasta
- arriba_2_4_0
- hg38_v39_gencode_annotation
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-transcriptome-pipeline%2F4.3.6__20241106102659/dragen-transcriptome-pipeline__4.3.6__20241106102659.schema.json
# algorithm (Optional)
# Default value: proportional
# Docs: Counting algorithm:
# uniquely-mapped-reads(default) or proportional.
algorithm: "proportional"
# annotation file (Required)
# Docs: Path to annotation transcript file.
annotation_file:
class: File
location: icav2://project_id/path/to/file
# bam input (Optional)
# Docs: Input a BAM file for WTS analysis
bam_input:
class: File
location: icav2://project_id/path/to/file
# blacklist (Required)
# Docs: File with blacklist range
blacklist:
class: File
location: icav2://project_id/path/to/file
# cl config (Optional)
# Docs: command line config to supply additional config values on the command line.
cl_config: string
# contigs (Optional)
# Docs: Optional - List of interesting contigs
# If not specified, defaults to 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,X,Y
contigs: string
# cytobands (Required)
# Docs: Coordinates of the Giemsa staining bands.
cytobands:
class: File
location: icav2://project_id/path/to/file
# enable duplicate marking (Required)
# Docs: Mark identical alignments as duplicates
enable_duplicate_marking: false
# enable map align (Optional)
# Docs: Enabled by default.
# Set this value to false if using bam_input AND tumor_bam_input
enable_map_align: false
# enable map align output (Required)
# Docs: Do you wish to have the output bam files present
enable_map_align_output: false
# enable rna gene fusion (Optional)
# Docs: Optional - Enable the DRAGEN Gene Fusion module - defaults to true
enable_rna_gene_fusion: false
# enable rna quantification (Optional)
# Docs: Optional - Enable the quantification module - defaults to true
enable_rna_quantification: false
# enable sort (Optional)
# Docs: True by default, only set this to false if using --bam-input as input parameter
enable_sort: false
# fastq list (Optional)
# Docs: CSV file that contains a list of FASTQ files
# to process. read_1 and read_2 components in the CSV file must be presigned urls.
fastq_list:
class: File
location: icav2://project_id/path/to/file
# Row of fastq lists (Optional)
# Docs: The row of fastq lists.
# Each row has the following attributes:
# * RGID
# * RGLB
# * RGSM
# * Lane
# * Read1File
# * Read2File (optional)
fastq_list_rows:
- rgid: string
rglb: string
rgsm: string
lane: string
read_1:
class: File
location: icav2://project_id/path/to/file
read_2:
class: File
location: icav2://project_id/path/to/file
# java mem (Optional)
# Default value: 20G
# Docs: Set desired Java heap memory size
java_mem: "20G"
# license instance id location (Optional)
# Docs: You may wish to place your own in.
# Optional value, default set to /opt/instance-identity
# which is a path inside the dragen container
lic_instance_id_location:
class: File
location: icav2://project_id/path/to/file
# output file prefix (Required)
# Docs: The prefix given to all output files
output_prefix: string
# protein domains (Required)
# Docs: GFF3 file containing the genomic coordinates of protein domains.
protein_domains:
class: File
location: icav2://project_id/path/to/file
# read trimming (Optional)
# Docs: To enable trimming filters in hard-trimming mode, set to a comma-separated list of the trimmer tools
# you would like to use. To disable trimming, set to none. During mapping, artifacts are removed from all reads.
# Read trimming is disabled by default.
read_trimmers: string
# reference Fasta (Required)
# Docs: FastA file with genome sequence
reference_fasta:
class: File
location: icav2://project_id/path/to/file
# reference tar (Required)
# Docs: Path to ref data tarball
reference_tar:
class: File
location: icav2://project_id/path/to/file
# soft read trimming (Optional)
# Docs: To enable trimming filters in soft-trimming mode, set to a comma-separated list of the trimmer tools
# you would like to use. To disable soft trimming, set to none. During mapping, reads are aligned as if trimmed,
# and bases are not removed from the reads. Soft-trimming is enabled for the polyg filter by default.
soft_read_trimmers: string
# trim adapter r1 5prime (Optional)
# Docs: Specify the FASTA file that contains adapter sequences to trim from the 5' end of Read 1.
# NB: the sequences should be in reverse order (with respect to their appearance in the FASTQ) but not complemented.
trim_adapter_r1_5prime:
class: File
location: icav2://project_id/path/to/file
# trim adapter r2 5prime (Optional)
# Docs: Specify the FASTA file that contains adapter sequences to trim from the 5' end of Read 2.
# NB: the sequences should be in reverse order (with respect to their appearance in the FASTQ) but not complemented.
trim_adapter_r2_5prime:
class: File
location: icav2://project_id/path/to/file
# trim adapter read1 (Optional)
# Docs: Specify the FASTA file that contains adapter sequences to trim from the 3' end of Read 1.
trim_adapter_read1:
class: File
location: icav2://project_id/path/to/file
# trim adapter read2 (Optional)
# Docs: Specify the FASTA file that contains adapter sequences to trim from the 3' end of Read 2.
trim_adapter_read2:
class: File
location: icav2://project_id/path/to/file
# trim adapter stringency (Optional)
# Docs: Specify the minimum number of adapter bases required for trimming
trim_adapter_stringency: string
# trim r1 3prime (Optional)
# Docs: Specify the minimum number of bases to trim from the 3' end of Read 1 (default: 0).
trim_r1_3prime: string
# trim r1 5prime (Optional)
# Docs: Specify the minimum number of bases to trim from the 5' end of Read 1 (default: 0).
trim_r1_5prime: string
# trim r2 3prime (Optional)
# Docs: Specify the minimum number of bases to trim from the 3' end of Read 2 (default: 0).
trim_r2_3prime: string
# trim r2 5prime (Optional)
# Docs: Specify the minimum number of bases to trim from the 5' end of Read 2 (default: 0).
trim_r2_5prime: string
Json
Click to expand!
{
"algorithm": "proportional",
"annotation_file": {
"class": "File",
"location": "icav2...
dragen-somatic-with-germline-pipeline/4.3.6__20241106102705
Overview
MD5Sum: 9585b66b4fb95e312c4a76e47d4697b1
Documentation
Documentation for dragen-somatic-with-germline-pipeline
v4.3.6
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_somatic_with_germline_pipeline_with_validation_data__4_3_6__20241106102705 / Bundle Version v10_r4__20241106102705
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.3.6/dragen-somatic-with-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.3.6__20241106102705.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 84321a34-a7be-41ea-9e71-148b6f92b2c9
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 4dd83fe0-1119-4dfc-8600-98f524cefe5e
Pipeline Code: dragen-somatic-with-germline-pipeline__4_3_6__20241106102705
Projects
- development
- staging
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
Bundle Name: dragen_somatic_with_germline_pipeline_prod__4_3_6__20241106102705 / Bundle Version v10_r4__20241106102705
Description
This bundle has been generated by the release of workflows/dragen-somatic-with-germline-pipeline/4.3.6/dragen-somatic-with-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-somatic-with-germline-pipeline/4.3.6__20241106102705.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 1511947c-e511-42b5-8eb3-6f061caccc20
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: 4dd83fe0-1119-4dfc-8600-98f524cefe5e
Pipeline Code: dragen-somatic-with-germline-pipeline__4_3_6__20241106102705
Projects
- production
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-somatic-with-germline-pipeline%2F4.3.6__20241106102705/dragen-somatic-with-germline-pipeline__4.3.6__20241106102705.schema.json
# bam input (Optional)
# Docs: Input a normal BAM file for the variant calling stage
bam_input:
class: File
location: icav2://project_id/path/to/file
# cnv enable self normalization (Optional)
# Docs: Enable CNV self normalization.
# Self Normalization requires that the DRAGEN hash table be generated with the enable-cnv=true option.
cnv_enable_self_normalization: false
# cnv normal b allele vcf (Optional)
# Docs: Specify a matched normal SNV VCF.
cnv_normal_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv normal cnv vcf (Optional)
# Docs: Specify germline CNVs from the matched normal sample.
cnv_normal_cnv_vcf: false
# cnv population b allele vcf (Optional)
# Docs: Specify a population SNP catalog.
cnv_population_b_allele_vcf:
class: File
location: icav2://project_id/path/to/file
# cnv somatic enable het calling (Optional)
# Docs: Enable HET-calling mode for heterogeneous segments.
cnv_somatic_enable_het_calling: false
# cnv somatic enable lower ploidy limit (Optional)
# Docs: To improve accuracy on the tumor ploidy model estimation, the somatic WGS CNV caller estimates whether the chosen model calls
# homozygous deletions on regions that are likely to reduce the overall fitness of cells,
# which are therefore deemed to be "essential" and under negative selection.
# In the current literature, recent efforts tried to map such cell-essential genes (eg, in 2015 - https://www.science.org/doi/10.1126/science.aac7041).
# The check on essential regions is controlled with --cnv-somatic-enable-lower-ploidy-limit (default true).
cnv_somatic_enable_lower_ploidy_limit: false
# cnv somatic essential genes bed (Optional)
# Docs: Default bedfiles describing the essential regions are provided for hg19, GRCh37, hs37d5, GRCh38,
# but a custom bedfile can also be provided in input through the
# --cnv-somatic-essential-genes-bed=<BEDFILE_PATH> parameter.
# In such case, the feature is automatically enabled.
# A custom essential regions bedfile needs to have the following format: 4-column, tab-separated,
# where the first 3 columns identify the coordinates of the essential region (chromosome, 0-based start, excluded end).
# The fourth column is the region id (string type). For the purpose of the algorithm, currently only the first 3 columns are used.
# However, the fourth might be helpful to investigate manually which regions drove the decisions on model plausibility made by the caller.
cnv_somatic_essential_genes_bed: string
# cnv use somatic vc baf (Optional)
# Docs: If running in tumor-normal mode with the SNV caller enabled, use this option
# to specify the germline heterozygous sites.
cnv_use_somatic_vc_baf: false
# cnv use somatic vc vaf (Optional)
# Docs: Use the variant allele frequencies (VAFs) from the somatic SNVs to help select
# the tumor model for the sample.
cnv_use_somatic_vc_vaf: false
# cram input (Optional)
# Docs: Input a normal CRAM file for the variant calling stage
cram_input:
class: File
location: icav2://project_id/path/to/file
# cram reference (Optional)
# Docs: Path to the reference fasta file for the CRAM input.
# Required only if the input is a cram file AND not the reference in the tarball
cram_reference:
class: File
location: icav2://project_id/path/to/file
# dbsnp annotation (Optional)
# Docs: In Germline, Tumor-Normal somatic, or Tumor-Only somatic modes,
# DRAGEN can look up variant calls in a dbSNP database and add annotations for any matches that it finds there.
# To enable the dbSNP database search, set the --dbsnp option to the full path to the dbSNP database
# VCF or .vcf.gz file, which must be sorted in reference order.
dbsnp_annotation:
class: File
location: icav2://project_id/path/to/file
# deduplicate minimum quality (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual: string
# deduplicate minimum quality germline (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_germline: string
# deduplicate minimum quality somatic (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual_somatic: string
# enable cnv calling (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software.
enable_cnv: false
# enable duplicate marking (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking: false
# enable duplicate marking germline (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_germline: false
# enable duplicate marking somatic (Optional)
# Docs: Enable the flagging of duplicate output
# alignment records.
enable_duplicate_marking_somatic: false
# enable hla (Optional)
# Docs: Enable HLA typing by setting --enable-hla flag to true
enable_hla: false
# enable hrd (Optional)
# Docs: Set to true to enable HRD scoring to quantify genomic instability.
# Requires somatic CNV calls.
enable_hrd: false
# enable map align (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align: false
# enable map align germline (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align_germline: false
# enable map align output (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# running map/align. Default is false if
# running the variant caller.
enable_map_align_output: false
# enable map align output germline (Optional)
# Docs: Enables saving the output from the
# map/align stage. Default is true when only
# r...
dragen-germline-pipeline/4.3.6__20241106102657
Overview
MD5Sum: 65ab25120dd83bc3f77ae9fa7e028433
Documentation
Documentation for dragen-germline-pipeline v4.3.6
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_germline_pipeline_with_validation_data__4_3_6__20241106102657 / Bundle Version v10_r4__20241106102657
Description
This bundle has been generated by the release of workflows/dragen-germline-pipeline/4.3.6/dragen-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-germline-pipeline/4.3.6__20241106102657.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 5abca90e-17fe-4c47-a160-65c65352e6b7
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: f3988d12-bf4d-4992-8f7b-acbc1b6d0e17
Pipeline Code: dragen-germline-pipeline__4_3_6__20241106102657
Projects
- development
- staging
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
Bundle Name: dragen_germline_pipeline_prod__4_3_6__20241106102657 / Bundle Version v10_r4__20241106102657
Description
This bundle has been generated by the release of workflows/dragen-germline-pipeline/4.3.6/dragen-germline-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-germline-pipeline/4.3.6__20241106102657.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: c4c34706-2116-4ce9-a973-a3205183b720
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: f3988d12-bf4d-4992-8f7b-acbc1b6d0e17
Pipeline Code: dragen-germline-pipeline__4_3_6__20241106102657
Projects
- production
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-germline-pipeline%2F4.3.6__20241106102657/dragen-germline-pipeline__4.3.6__20241106102657.schema.json
# bam input (Optional)
# Docs: Input a normal BAM file for the variant calling stage
bam_input:
class: File
location: icav2://project_id/path/to/file
# cnv enable self normalization (Optional)
# Docs: Enable CNV self normalization.
# Self Normalization requires that the DRAGEN hash table be generated with the enable-cnv=true option.
cnv_enable_self_normalization: false
# cram input (Optional)
# Docs: Input a normal CRAM file for the variant calling stage
cram_input:
class: File
location: icav2://project_id/path/to/file
# cram reference (Optional)
# Docs: Path to the reference fasta file for the CRAM input.
# Required only if the input is a cram file AND not the reference in the tarball
cram_reference:
class: File
location: icav2://project_id/path/to/file
# dbsnp annotation (Optional)
# Docs: In Germline, Tumor-Normal somatic, or Tumor-Only somatic modes,
# DRAGEN can look up variant calls in a dbSNP database and add annotations for any matches that it finds there.
# To enable the dbSNP database search, set the --dbsnp option to the full path to the dbSNP database
# VCF or .vcf.gz file, which must be sorted in reference order.
dbsnp_annotation:
class: File
location: icav2://project_id/path/to/file
# deduplicate minimum quality (Optional)
# Docs: Specifies the Phred quality score below which a base should be excluded from the quality score
# calculation used for choosing among duplicate reads.
dedup_min_qual: string
# enable cnv calling (Optional)
# Docs: Enable CNV processing in the DRAGEN Host Software.
enable_cnv: false
# enable duplicate marking (Optional)
# Docs: Mark identical alignments as duplicates
enable_duplicate_marking: false
# enable hla (Optional)
# Docs: Enable HLA typing by setting --enable-hla flag to true
enable_hla: false
# enable map align (Optional)
# Docs: Enabled by default since --enable-variant-caller option is set to true.
# Set this value to false if using bam_input
enable_map_align: false
# enable map align output (Optional)
# Docs: Do you wish to have the output bam files present
enable_map_align_output: false
# enable pgx (Optional)
# Docs: Enable star allele caller. This also turns on other PGx callers such as CYP2D6, CYP2B6
enable_pgx: false
# enable sv (Optional)
# Docs: Enable/disable structural variant
# caller. Default is false.
enable_sv: false
# enable targeted (Optional)
# Docs: Enable targeted variant calling for repetitive regions
enable_targeted: false
# fastq list (Optional)
# Docs: CSV file that contains a list of FASTQ files
# to process.
# Read1File and Read2File may be presigned urls or use this in conjunction with
# the fastq_list_mount_paths inputs.
fastq_list:
class: File
location: icav2://project_id/path/to/file
# fastq list rows (Optional)
# Docs: Alternative to providing a file, one can instead provide a list of 'fastq-list-row' objects
fastq_list_rows:
- rgid: string
rglb: string
rgsm: string
lane: string
read_1:
class: File
location: icav2://project_id/path/to/file
read_2:
class: File
location: icav2://project_id/path/to/file
# hla allele frequency file (Optional)
# Docs: Use the population-level HLA allele frequency file to break ties if one or more HLA allele produces the same or similar results.
# The input HLA allele frequency file must be in CSV format and contain the HLA alleles and the occurrence frequency in population.
# If --hla-allele-frequency-file is not specified, DRAGEN automatically uses hla_classI_allele_frequency.csv from /opt/edico/config/.
# Population-level allele frequencies can be obtained from the Allele Frequency Net database.
hla_allele_frequency_file:
class: File
location: icav2://project_id/path/to/file
# hla bed file (Optional)
# Docs: Use the HLA region BED input file to specify the region to extract HLA reads from.
# DRAGEN HLA Caller parses the input file for regions within the BED file, and then
# extracts reads accordingly to align with the HLA allele reference.
hla_bed_file:
class: File
location: icav2://project_id/path/to/file
# hla min reads (Optional)
# Docs: Set the minimum number of reads to align to HLA alleles to ensure sufficient coverage and perform HLA typing.
# The default value is 1000 and suggested for WES samples. If using samples with less coverage, you can use a
# lower threshold value.
hla_min_reads: string
# hla reference file (Optional)
# Docs: Use the HLA allele reference file to specify the reference alleles to align against.
# The input HLA reference file must be in FASTA format and contain the protein sequence separated into exons.
# If --hla-reference-file is not specified, DRAGEN uses hla_classI_ref_freq.fasta from /opt/edico/config/.
# The reference HLA sequences are obtained from the IMGT/HLA database.
hla_reference_file:
class: File
location: icav2://project_id/path/to/file
# hla tiebreaker threshold (Optional)
# Docs: If more than one allele has a similar number of reads aligned and there is not a clear indicator for the best allele,
# the alleles are considered as ties. The HLA Caller places the tied alleles into a candidate set for tie breaking based
# on the population allele frequency. If an allele has more than the specified fraction of reads aligned (normalized to
# the top hit), then the allele is included into the candidate set for tie breaking. The default value is 0.97.
hla_tiebreaker_threshold: string
# hla zygosity threshold (Optional)
# Docs: If the minor allele at a given locus has fewer reads mapped than a fraction of the read count of the major allele,
# then the HLA Caller infers homozygosity for the given HLA-I gene. You can use this option to specify the fraction value.
# The default value is 0.15.
hla_zygosity_threshold: string
# license instance id location (Optional)
# Default value: /opt/instance-identity
# Docs: You may wish to place your own in.
# Optional value, default set to /opt/instance-identity
# which is a path inside the dragen container
lic_instance_id_location:
class: File
location: icav2://project_id/path/to/file
# output format (Optional)
# Docs: For mapping and aligning, the output is sorted and compressed into BAM format by default before saving to disk.
# You can control the output...
dragen-alignment-pipeline/4.3.6__20241106102650
Overview
MD5Sum: cc4d8f38e17006edcd6acb18cf7dea5a
Documentation
Documentation for dragen-alignment-pipeline v4.3.6
Dockstore
ICAv2
Tenant: umccr-prod
Bundles Generated
Bundle Name: dragen_alignment_pipeline_with_validation_data__4_3_6__20241106102650 / Bundle Version v10_r4__20241106102650
Description
This bundle has been generated by the release of workflows/dragen-alignment-pipeline/4.3.6/dragen-alignment-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-alignment-pipeline/4.3.6__20241106102650.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: c01829f8-ed84-4850-870f-7aefece9bff4
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: e22e34e7-5bb9-475f-ba0b-7fc184a83521
Pipeline Code: dragen-alignment-pipeline__4_3_6__20241106102650
Projects
- development
- staging
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- hg38_v39_gencode_annotation
- wgs_validation_fastq__cups_pair_8
- wgs_validation_fastq__2016_249_17_MH_P033
- wgs_validation_fastq__2016_249_18_WH_P025
- wgs_validation_fastq__B_ALL_Case_10
- wgs_validation_fastq_Diploid_Never_Responder
- wgs_validation_fastq_SBJ00303
- wgs_validation_fastq_SEQC50
- wgs_validation_fastq_SFRC01073
- wts_validation_fastq__SBJ00480
- wts_validation_fastq__SBJ00028
- wts_validation_fastq__SBJ00061
- wts_validation_fastq__SBJ00188
- wts_validation_fastq__SBJ00199
- wts_validation_fastq__SBJ00236
- wts_validation_fastq__SBJ00238
Bundle Name: dragen_alignment_pipeline_prod__4_3_6__20241106102650 / Bundle Version v10_r4__20241106102650
Description
This bundle has been generated by the release of workflows/dragen-alignment-pipeline/4.3.6/dragen-alignment-pipeline__4.3.6.cwl. The pipeline can be found at https://github.com/umccr/cwl-ica/releases/tag/dragen-alignment-pipeline/4.3.6__20241106102650.
Version Description
Bundle version description is currently redundant while we cannot append versions to bundles. Regardless - the bunch version is v10_r4
Bundle ID: 9d436c03-c2a2-4cea-90e8-d8c84353846b
- Bundle Link
Pipeline Project ID: 5844391a-69db-4b52-86b5-6a0d55c2386f
Pipeline Project Name: pipelines
Pipeline ID: e22e34e7-5bb9-475f-ba0b-7fc184a83521
Pipeline Code: dragen-alignment-pipeline__4_3_6__20241106102650
Projects
- production
Datasets
- dragen_hash_table_chm13_v2_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_chm13_v2_v10_r4_linear_cnv_hla_rna_methylated_combined
- dragen_hash_table_hg38_alt_masked_v10_r4_graph_cnv_hla_rna
- dragen_hash_table_hg38_alt_masked_v10_r4_linear_cnv_hla_rna_methylated_combined
- hg38_v39_gencode_annotation
Visual Overview
Click to expand!
Inputs Template
Yaml
Click to expand!
# yaml-language-server: $schema=https://github.com/umccr/cwl-ica/releases/download/dragen-alignment-pipeline%2F4.3.6__20241106102650/dragen-alignment-pipeline__4.3.6__20241106102650.schema.json
# aln min score (Optional)
# Docs: (signed) Minimum alignment score to report; baseline for MAPQ.
# When using local alignments (global = 0), aln-min-score is computed by the host software as "22 * match-score".
# When using global alignments (global = 1), aln-min-score is set to -1000000.
# Host software computation may be overridden by setting aln-min-score in configuration file.
# Range: −2,147,483,648 to 2,147,483,647
aln_min_score: string
# alt aware (Optional)
# Docs: Enables special processing for alt contigs, if alt liftover was used in hash table.
# Enabled by default if reference was built with liftover.
alt_aware: false
# ann sj max indel (Optional)
# Docs: Maximum indel length to expect near an annotated splice junction.
# Range: 0 - 63
ann_sj_max_indel: string
# annotation file (Optional)
# Docs: Use to supply a gene annotation file. Required for quantification and gene-fusion.
annotation_file:
class: File
location: icav2://project_id/path/to/file
# dedup min qual (Optional)
# Docs: Minimum base quality for calculating read quality metric for deduplication.
# Range: 0-63
dedup_min_qual: string
# edit chain limit (Optional)
# Docs: For edit-mode 1 or 2: Maximum seed chain length in a read to qualify for seed editing.
# Range: > 0
edit_chain_limit: string
# edit mode (Optional)
# Docs: 0 = No edits, 1 = Chain len test, 2 = Paired chain len test, 3 = Edit all std seeds.
edit_mode: '0'
# edit read len (Optional)
# Docs: For edit-mode 1 or 2: Read length in which to try edit-seed-num edited seeds.
# Range: > 0
edit_read_len: string
# edit seed num (Optional)
# Docs: For edit-mode 1 or 2: Requested number of seeds per read to allow editing on.
# Range: > 0
edit_seed_num: string
# en alt hap aln (Optional)
# Docs: Allows chimeric alignments to be output, as supplementary.
en_alt_hap_aln: false
# en chimeric aln (Optional)
# Docs: Allows chimeric alignments to be output, as supplementary.
en_chimeric_aln: false
# enable duplicate marking (Optional)
# Docs: Enable the flagging of duplicate output alignment records.
enable_duplicate_marking: false
# enable map align (Optional)
# Docs: Enable use of BAM input files for mapper/aligner.
enable_map_align: false
# enable map align (Optional)
# Docs: Enables saving the output from the map/align stage.
# If only running map/align, the default value is true.
# If running the variant caller, the default value is false.
# Therefore in the case of the dragen alignment pipeline, this will always be true.
# For sanity purposes, we have it as an option since its default state is not intuitive
enable_map_align_output: false
# enable rna (Optional)
# Docs: Enable rna specific settings
enable_rna: false
# enable rna quantification (Optional)
# Docs: If set to true, enables RNA quantification. Requires --enable-rna to be set to true.
enable_rna_quantification: false
# enable rrna filtering (Optional)
# Docs: Use the DRAGEN RNA pipeline to filter rRNA reads during alignment. The default value is false.
enable_rrna_filter: false
# enable sort (Optional)
# Docs: Enable sorting after mapping/alignment.
enable_sort: false
# fastq list (Optional)
# Docs: CSV file that contains a list of FASTQ files for normal sample
# to process (read_1 and read_2 attributes must be presigned urls for each column)
fastq_list:
class: File
location: icav2://project_id/path/to/file
# Row of fastq lists (Optional)
# Docs: The row of fastq lists.
# Each row has the following attributes:
# * RGID
# * RGLB
# * RGSM
# * Lane
# * Read1File
# * Read2File (optional)
fastq_list_rows:
- rgid: string
rglb: string
rgsm: string
lane: string
read_1:
class: File
location: icav2://project_id/path/to/file
read_2:
class: File
location: icav2://project_id/path/to/file
# gap ext pen (Optional)
# Docs: Score penalty for gap extension.
gap_ext_pen: string
# gap open pen (Optional)
# Docs: Score penalty for opening a gap (insertion or deletion).
gap_open_pen: string
# generate md tags (Optional)
# Docs: Whether to generate MD tags with alignment output records. Default is false.
generate_md_tags: false
# generate sa tags (Optional)
# Docs: Whether to generate SA:Z tags for records that have chimeric/supplemental alignments.
generate_sa_tags: false
# generate zs tags (Optional)
# Docs: Whether to generate ZS tags for alignment output records. Default is false.
generate_zs_tags: false
# global (Optional)
# Docs: If alignment is global (Needleman-Wunsch) rather than local (Smith-Waterman).
global: false
# hard clips (Optional)
# Docs: Flags for hard clipping: [0] primary, [1] supplementary, [2] secondary.
# The hard-clips option is used as a field of 3 bits, with values ranging from 0 to 7.
# The bits specify alignments, as follows:
# * Bit 0—primary alignments
# * Bit 1—supplementary alignments
# * Bit 2—secondary alignments
# Each bit determines whether local alignments of that type are reported with hard clipping (1)
# or soft clipping (0).
# The default is 6, meaning primary alignments use soft clipping and supplementary and
# secondary alignments use hard clipping.
hard_clips: string
# map orientations (Optional)
# Docs: Constrain orientations to accept forward-only, reverse-complement only, or any alignments.
map_orientations: '0'
# mapq max (Optional)
# Docs: Ceiling on reported MAPQ. Max 255
mapq_max: string
# mapq strict js (Optional)
# Docs: Specific to RNA. When set to 0, a higher MAPQ value is returned, expressing confidence that the alignment is at least partially correct. When set to 1, a lower MAPQ value is returned, expressing the splice junction ambiguity.
mapq_strict_js: false
# match n score (Optional)
# Docs: (signed) Score increment for matching a reference 'N' nucleotide IUB code.
# Range: -16 to 15
match_n_score: string
# match score (Optional)
# Docs: Score increment for matching reference nucleotide.
# When global = 0, mat...