applybqsr

View as Markdown

Updates the Base Quality Scores using the BQSR report.

This tool recalibrates quality scores in a BAM file using the report generated by the bqsr [link] tool. This should be applied after alignment but before variant calling to maximize final accuracy in variant calling, as recommended by GATK best practices.

Note that the applybqsr tool will use at most two GPUs.

Refer to the applybqsr 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 applybqsr \
6 --ref /workdir/${REFERENCE_FILE} \
7 --in-bam /workdir/${INPUT_BAM} \
8 --in-recal-file /workdir/${INPUT_RECAL_FILE} \
9 --out-bam /outputdir/${OUTPUT_BAM}

Compatible GATK4 Command

The command below is the GATK4 counterpart of the Parabricks command above. The output from these commands will be identical to the output from the above command.

1$ gatk ApplyBQSR \
2 --java-options -Xmx30g \
3 -R <INPUT_DIR>/${REFERENCE_FILE} \
4 -I <INPUT_DIR>/${INPUT_BAM} \
5 --bqsr-recal-file <INPUT_DIR>/${INPUT_RECAL_FILE} \
6 -O <OUTPUT_DIR>/${OUTPUT_BAM}

Options

TypeNameRequired?Description
I/O--ref REFYesPath to the reference file.
I/O--in-bam IN_BAMYesPath to the BAM file.
I/O--in-recal-file IN_RECAL_FILEYesPath to the BQSR report file.
I/O--interval-file INTERVAL_FILENoPath to an interval file in one of these formats: Picard-style (.interval_list or .picard), GATK-style (.list or .intervals), or BED file (.bed). This option can be used multiple times.
I/O--out-bam OUT_BAMYesOutput BAM file.
Tool-L INTERVAL, --interval INTERVALNoInterval within which to call applyBQSR from the input reads. 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").
Tool-ip INTERVAL_PADDING, --interval-padding INTERVAL_PADDINGNoAmount of padding (in base pairs) to add to each interval you are including.
Performance--num-threads NUM_THREADSNoNumber of threads for worker. (default: 8)
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)