# demux_deplete Picard-based demultiplexing and basecalling from a tarball of a raw BCL directory, followed by QC metrics, depletion, and SRA submission prep. ## Inputs ### Required inputs
demux_deplete.flowcell_tgz
File — Default: None
Illumina BCL directory compressed as tarball. Must contain RunInfo.xml, SampleSheet.csv, RTAComplete.txt, and Data/Intensities/BaseCalls/*
demux_deplete.samplesheets
Array[File]+ — Default: None
Custom formatted 'extended' format tsv samplesheets that will override any SampleSheet.csv in the illumina BCL directory. Must supply one file per lane of the flowcell, and must provide them in lane order. Required tsv column headings are: sample, library_id_per_sample, barcode_1, barcode_2 (if paired reads, omit if single-end), barcode_3 (if additional demultiplexing downstream by other means, otherwise may be omitted), library_strategy, library_source, library_selection, design_description. 'sample' must correspond to a biological sample. ('sample' x 'library_id_per_sample') must be unique within a samplesheet and correspond to independent libraries from the same original sample. barcode_1 and barcode_2 must correspond to the actual index sequences. Remaining columns must follow strict ontology: see 3rd tab of https://www.ncbi.nlm.nih.gov/core/assets/sra/files/SRA_metadata_acc_example.xlsx for controlled vocabulary and term definitions.
demux_deplete.spikein_db
File — Default: None
Synthetic sequences (e.g. ERCC, SDSI) that are used to track potential contamination within sequencing plate processing.
demux_deplete.biosample_map_tsvs
Array[File] — Default: []
One or more tsv files, each containing at least the following columns: 'sample_name', 'accession'. 'sample_name' refers to the external sample id, 'accession' is the NCBI BioSample accession (SAMN########). Recommended input: the BioSample attributes tsv returned by NCBI following successful submission of a new list of BioSample attributes. If this file is omitted, SRA submission prep will be skipped.
demux_deplete.bmtaggerDbs
Array[File]? — Default: None
Tool that can discriminate between human and bacterial reads and other reads by using short fragments. Databases must be provided to onset depletion.Sequences in fasta format will be indexed on the fly, pre-bmtagger-indexed databases may be provided as tarballs.
demux_deplete.illumina_demux.barcode_columns_to_rev_comp
Array[String]? — Default: None
Columns in the sample sheet to reverse-complement. Only used if 'rev_comp_barcodes_before_demux' is true. Defaults to 'barcode_2'.
demux_deplete.illumina_demux.rev_comp_barcodes_before_demux
Boolean — Default: false
Reverse-complement the barcode(s) before demultiplexing. By default, this action applies to values in the 'barcode_2' column unless overridden by 'barcode_columns_to_rev_comp'.
demux_deplete.illumina_demux.runinfo
File? — Default: None
if we are overriding the RunInfo file, use the path of the file provided. Otherwise the default will be RunInfo.xml.
demux_deplete.insert_demux_outputs_into_terra_tables
Boolean — Default: false
Terra only: if set to 'true', demux output will be used to insert entries in 'library' (per library-lane) and 'sample tables' (referencing one or more libraries per sample ID)
demux_deplete.read_structure
String? — Default: None
Details how the bases should be organized into logical reads.
demux_deplete.sample_rename_map
File? — Default: None
If 'samples' need to be renamed, provide a two-column tsv that contains at least the following columns: 'internal_id', 'external_id'. All samples will be renamed prior to analysis. Any samples described in the samplesheets that are not present in sample_rename_map will be unaltered. If this is omitted, no samples will be renamed.
demux_deplete.sort_reads
Boolean — Default: true
Output bam files will be sorted by read name.
demux_deplete.biosample_map_tsv_join.machine_mem_gb
Int — Default: 7
???
demux_deplete.biosample_map_tsv_join.prefer_first
Boolean — Default: true
???
demux_deplete.biosample_to_table.docker
String — Default: "python:slim"
???
demux_deplete.biosample_to_table.sample_table_name
String — Default: "sample"
???
demux_deplete.blastDbs
Array[File]? — Default: None
???
demux_deplete.bwaDbs
Array[File]? — Default: None
???
demux_deplete.check_terra_env.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.create_or_update_sample_tables.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.create_or_update_sample_tables.library_table_name
String — Default: "library"
???
demux_deplete.create_or_update_sample_tables.sample_table_name
String — Default: "sample"
???
demux_deplete.default_filename_keys
Array[String] — Default: ["spike_in", "batch_lib"]
???
demux_deplete.default_sample_keys
Array[String] — Default: ["amplicon_set", "control", "batch_lib", "viral_ct"]
???
demux_deplete.deplete.clear_tags
Boolean — Default: false
???
demux_deplete.deplete.cpu
Int? — Default: None
???
demux_deplete.deplete.docker
String — Default: "quay.io/broadinstitute/viral-classify:2.5.21.1"
???
demux_deplete.deplete.machine_mem_gb
Int? — Default: None
???
demux_deplete.deplete.query_chunk_size
Int? — Default: None
???
demux_deplete.deplete.tags_to_clear_space_separated
String — Default: "XT X0 X1 XA AM SM BQ CT XN OC OP"
???
demux_deplete.illumina_demux.disk_size
Int — Default: 3000
???
demux_deplete.illumina_demux.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.illumina_demux.emit_unmatched_reads_bam
Boolean — Default: false
???
demux_deplete.illumina_demux.firstTile
Int? — Default: None
???
demux_deplete.illumina_demux.flowcell
String? — Default: None
???
demux_deplete.illumina_demux.inner_barcode_predemux_trim_r1_3prime
Int — Default: 18
???
demux_deplete.illumina_demux.inner_barcode_predemux_trim_r2_3prime
Int — Default: 18
???
demux_deplete.illumina_demux.inner_barcode_predemux_trim_r2_5prime
Int — Default: 18
???
demux_deplete.illumina_demux.inner_barcode_trim_r1_right_of_barcode
Int — Default: 10
???
demux_deplete.illumina_demux.machine_mem_gb
Int? — Default: None
???
demux_deplete.illumina_demux.maxMismatches
Int? — Default: 0
???
demux_deplete.illumina_demux.maxNoCalls
Int? — Default: None
???
demux_deplete.illumina_demux.maxRecordsInRam
Int? — Default: None
???
demux_deplete.illumina_demux.minimumBaseQuality
Int? — Default: 10
???
demux_deplete.illumina_demux.minimumQuality
Int? — Default: None
???
demux_deplete.illumina_demux.minMismatchDelta
Int? — Default: None
???
demux_deplete.illumina_demux.numberOfNegativeControls
Int? — Default: None
???
demux_deplete.illumina_demux.runStartDate
String? — Default: None
???
demux_deplete.illumina_demux.sequencingCenter
String? — Default: None
???
demux_deplete.illumina_demux.threads
Int? — Default: None
???
demux_deplete.illumina_demux.tileLimit
Int? — Default: None
???
demux_deplete.instrument_model_user_specified
String? — Default: None
???
demux_deplete.min_reads_per_bam
Int — Default: 100
???
demux_deplete.minimapDbs
Array[File]? — Default: None
???
demux_deplete.multiqc_cleaned.comment
String? — Default: None
???
demux_deplete.multiqc_cleaned.config
File? — Default: None
???
demux_deplete.multiqc_cleaned.config_yaml
String? — Default: None
???
demux_deplete.multiqc_cleaned.cpu
Int? — Default: None
???
demux_deplete.multiqc_cleaned.disk_size_gb
Int? — Default: None
???
demux_deplete.multiqc_cleaned.docker
String — Default: "ghcr.io/broadinstitute/read-qc-tools:1.0.1"
???
demux_deplete.multiqc_cleaned.full_names
Boolean — Default: false
???
demux_deplete.multiqc_cleaned.interactive
Boolean — Default: true
???
demux_deplete.multiqc_cleaned.machine_mem_gb
Int? — Default: None
???
demux_deplete.multiqc_cleaned.title
String? — Default: None
???
demux_deplete.multiqc_raw.comment
String? — Default: None
???
demux_deplete.multiqc_raw.config
File? — Default: None
???
demux_deplete.multiqc_raw.config_yaml
String? — Default: None
???
demux_deplete.multiqc_raw.cpu
Int? — Default: None
???
demux_deplete.multiqc_raw.disk_size_gb
Int? — Default: None
???
demux_deplete.multiqc_raw.docker
String — Default: "ghcr.io/broadinstitute/read-qc-tools:1.0.1"
???
demux_deplete.multiqc_raw.full_names
Boolean — Default: false
???
demux_deplete.multiqc_raw.interactive
Boolean — Default: true
???
demux_deplete.multiqc_raw.machine_mem_gb
Int? — Default: None
???
demux_deplete.multiqc_raw.title
String? — Default: None
???
demux_deplete.revcomp_i5.docker
String — Default: "quay.io/broadinstitute/py3-bio:0.1.3"
???
demux_deplete.revcomp_i5.revcomp
Boolean — Default: true
???
demux_deplete.revcomp_i5_indexes
Boolean — Default: false
???
demux_deplete.samplesheet_rename_ids.new_id_col
String — Default: 'external_id'
???
demux_deplete.samplesheet_rename_ids.old_id_col
String — Default: 'internal_id'
???
demux_deplete.spike_summary.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.spike_summary.output_prefix
String — Default: "count_summary"
???
demux_deplete.spikein.cpu
Int? — Default: None
???
demux_deplete.spikein.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.spikein.machine_mem_gb
Int? — Default: None
???
demux_deplete.spikein.topNHits
Int — Default: 3
???
demux_deplete.sra_meta_prep.docker
String — Default: "quay.io/broadinstitute/viral-core:2.5.21"
???
demux_deplete.sra_title
String? — Default: None
???
demux_deplete.terra_load_biosample_data.docker
String — Default: "schaluvadi/pathogen-genomic-surveillance:api-wdl"
???
demux_deplete.cleaned_bam_uris
File?
A text file containing a string-serialized version of each File in cleaned_reads_unaligned_bams on a separate line.
demux_deplete.cleaned_bams_tiny
Array[File]
cleaned BAM files that contain less than min_reads_per_bam will be included here and omitted from cleaned_reads_unaligned_bams and cleaned_bam_uris
demux_deplete.cleaned_reads_unaligned_bams
Array[File]
Unaligned reads without human reads or PCR duplicates in BAM format. This will not include any bams that contain less than min_reads_per_bam reads.
demux_deplete.demux_commonBarcodes
Array[File]
a TSV report of all barcode counts, in descending order.
demux_deplete.demux_metrics
Array[File]
Output ExtractIlluminaBarcodes metrics file.
demux_deplete.demux_outlierBarcodes
Array[File]
???
demux_deplete.demux_viral_core_version
String
???
demux_deplete.instrument_model_inferred
String
???
demux_deplete.meta_by_filename
Map[String,Map[String,String]]
???
demux_deplete.meta_by_filename_json
File
???
demux_deplete.meta_by_sample
Map[String,Map[String,String]]
???
demux_deplete.meta_by_sample_json
File
???
demux_deplete.multiqc_report_cleaned
File
Aggregate results from QC analyses across many samples into a single report.
demux_deplete.multiqc_report_raw
File
???
demux_deplete.raw_reads_unaligned_bams
Array[File]
Unaligned reads in BAM format.
demux_deplete.read_counts_depleted
Array[Int]
???
demux_deplete.read_counts_raw
Array[Int]
A list of the read counts of each file in raw_reads_unaligned_bams
demux_deplete.run_date
String
???
demux_deplete.run_id
String
???
demux_deplete.run_info
Map[String,String]
???
demux_deplete.run_info_json
File
???
demux_deplete.spikein_counts
File
???
demux_deplete.sra_metadata
File?
???
demux_deplete.terra_library_table
File?
???
demux_deplete.terra_sample_library_map
File?
???
demux_deplete.terra_sample_metadata
File?
???