deepvariant

View as Markdown

Run a GPU-accelerated DeepVariant algorithm.

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

What is DeepVariant?

DeepVariant is a deep learning based variant caller developed by Google for germline variant calling of high-throughput sequencing data. It works by taking aligned sequencing reads in BAM/CRAM format and utilizes a convolutional neural network (CNN) to classify the locus into true underlying genomic variation or sequencing error. DeepVariant can therefore call single nucleotide variants (SNVs) and insertions/deletions (InDels) from sequencing data at high accuracy in germline samples.

Why DeepVariant?

DeepVariant’s approach is able to detect variants that are often missed by traditional (for example Bayesian) variant callers, and is known to reduce false positives. It offers several advantages over similar tools, including its ability to detect a wide range of variants with high accuracy, its scalability for analyzing large datasets, and its open source availability. Additionally, its deep learning-based approach allows it to provide better support for different sequencing platforms, as it can be retrained to provide higher accuracy for specific protocols or research areas.

How Should I Use DeepVariant?

DeepVariant is designed for use as a germline variant caller that can apply different models trained for specific sample types (such as whole genome and whole exome samples) to yield higher accuracy results. DeepVariant can be deployed within NVIDIA’s Parabricks software suite, which is designed for accelerated secondary analysis in genomics, bringing industry standard tools and workflows from CPU to GPU, and delivering the same results at up to 60x faster runtimes. A 30x whole genome can be run through DeepVariant in as little as 8 minutes on an NVIDIA DGX station, compared to 5 hours on a CPU instance (m5.24xlarge, 96 x vCPU). DeepVariant in Parabricks is used in the same way as other command line tools that users are familiar with: It takes a BAM/CRAM and the reference genome as inputs and produces the variants (a VCF file) as outputs. Currently, DeepVariant is supported for T4 and newer GPUs out of the box.

In version 3.8 the —run-partition option was added, which can lead to a significant speed increase. However, using the —run-partition, —proposed-variants, and —gvcf options at the same time will lead to a substantial slowdown. A warning will be issued and the —run-partition option will be ignored.

Available Operating Modes

Parabricks DeepVariant can run in one of three operating modes:

  1. shortread
  2. PacBio
  3. ONT

See the —mode option below.

Quick Start

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 \
6 --ref /workdir/${REFERENCE_FILE} \
7 --in-bam /workdir/${INPUT_BAM} \
8 --out-variants /outputdir/${OUTPUT_VCF}

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.

1sudo docker run \
2--volume <INPUT_DIR>:/input \
3--volume <OUTPUT_DIR>:/output \
4google/deepvariant:1.9.0 \
5/opt/deepvariant/bin/run_deepvariant \
6--model_type WGS \
7--ref /input/${REFERENCE_FILE} \
8--reads /input/${INPUT_BAM} \
9--output_vcf /output/${OUTPUT_VCF} \
10--num_shards $(nproc) \
11--disable_small_model=true \
12--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

Parabricks DeepVariant supports the following models:

  1. Short-read WGS
  2. Short-read WES
  3. PacBio
  4. ONT

Parabricks DeepVariant ships with model files for T4 and all GPUs that are Ampere or newer. Since v4.7, these model files are created using TensorRT 10.14.1.48.

Source of Mismatches

While Parabricks DeepVariant does not lose any accuracy in functionality when compared with Google DeepVariant there is one reason that can result in different output files.

  • CNN Inference

Google DeepVariant uses a CNN (convolutional neural network) to predict the possibilities of each variant candidate. The model is trained, and does inference through, Keras. In Parabricks DeepVariant we convert this Keras model to an engine file with TensorRT to perform accelerated deep learning inferencing on NVIDIA GPUs. Because of the optimizations from TensorRT, there is a small difference in the final possibility scores after inferencing (10^-5), which could cause a few different variants in the final VCF output. Based on current observations, the mismatches only happen to RefCalls with a quality score of zero.

Options

TypeNameRequired?Description
I/O--ref REFYesPath to the reference file.
I/O--in-bam IN_BAMYesPath to the input BAM/CRAM file for variant calling.
I/O--interval-file INTERVAL_FILENoPath to a BED file (.bed) for selective access. This option can be used multiple times.
I/O--out-variants OUT_VARIANTSYesPath of the vcf/vcf.gz/g.vcf/g.vcf.gz file after variant calling.
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--proposed-variants PROPOSED_VARIANTSNoPath of the vcf.gz file, which has proposed variants for the make examples stage.
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.
Tool-L INTERVAL, --interval INTERVALNoInterval within which to call the variants from the BAM/CRAM file. 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").
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.
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)