deepvariant_germline

View as Markdown

Given one or more pairs of FASTQ files, you can run the germline variant tool to generate BAM, variants, duplicate metrics and recal.

The deepvariant germline tool includes alignment, sorting, and marking as well as the DeepVariant variant caller.

The inputs are BWA-indexed reference files and pair-ended FASTQ files. The outputs of this tool are the following:

  • Aligned, co-ordinate sorted, duplicated marked BAM

  • Variants in vcf/g.vcf/g.vcf.gz format

Refer to the deepvariant_germline Reference section for a detailed listing of all available options.

Quick Start

The following command runs the DeepVariant tool.

1# This command assumes all the inputs are in the current working directory and all the outputs go to the same place.
2docker run --rm --gpus all --volume $(pwd):/workdir --volume $(pwd):/outputdir \
3 --workdir /workdir \
4 nvcr.io/nvidia/clara/clara-parabricks:4.7.1-1 \
5 pbrun deepvariant_germline \
6 --ref /workdir/${REFERENCE_FILE} \
7 --in-fq /workdir/${INPUT_FASTQ_1} /workdir/${INPUT_FASTQ_2} \
8 --out-variants /outputdir/${OUTPUT_VCF_FILE} \
9 --out-bam /outputdir/${OUTPUT_BAM_FILE}

Compatible Google DeepVariant Commands

The commands below are the Google counterpart of the Parabricks command above. The output from these commands will be identical to the output from the above command. Refer to the Output Comparison page for comparing the results.

1# Run bwa-mem and pipe output to create sorted BAM
2$ bwa mem \
3 -t 32 \
4 -K 10000000 \
5 -R '@RG\tID:sample_rg1\tLB:lib1\tPL:bar\tSM:sample\tPU:sample_rg1' \
6 <INPUT_DIR>/${REFERENCE_FILE} \
7 <INPUT_DIR>/${INPUT_FASTQ_1} <INPUT_DIR>/${INPUT_FASTQ_2} | \
8 gatk SortSam \
9 --java-options -Xmx30g \
10 --MAX_RECORDS_IN_RAM 5000000 \
11 -I /dev/stdin \
12 -O cpu.bam \
13 --SORT_ORDER coordinate
14
15# Mark Duplicates
16$ gatk MarkDuplicates \
17 --java-options -Xmx30g \
18 -I cpu.bam \
19 -O mark_dups_cpu.bam \
20 -M metrics.txt
21
22# Run deepvariant
23BIN_VERSION="1.9.0"
24sudo docker run \
25 -v "${PWD}":"/input" \
26 -v "${PWD}/output":"/output" \
27 -v "${PWD}/Ref":"/reference" \
28 google/deepvariant:"${BIN_VERSION}" \
29 /opt/deepvariant/bin/run_deepvariant \
30 --model_type WGS \
31 --ref /reference/Homo_sapiens_assembly38.fasta \
32 --reads /output/${OUTPUT_BAM_FILE} \
33 --output_vcf /output/"${OUTPUT_VCF_FILE}" \
34 --num_shards $(nproc) \
35 --disable_small_model=true \
36 --make_examples_extra_args "ws_use_window_selector_model=true"

In Google DeepVariant, the small model is enabled by default and must be explicitly disabled (with --disable_small_model=true). In Parabricks DeepVariant, the small model is opt-in and must be explicitly enabled (with --enable-small-model).

Variants called by the small model will have an additional MID field in their VCF record, which denotes which model called the variant. This is consistent with VCF files produced by Google DeepVariant.

Models for Additional GPUs

See the DeepVariant Models for additional GPUs section for instructions on downloading and using model files for additional GPUs.

Options

TypeNameRequired?Description
I/O--ref REFYesPath to the reference file.
I/O--in-fq [IN_FQ ...]NoPath to the pair-ended FASTQ files followed by optional read groups with quotes (Example: "@RG\\tID:foo\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:foo"). The files must be in fastq or fastq.gz format. All sets of inputs should have a read group; otherwise, none should have a read group, and it will be automatically added by the pipeline. This option can be repeated multiple times. Example 1: --in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz --in-fq sampleX_2_1.fastq.gz sampleX_2_2.fastq.gz. Example 2: --in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz "@RG\\tID:foo\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:unit1" --in-fq sampleX_2_1.fastq.gz sampleX_2_2.fastq.gz "@RG\\tID:foo2\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:unit2". For the same sample, Read Groups should have the same sample name (SM) and a different ID and PU.
I/O--in-se-fq [IN_SE_FQ ...]NoPath to the single-ended FASTQ file followed by optional read group with quotes (Example: "@RG\\tID:foo\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:foo"). The file must be in fastq or fastq.gz format. Either all sets of inputs have a read group, or none should have one, and it will be automatically added by the pipeline. This option can be repeated multiple times. Example 1: --in-se-fq sampleX_1.fastq.gz --in-se-fq sampleX_2.fastq.gz . Example 2: --in-se-fq sampleX_1.fastq.gz "@RG\\tID:foo\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:unit1" --in-se-fq sampleX_2.fastq.gz "@RG\\tID:foo2\\tLB:lib1\\tPL:bar\\tSM:sample\\tPU:unit2" . For the same sample, Read Groups should have the same sample name (SM) and a different ID and PU.
I/O--knownSites KNOWNSITESNoPath to a known indels file. The file must be in vcf.gz format. This option can be used multiple times.
I/O--interval-file INTERVAL_FILENoPath to an interval file in one of these formats: Picard-style (.interval_list or .picard), GATK-style (.list or .intervals), or BED file (.bed). This option can be used multiple times.
I/O--pb-model-file PB_MODEL_FILENoPath to a non-default parabricks model file for deepvariant.
I/O--pb-small-model-file PB_SMALL_MODEL_FILENoPath to a non-default parabricks model file for the small model.
I/O--out-recal-file OUT_RECAL_FILENoPath of the report file after Base Quality Score Recalibration.
I/O--out-bam OUT_BAMYesPath of BAM file after marking duplicates.
I/O--out-variants OUT_VARIANTSYesPath of the vcf/vcf.gz/gvcf/gvcf.gz file after variant calling.
I/O--out-duplicate-metrics OUT_DUPLICATE_METRICSNoPath of a duplicate metrics file after marking duplicates.
I/O--proposed-variants PROPOSED_VARIANTSNoPath of the VCF file, which has proposed variants for the make examples stage.
Tool--max-read-length MAX_READ_LENGTHNoMaximum read length/size (i.e., sequence length) used for bwa and filtering FASTQ input. (default: 480)
Tool--min-read-length MIN_READ_LENGTHNoMinimum read length/size (i.e., sequence length) used for bwa and filtering FASTQ input. (default: 1)
Tool-L INTERVAL, --interval INTERVALNoInterval within which to call bqsr from the input reads. All intervals will have a padding of 100 to get read records, and overlapping intervals will be combined. Interval files should be passed using the --interval-file option. This option can be used multiple times (e.g. "-L chr1 -L chr2:10000 -L chr3:20000+ -L chr4:10000-20000").
Tool--bwa-options BWA_OPTIONSNoPass supported bwa mem options as one string. The current original bwa mem supported options are: -M, -Y, -C, -T, -B, -U, -L, -I, and -K (e.g. --bwa-options="-M -Y").
Tool--no-warningsNoSuppress warning messages about system thread and memory usage.
Tool--filter-flag FILTER_FLAGNoDon't generate SAM entries in the output if the entry's flag's meet this criteria. Criteria: (flag & filter != 0). (default: 0)
Tool--skip-multiple-hitsNoFilter SAM entries whose length of SA is not 0.
Tool--align-onlyNoGenerate output BAM after bwa-mem. The output will not be co-ordinate sorted or duplicates will not be marked.
Tool--no-markdupsNoDo not perform the Mark Duplicates step. Return BAM after sorting.
Tool--markdups-single-ended-start-endNoMark duplicate on single-ended reads by 5' and 3' end.
Tool--ignore-rg-markdups-single-endedNoIgnore read group info in marking duplicates on single-ended reads. This option must be used with `--markdups-single-ended-start-end`.
Tool--fix-mateNoAdd mate cigar (MC) and mate quality (MQ) tags to the output file.
Tool--markdups-assume-sortorder-querynameNoAssume the reads are sorted by queryname for marking duplicates. This will mark secondary, supplementary, and unmapped reads as duplicates as well. This flag will not impact variant calling while increasing processing times.
Tool--markdups-picard-version-2182NoAssume marking duplicates to be similar to Picard version 2.18.2.
Tool--monitor-usageNoMonitor approximate CPU utilization and host memory usage during execution.
Tool--optical-duplicate-pixel-distance OPTICAL_DUPLICATE_PIXEL_DISTANCENoThe maximum offset between two duplicate clusters in order to consider them optical duplicates. Ignored if --out-duplicate-metrics is not passed.
Tool--read-group-sm READ_GROUP_SMNoSM tag for read groups in this run.
Tool--read-group-lb READ_GROUP_LBNoLB tag for read groups in this run.
Tool--read-group-pl READ_GROUP_PLNoPL tag for read groups in this run.
Tool--read-group-id-prefix READ_GROUP_ID_PREFIXNoPrefix for the ID and PU tags for read groups in this run. This prefix will be used for all pairs of FASTQ files in this run. The ID and PU tags will consist of this prefix and an identifier, that will be unique for a pair of FASTQ files.
Tool--standalone-bqsrNoRun standalone BQSR.
Tool--disable-use-window-selector-modelNoChange the window selector model from Allele Count Linear to Variant Reads. This option will increase the accuracy and runtime.
Tool--gvcfNoGenerate variant calls in .gvcf format.
Tool--norealign-readsNoDo not locally realign reads before calling variants. Reads longer than 500 bp are never realigned.
Tool--sort-by-haplotypesNoReads are sorted by haplotypes (using HP tag).
Tool--keep-duplicatesNoKeep reads that are duplicate.
Tool--keep-legacy-allele-counter-behaviorNoIf specified, the behavior in this commit is reverted: 'https://github.com/google/deepvariant/commit/fbde0674639a28cb9e8004c7a01bbe25240c7d46'. We do not recommend setting this flag to True.
Tool--vsc-min-count-snps VSC_MIN_COUNT_SNPSNoSNP alleles occurring at least this many times in the AlleleCount will be advanced as candidates. (default: 2)
Tool--vsc-min-count-indels VSC_MIN_COUNT_INDELSNoIndel alleles occurring at least this many times in the AlleleCount will be advanced as candidates. (default: 2)
Tool--vsc-min-fraction-snps VSC_MIN_FRACTION_SNPSNoSNP alleles occurring at least this fraction of all counts in the AlleleCount will be advanced as candidates. (default: 0.12)
Tool--vsc-min-fraction-indels VSC_MIN_FRACTION_INDELSNoIndel alleles occurring at least this fraction of all counts in the AlleleCount will be advanced as candidates.
Tool--min-mapping-quality MIN_MAPPING_QUALITYNoBy default, reads with any mapping quality are kept. Setting this field to a positive integer i will only keep reads that have a MAPQ >= i. Note this only applies to aligned reads. (default: 5)
Tool--min-base-quality MIN_BASE_QUALITYNoMinimum base quality. This option enforces a minimum base quality score for alternate alleles. Alternate alleles will only be considered if all bases in the allele have a quality greater than min_base_quality. (default: 10)
Tool--mode MODENoValue can be one of [shortread, pacbio, ont]. By default, it is shortread. (default: shortread)
Tool--alt-aligned-pileup ALT_ALIGNED_PILEUPNoValue can be one of [none, diff_channels]. Include alignments of reads against each candidate alternate allele in the pileup image.
Tool--variant-caller VARIANT_CALLERNoValue can be one of [VERY_SENSITIVE_CALLER, VCF_CANDIDATE_IMPORTER]. The caller to use to make examples. If you use VCF_CANDIDATE_IMPORTER, it implies force calling. Default is VERY_SENSITIVE_CALLER.
Tool--add-hp-channelNoAdd another channel to represent HP tags per read.
Tool--parse-sam-aux-fieldsNoAuxiliary fields of the BAM/CRAM records are parsed. If either --sort-by-haplotypes or --add-hp-channel is set, then this option must also be set.
Tool--use-wes-modelNoIf specified, the WES model file will be used. Only used in shortread mode.
Tool--include-med-dpNoIf specified, include MED_DP in the output gVCF records.
Tool--normalize-readsNoIf specified, allele counter left align INDELs for each read.
Tool--pileup-image-width PILEUP_IMAGE_WIDTHNoPileup image width. Only change this if you know your model supports this width. (default: 221)
Tool--channel-insert-sizeNoIf specified, add insert_size channel into the pileup image. By default, this parameter is true in WGS and WES mode.
Tool--no-channel-insert-sizeNoIf specified, don't add insert_size channel into the pileup image.
Tool--max-read-size-512NoAllow deepvariant to run on reads of size 512bp. The default size is 320 bp.
Tool--prealign-helper-threadNoUse an extra thread for the pre-align step. This parameter is more useful when --max-reads-size-512 is set.
Tool--track-ref-readsNoIf specified, allele counter keeps track of reads supporting ref. By default, allele counter keeps a simple count of the number of reads supporting ref.
Tool--phase-readsNoCalculate phases and add HP tag to all reads automatically.
Tool--dbg-min-base-quality DBG_MIN_BASE_QUALITYNoMinimum base quality in a k-mer sequence to consider. (default: 15)
Tool--ws-min-windows-distance WS_MIN_WINDOWS_DISTANCENoMinimum distance between candidate windows for local assembly. (default: 80)
Tool--channel-gc-contentNoIf specified, add gc_content channel into the pileup image.
Tool--channel-hmer-deletion-qualityNoIf specified, add hmer deletion quality channel into the pileup image.
Tool--channel-hmer-insertion-qualityNoIf specified, add hmer insertion quality channel into the pileup image.
Tool--channel-non-hmer-insertion-qualityNoIf specified, add non-hmer insertion quality channel into the pileup image.
Tool--skip-bq-channelNoIf specified, ignore base quality channel.
Tool--aux-fields-to-keep AUX_FIELDS_TO_KEEPNoComma-delimited list of auxiliary BAM fields to keep. Values can be [HP, tp, t0]. (default: HP)
Tool--vsc-min-fraction-hmer-indels VSC_MIN_FRACTION_HMER_INDELSNoHmer Indel alleles occurring at least this be advanced as candidates. Use this threshold if hmer and non-hmer indels should be treated differently (Ultima reads)Default will use the same threshold for hmer and non-hmer indels, as defined in vsc_min_fraction_indels.
Tool--vsc-turn-on-non-hmer-ins-proxy-supportNoAdd read-support from soft-clipped reads and other non-hmer insertion alleles,to the most frequent non-hmer insertion allele.
Tool--consider-strand-biasNoIf specified, expect SB field in calls and write it to the VCF file.
Tool--p-error P_ERRORNoBasecalling error for reference confidence model. (default: 0.001)
Tool--channel-ins-sizeNoIf specified, add another channel to represent size of insertions (good for flow-based sequencing).
Tool--max-ins-size MAX_INS_SIZENoMax insertion size for ins_size_channel, larger insertions will look like max (have max intensity). (default: 10)
Tool--disable-group-variantsNoIf using vcf_candidate_importer and multi-allelic sites are split across multiple lines in VCF, add this flag so that variants are not grouped when transforming CallVariantsOutput to Variants.
Tool--filter-reads-too-longNoIgnore all input BAM reads with size > 512bp.
Tool--haploid-contigs HAPLOID_CONTIGSNoOptional list of non autosomal chromosomes. For all listed chromosomes HET probabilities are not considered.
Tool--enable-small-modelNoIf supplied, enable the small model.
Performance--bwa-nstreams BWA_NSTREAMSNoNumber of streams per GPU to use; note: more streams increases device memory usage. Default is auto which will try to use an optimal amount of device memory. (default: auto)
Performance--bwa-cpu-thread-pool BWA_CPU_THREAD_POOLNoNumber of threads to devote to CPU thread pool *per GPU*. (default: 16)
Performance--num-cpu-threads-per-stage NUM_CPU_THREADS_PER_STAGENo(Same as above) Number of threads to devote to CPU thread pool *per GPU*.
Performance--bwa-normalized-queue-capacity BWA_NORMALIZED_QUEUE_CAPACITYNoNormalized capacity for alignment work queues, use a lower value if CPU memory is low; final value will be <number of GPUs> * <normalized capacity>. (default: 10)
Performance--bwa-primary-cpus BWA_PRIMARY_CPUSNoNumber of primary CPU threads driving its associated thread pool. Default is auto which will use 1 primary thread with its associated thread pool per GPU. (default: auto)
Performance--cigar-on-gpuNoRun CIGAR generation on GPU. Helpful in CPU bound conditions. (default is on CPU).
Performance--gpuwriteNoUse one GPU to accelerate writing final BAM/CRAM.
Performance--gpuwrite-deflate-algo GPUWRITE_DEFLATE_ALGONoChoose the nvCOMP DEFLATE algorithm to use with --gpuwrite. Note these options do not correspond to CPU DEFLATE options. Valid options are 1, 2, and 4. Option 1 is fastest, while options 2 and 4 have progressively lower throughput but higher compression ratios. The default value is 1 when the user does not provide an input (i.e., None).
Performance--gpusortNoUse GPUs to accelerate sorting and marking.
Performance--use-gdsNoUse GPUDirect Storage (GDS) to enable a direct data path for direct memory access (DMA) transfers between GPU memory and storage. Must be used concurrently with `--gpuwrite`. Please refer to Parabricks Documentation > Best Performance for information on how to set up and use GPUDirect Storage.
Performance--memory-limit MEMORY_LIMITNoSystem memory limit in GBs during sorting and postsorting. By default, the limit is half of the total system memory. (default: 62)
Performance--low-memoryNoUse low memory mode; will lower the number of streams per GPU.
Performance--num-cpu-threads-per-stream NUM_CPU_THREADS_PER_STREAMNoNumber of CPU threads to use per stream. (default: 6)
Performance--num-streams-per-gpu NUM_STREAMS_PER_GPUNoNumber of streams to use per GPU. Default is 'auto' which will try to use an optimal amount of streams based on the GPU. (default: auto)
Performance--run-partitionNoDivide the whole genome into multiple partitions and run multiple processes at the same time, each on one partition.
Performance--gpu-num-per-partition GPU_NUM_PER_PARTITIONNoNumber of GPUs to use per partition.
Performance--max-reads-per-partition MAX_READS_PER_PARTITIONNoThe maximum number of reads per partition that are considered before following processing such as sampling and realignment. (default: 1500)
Performance--partition-size PARTITION_SIZENoThe maximum number of basepairs allowed in a region before splitting it into multiple smaller subregions. (default: 1000)
Performance--use-tf32NoEnable inference optimization using Tensor Float 32(TF32) on ampere+ gpu. Note that this might introduce a few mismatches in the output VCF.
Performance--read-from-tmp-dirNoRunning variant caller reading from bin files generated by Aligner and sort. Run postsort in parallel. This option will increase device memory usage.
Runtime--verboseNoEnable verbose output.
Runtime--x3NoShow full command line arguments.
Runtime--logfile LOGFILENoPath to the log file. If not specified, messages will only be written to the standard error output.
Runtime--tmp-dir TMP_DIRNoFull path to the directory where temporary files will be stored. (default: .)
Runtime--with-petagene-dir WITH_PETAGENE_DIRNoFull path to the PetaGene installation directory. By default, this should have been installed at /opt/petagene. Use of this option also requires that the PetaLink library has been preloaded by setting the LD_PRELOAD environment variable. Optionally set the PETASUITE_REFPATH and PGCLOUD_CREDPATH environment variables that are used for data and credentials. Optionally set the PetaLinkMode environment variable that is used to further configure PetaLink, notably setting it to "+write" to enable outputting compressed BAM and .fastq files.
Runtime--keep-tmpNoDo not delete the directory storing temporary files after completion.
Runtime--no-seccomp-overrideNoDo not override seccomp options for docker.
Runtime--versionNoView compatible software versions.
Runtime--preserve-file-symlinksNoOverride default behavior to keep file symlinks intact and *not* resolve the symlink.
Runtime--num-gpus NUM_GPUSNoNumber of GPUs to use for a run. (default: 1)

The —in-fq option takes the names of two FASTQ files, optionally followed by a quoted read group. The FASTQ filenames must not start with a hyphen.