deepvariant
Run GPU-accelerated deepvariant algorithm.
Parabricks has accelerated Google Deepvariant to extensively use GPUs and finish 30x WGS analysis in 25 minutes instead of hours. The Parabricks flavor of Deepvariant is more like other command line tools that users are familiar with: It takes a BAM and reference as inputs and produces variants as outputs.
Currently, Deepvariant is supported for T4, V100, and A100 GPUs only.
$ pbrun deepvariant \
--ref Ref/Homo_sapiens_assembly38.fasta \
--in-bam mark_dups_gpu.bam \
--out-variants output.vcf
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. See the Output Comparison page for comparing the results.
# Run make_examples in parallel
seq 0 $((N_SHARDS-1)) | \
parallel --eta --halt 2 --joblog "${LOGDIR}/log" --res "${LOGDIR}" \
sudo docker run \
-v ${HOME}:${HOME} \
gcr.io/deepvariant-docker/deepvariant:"${BIN_VERSION}" \
/opt/deepvariant/bin/make_examples \
--mode calling \
--ref "${REF}" \
--reads "${BAM}" \
--examples "${OUTPUT_DIR}/examples.tfrecord@${N_SHARDS}.gz" \
--task {}
# Run call_variants in parallel
sudo docker run \
-v ${HOME}:${HOME} \
gcr.io/deepvariant-docker/deepvariant:"${BIN_VERSION}" \
/opt/deepvariant/bin/call_variants \
--outfile "${CALL_VARIANTS_OUTPUT}" \
--examples "${OUTPUT_DIR}/examples.tfrecord@${N_SHARDS}.gz" \
--checkpoint "${MODEL}"
# Run postprocess_variants in parallel
sudo docker run \
-v ${HOME}:${HOME} \
gcr.io/deepvariant-docker/deepvariant:"${BIN_VERSION}" \
/opt/deepvariant/bin/postprocess_variants \
--ref "${REF}" \
--infile "${CALL_VARIANTS_OUTPUT}" \
--outfile "${FINAL_OUTPUT_VCF}"
Run DeepVariant to convert BAM/CRAM to VCF.
Input/Output file options
- --ref REF
- --in-bam IN_BAM
- --interval-file INTERVAL_FILE
- --out-variants OUT_VARIANTS
- --pb-model-file PB_MODEL_FILE
- --proposed-variants PROPOSED_VARIANTS
Path to the reference file. (default: None)
Option is required.
Path to the input BAM/CRAM file for variant calling. (default: None)
Option is required.
Path to a BED file (.bed) for selective access. This option can be used multiple times. (default: None)
Path of vcf/g.vcf/g.vcf.gz file after variant calling. (default: None)
Option is required.
Path of non-default parabricks model file for deepvariant. (default: None)
Path of VCF file which has proposed variants for make examples stage. (default: None)
Options specific to this tool
- --disable-use-window-selector-model
- --gvcf
- --norealign-reads
- --sort-by-haplotypes
- --keep-duplicates
- --vsc-min-count-snps VSC_MIN_COUNT_SNPS
- --vsc-min-count-indels VSC_MIN_COUNT_INDELS
- --vsc-min-fraction-snps VSC_MIN_FRACTION_SNPS
- --vsc-min-fraction-indels VSC_MIN_FRACTION_INDELS
- --min-mapping-quality MIN_MAPPING_QUALITY
- --min-base-quality MIN_BASE_QUALITY
- --mode MODE
- --alt-aligned-pileup ALT_ALIGNED_PILEUP
- --variant-caller VARIANT_CALLER
- --add-hp-channel
- --parse-sam-aux-fields
- --use-hp-information
- --use-wes-model
- -L INTERVAL, --interval INTERVAL
Change the window selector model from Allele Count Linear to Variant Reads. This option will increase the accuracy and runtime. (default: None)
Generate variant calls in gvcf format. (default: None)
Do not locally realign reads before calling variants. Reads longer than 500 base pairs are never realigned. (default: None)
Reads are sorted by haplotypes (using HP tag) (default: None)
Keep reads that are duplicate. (default: None)
SNP alleles occurring at least this many times in our AlleleCount will be advanced as candidates. (default: 2)
Indel alleles occurring at least this many times in our AlleleCount will be advanced as candidates. (default: 2)
SNP alleles occurring at least this fraction of all counts in our AlleleCount will be advanced as candidates. (default: 0.12)
Indel alleles occurring at least this fraction of all counts in our AlleleCount will be advanced as candidates. (default: None)
By 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)
Minimum base quality. This field indicates that we are enforcing 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)
Value can be one of [shortread, pacbio, ont]. By default, it is shortread. If mode is set to pacbio, the following defaults are used: --norealign-reads, --alt-aligned-pileup diff_channels, --vsc-min-fraction-indels 0.12. If mode is set to ont, the following defaults are used: -norealign-reads, --variant-caller VCF_CANDIDATE_IMPORTER. (default: shortread)
Value can be one of [none, diff_channels]. Include alignments of reads against each candidate alternate allele in the pileup image. Default is none which turns this feature off. (default: None)
Value 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 (default: None)
Add another channel to represent HP tags per read. (default: None)
Auxiliary fields of the BAM/CRAM records are parsed. Needed by --sort-by-haplotypes by --add-hp-channel. (default: None)
If passed, both --sort-by-haplotypes and --parse-sam-aux-fields will be set to true, only used in PACBIO mode. (default: None)
If passed, WES model file will be used. Only used in shortread mode. (default: None)
Interval 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" (default: None)
Common options:
- --logfile LOGFILE
- --tmp-dir TMP_DIR
- --with-petagene-dir WITH_PETAGENE_DIR
- --keep-tmp
- --license-file LICENSE_FILE
- --no-seccomp-override
- --version
Path to the log file. If not specified, messages will only be written to the standard error output. (default: None)
Full path to the directory where temporary files will be stored.
Full 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 (default: None)
Do not delete the directory storing temporary files after completion.
Path to license file license.bin if not in the installation directory.
Do not override seccomp options for docker (default: None).
View compatible software versions.
GPU options:
- --num-gpus NUM_GPUS
- --gpu-devices GPU_DEVICES
Number of GPUs to use for a run. GPUs 0..(NUM_GPUS-1) will be used.
GPU devices to use for a run. By default, all GPU devices will be used.
To use specific GPU devices, enter a comma-separated list of GPU device
numbers. Possible device numbers can be found by examining the output of
the nvidia-smi
command. For example, using --gpu-devices 0,1
would only use the first two GPUs.