haplotypecaller

Run a GPU-accelerated haplotypecaller.

This tool applies an accelerated GATK CollectMultipleMetrics for assessing the metrics of a BAM file, such as including alignment success, quality score distributions, GC bias, and sequencing artifacts. This functions as a ‘meta-metrics’ tool, and can run any combination of the available metrics tools in GATK to assess overall how well a sequencing run has performed. The available metrics tools (PROGRAMs) can be found in the command line example below.

You can provide an optional BQSR report to fix the BAM, similar to ApplyBQSR. In this case, the updated base qualities will be used.

Refer to the haplotypecaller 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.
2
docker 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 haplotypecaller \
6
    --ref /workdir/${REFERENCE_FILE} \
7
    --in-bam /workdir/${INPUT_BAM_FILE} \
8
    --in-recal-file /workdir/${INPUT_RECAL_FILE} \
9
    --out-variants /outputdir/${OUTPUT_VCF_FILE}

Compatible GATK4 Command

The commands below are the GATK4 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 ApplyBQSR Step
2
$ gatk ApplyBQSR \
3
    --java-options -Xmx30g \
4
    -R Ref/Homo_sapiens_assembly38.fasta \
5
    -I mark_dups_cpu.bam \
6
    --bqsr-recal-file recal_file.txt \
7
    -O cpu_nodups_BQSR.bam
8
9
#Run Haplotype Caller
10
$ gatk HaplotypeCaller \
11
    --java-options -Xmx30g \
12
    --input cpu_nodups_BQSR.bam \
13
    --output result_cpu.vcf \
14
    --reference Ref/Homo_sapiens_assembly38.fasta \
15
    --native-pair-hmm-threads 16

Source of Mismatches

While the Parabricks HaplotypeCaller does not lose any accuracy in functionality when compared with the GATK HaplotypeCaller there are a few implementation differences that can result in slightly different output files.

• Random generator

The GATK HapltoypeCaller calls the same random generator in read downsampling and QualByDepth annotation computation. The Parabricks HaplotypeCaller calls two separate random number generators to allow for parallel computing.

• Log10 implementation

The log10 operation is used to compute the haplotype penalty score. The Java implementation java.lang.Math.log10() is slightly different from the C++ `cmath library, giving rise to small mismatches in computed scores. Different haplotypes might be selected because of this.

• AVX

GATK calls Intel GKL (Genomics Kernel Library) which contains optimized versions of compute kernels (e.g. Smith-Waterman, PairHMM) to run on Intel Architecture (AVX, AVX2, AVX-512, and multicore). However, some SIMD intrinsics such as mm512_mul_ps` can generate a slightly different output when compared with the serial operations which our GPU implementation is based on.

• HashMap, HashSet iteration

GATK can give non-deterministic outputs because iterating over a Java HashMap or HashSet does not preserve order. Parabricks always gives deterministic output by using a hash table that preserves the insertion order (similar to LinkedHashMap in Java).

Several original HaplotypeCaller options are supported by Parabricks. To specify the inclusion or exclusion of several haplotype caller annotations, use the --haplotypecaller-options option:

1
$ |sample_docker_cmd|
2
     --workdir /workdir \
3
     |docker_image| \
4
     pbrun haplotypecaller \
5
      ...
6
      --haplotypecaller-options '-min-pruning 4 -A AS_BaseQualityRankSumTest -A TandemRepeat'
7
      ...

Annotations may be excluded in the same manner using the -AX option. There should be a space between the -A/-AX flag and its value.

The following are supported options and their allowed values:

• -A
  • AS_BaseQualityRankSumTest
  • AS_FisherStrand
  • AS_InbreedingCoeff
  • AS_MappingQualityRankSumTest
  • AS_QualByDepth
  • AS_RMSMappingQuality
  • AS_ReadPosRankSumTest
  • AS_StrandOddsRatio
  • AssemblyComplexity
  • BaseQualityRankSumTest
  • ChromosomeCounts
  • ClippingRankSumTest
  • Coverage
  • DepthPerAlleleBySample
  • DepthPerSampleHC
  • ExcessHet
  • FisherStrand
  • InbreedingCoeff
  • MappingQualityRankSumTest
  • QualByDepth
  • RMSMappingQuality
  • ReadPosRankSumTest
  • ReferenceBases
  • StrandBiasBySample
  • StrandOddsRatio
  • TandemRepeat
• -AX
  • (same as for the -A option)
• —output-mode
  • EMIT_VARIANTS_ONLY
  • EMIT_ALL_CONFIDENT_SITES
  • EMIT_ALL_ACTIVE_SITES
• -max-reads-per-alignment-start
  • a positive integer
• -min-dangling-branch-length
  • a positive integer
• -min-pruning
  • a positive integer
• -pcr-indel-model
  • NONE
  • HOSTILE
  • AGGRESSIVE
  • CONSERVATIVE
• -standard-min-confidence-threshold-for-calling
  • a positive integer

Options