mutectcaller

GPU accelerated mutect2. mutectcaller supports tumor or tumor-normal variant calling. The figure below shows the high-level functionality of mutectcaller. All dotted boxes indicate optional data, with some constraints.

../../_images/parabricks-web-graphics-1259949-r2-mutecaller.svg

Quick Start

$ pbrun mutectcaller \
    --ref Ref/Homo_sapiens_assembly38.fasta \
    --tumor-name tumor \
    --in-tumor-bam tumor.bam \
    --in-normal-bam normal.bam \
    --normal-name normal \
    --out-vcf output.vcf

Compatible GATK4 Command

The command below is the GATK4 counterpart of the Parabricks command above. The output from this command will be identical to the output from the above command. See the Output Comparison page for comparing the results.

$ gatk Mutect2 \
    -R Ref/Homo_sapiens_assembly38.fasta \
    --input tumor.bam \
    --tumor-sample tumor \
    --input normal.bam \
    --normal-sample normal \
    --output output.vcf

Mutect2 with Panel of Normals

Parabricks Mutect2 from version 3.7.0-1 has started supporting Panel of Normals to process variants. There are three steps involved:

  • prepon

  • running mutectcaller with the index generated by prepon

  • postpon, updating the vcf with pon information

#The first command will generate input.pon that should be done once for the input.vcf.gz
$ pbrun prepon --in-pon-file input.vcf.gz

#Run mutectcaller with the pon index
$ pbrun mutectcaller \
    --ref Ref/Homo_sapiens_assembly38.fasta \
    --tumor-name tumor \
    --in-tumor-bam tumor.bam \
    --in-normal-bam normal.bam \
    --pon input.vcf.gz \
    --normal-name normal \
    --out-vcf output.vcf

#Add the annotation to the output.vcf generated above
$ pbrun postpon \
  --in-vcf output.vcf \
  --in-pon-file input.vcf.gz
  --out-vcf output_annotated.vcf

mutectcaller Reference

Run GPU mutect2 to convert bam/cram to vcf

Input/Output file options

--ref REF

Path to the reference file. (default: None)

Option is required.

--out-vcf OUT_VCF

Path of VCF file after Variant Calling. (default: None)

Option is required.

--in-tumor-bam IN_TUMOR_BAM

Path of bam/cram file for tumor reads. (default: None)

Option is required.

--in-normal-bam IN_NORMAL_BAM

Path of BAM/CRAM file for normal reads. (default: None)

--in-tumor-recal-file IN_TUMOR_RECAL_FILE

Path of the report file after Base Quality Score Recalibration for tumor sample. (default: None)

--in-normal-recal-file IN_NORMAL_RECAL_FILE

Path of report file after Base Quality Score Recalibration for normal sample. (default: None)

--interval-file INTERVAL_FILE

Path to an interval file with possible formats: Picard-style (.interval_list or .picard), GATK-style (.list or .intervals), or BED file (.bed). This option can be used multiple times. (default: None)

--pon PON

Path of vcf.gz pon file. Make sure you run prepon first, and there is a '.pon' file already. (default: None)

Options specific to this tool

--ploidy PLOIDY

Ploidy assumed for the BAM file. Currently only haploid (ploidy 1) and diploid (ploidy 2) are supported. (default: 2)

--max-mnp-distance MAX_MNP_DISTANCE

Two or more phased substitutions separated by this distance or less are merged into MNPs. (default: 1)

--mutectcaller-options MUTECTCALLER_OPTIONS

Pass supported mutectcaller options as one string. Currently supported original mutectcaller options: -pcr-indel-model <NONE, HOSTILE, AGGRESSIVE, CONSERVATIVE>. e.g. --mutectcaller-options="-pcr-indel-model HOSTILE". (default: None)

--tumor-name TUMOR_NAME

Name of sample for tumor reads. (default: None)

Option is required.

--normal-name NORMAL_NAME

Name of sample for normal reads. (default: None)

-L INTERVAL, --interval INTERVAL

Interval within which to call the variants from the BAM/CRAM file. 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". (default: None)

-ip INTERVAL_PADDING, --interval-padding INTERVAL_PADDING

Amount of padding (in base pairs) to add to each interval you are including. (default: None)

Common options:

--logfile LOGFILE

Path to the log file. If not specified, messages will only be written to the standard error output. (default: None)

--tmp-dir TMP_DIR

Full path to the directory where temporary files will be stored.

--with-petagene-dir WITH_PETAGENE_DIR

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)

--keep-tmp

Do not delete the directory storing temporary files after completion.

--license-file LICENSE_FILE

Path to license file license.bin if not in the installation directory.

--no-seccomp-override

Do not override seccomp options for docker (default: None).

--version

View compatible software versions.

GPU options:

--num-gpus NUM_GPUS

Number of GPUs to use for a run. GPUs 0..(NUM_GPUS-1) will be used.

--gpu-devices GPU_DEVICES

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.