deepsomatic

View as Markdown

GPU-accelerated DeepSomatic

What is DeepSomatic?

DeepSomatic builds on the deep learning-based variant caller DeepVariant. It processes aligned reads from tumor and normal samples (in BAM or CRAM format), generates pileup image tensors, classifies these tensors using a convolutional neural network, and outputs somatic variants in standard VCF or gVCF files.

DeepSomatic is designed for somatic variant calling using tumor-normal sequencing data.

Parabricks has enhanced Google DeepSomatic to leverage GPUs extensively. The Parabricks version of DeepSomatic operates similarly to other common command line tools: it accepts two BAM files and a reference file as inputs and generates variants in a VCF file as output.

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

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 deepsomatic \
6 --ref /workdir/${REFERENCE_FILE} \
7 --in-tumor-bam /workdir/${INPUT_TUMOR_BAM} \
8 --in-normal-bam /workdir/${INPUT_NORMAL_BAM} \
9 --out-variants /outputdir/${OUTPUT_VCF}

Compatible Google DeepSomatic 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.

1docker run \
2--interactve \
3--tty \
4--rm \
5--volume ${INPUT_DIR}:${INPUT_DIR} \
6--volume ${OUTPUT_DIR}:${OUTPUT_DIR} \
7--workdir /workdir google/deepsomatic:1.9.0 \
8run_deepsomatic \
9--ref ${REFERENCE_FILE} \
10--reads_tumor ${TUMOR_BAM} \
11--reads_normal ${NORMAL_BAM} \
12--model_type=WGS \
13--output_vcf ${OUTPUT_VCF} \
14--make_examples_extra_args "ws_use_window_selector_model=true" \
15--num_shards=$(nproc)

Models for Additional GPUs

Parabricks DeepSomatic supports the following models:

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

Parabricks DeepSomatic 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 DeepSomatic does not lose any accuracy in functionality when compared with Google DeepSomatic there is one reason that can result in different output files.

  • CNN Inference

Google DeepSomatic 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 DeepSomatic 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-tumor-bam IN_TUMOR_BAMYesPath to the input tumor BAM/CRAM file for somatic variant calling.
I/O--in-normal-bam IN_NORMAL_BAMYesPath to the input normal BAM/CRAM file for somatic 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 deepsomatic.
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--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--vsc-min-count-snps VSC_MIN_COUNT_SNPSNoSNP alleles occurring at least this many times in the AlleleCount will be advanced as candidates.
Tool--vsc-min-count-indels VSC_MIN_COUNT_INDELSNoIndel alleles occurring at least this many times in the AlleleCount will be advanced as candidates.
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.
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.
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--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 passed, the WES model file will be used. Only used in shortread mode.
Tool--pileup-image-width PILEUP_IMAGE_WIDTHNoPileup image width. Only change this if you know your model supports this width.
Tool--no-channel-insert-sizeNoIf True, don't add insert_size channel into the pileup image. (default: False)
Tool--track-ref-readsNoIf True, 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--vsc-max-fraction-indels-for-non-target-sample VSC_MAX_FRACTION_INDELS_FOR_NON_TARGET_SAMPLENoMaximum fraction of indels allowed in non-target samples. (default: 0.5)
Tool--vsc-max-fraction-snps-for-non-target-sample VSC_MAX_FRACTION_SNPS_FOR_NON_TARGET_SAMPLENoMaximum fraction of snps allowed in non-target samples. (default: 0.5)
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--partition-size PARTITION_SIZENoThe maximum number of basepairs allowed in a region before splitting it into multiple smaller subregions.
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)