fq2bam

Generate BAM output given one or more pairs of fastq files. Optionally generate BQSR report.

fq2bam performs the following steps. User can decide to turn-off marking of duplicates. BQSR step is only performed if --knownSites input and --out-recal-file options are provided.

Quick Start

CLI
$ pbrun fq2bam --ref Ref/Homo_sapiens_assembly38.fasta \
--in-fq S1_1.fastq.gz S1_2.fastq.gz \
--knownSites Ref/Homo_sapiens_assembly38.known_indels.vcf.gz \
--out-bam mark_dups_gpu.bam \
--out-recal-file recal_gpu.txt \
--tmp-dir /raid/myrun

Compatible CPU based bwa-mem, GATK4 commands

The command below is the bwa-0.7.15 and GATK4 counterpart of the Parabricks command above. The output from these commands will generate the exact same results as the output from the above command. Please look at Output Comparison page on how you can compare the results.

# Run bwa-mem and pipe output to create sorted bam
$ bwa mem -t 32 -K 10000000 -R '@RG\tID:sample_rg1\tLB:lib1\tPL:bar\tSM:sample\tPU:sample_rg1' \
Ref/Homo_sapiens_assembly38.fasta S1_1.fastq.gz S1_2.fastq.gz | gatk \
SortSam --java-options -Xmx30g --MAX_RECORDS_IN_RAM=5000000 -I=/dev/stdin \
-O=cpu.bam --SORT_ORDER=coordinate --TMP_DIR=/raid/myrun
# Mark Duplicates
$ gatk MarkDuplicates --java-options -Xmx30g -I=cpu.bam -O=mark_dups_cpu.bam \
-M=metrics.txt --TMP_DIR=/raid/myrun
# Generate BQSR Report
$ gatk BaseRecalibrator --java-options -Xmx30g --input mark_dups_cpu.bam --output \
recal_cpu.txt --known-sites Ref/Homo_sapiens_assembly38.known_indels.vcf.gz \
--reference Ref/Homo_sapiens_assembly38.fasta

Options

Option

Description

--ref (required)

The reference genome in fasta format. We assume that the indexing required to run bwa has been completed by the user.

--in-fq (required)

Pair ended fastq files. These can be in .fastq or .fastq.gz format. You can provide read group information as an optional third argument.

Example 1:

--in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz

Example 2:

--in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz "@RG\tID:foo\tLB:lib1\tPL:bar\tSM:sample\tPU:unit1"

This option can be repeated multiple times as well. Example 1:

--in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz --in-fq sampleX_2_1.fastq.gz sampleX_2_2.fastq.gz

Example 2:

--in-fq sampleX_1_1.fastq.gz sampleX_1_2.fastq.gz "@RG\tID:foo\tLB:lib1\tPL:bar\tSM:sample\tPU:unit1" --in-fq sampleX_2_1.fastq.gz sampleX_2_2.fastq.gz "@RG\tID:foo2\tLB:lib1\tPL:bar\tSM:sample\tPU:unit2"

Either all sets of inputs have read group or none should have it and will be automatically added by the pipeline. For same sample, Read Groups should have same sample name (SM) and different ID and PU.

--out-bam (required)

Path to the file that will contain BAM output.

--out-recal-file

Path of report file (.txt format) after Base Quality Score Recalibration. This option can be passed in, if --knownSites are provided.

--out-duplicate-metrics

Path of duplicate metrics file after Marking Duplicates.

--mba

Defaults to False.

Run MergeBAMAlignment after alignment.

--in-mba-file

Path to a file containing options for MergeBAMAlignment. Currently supported options are ATTRIBUTES_TO_RETAIN, ATTRIBUTES_TO_REMOVE, ATTRIBUTES_TO_REMOVE, MAX_INSERTIONS_OR_DELETIONS, PRIMARY_ALIGNMENT_STRATEGY, UNMAPPED_READ_STRATEGY, ALIGNER_PROPER_PAIR_FLAGS, UNMAP_CONTAMINANT_READS, and ADD_PG_TAG_TO_READS. Each option must be specified on a new line in the file. Refer to Picard MergeBAMAlignment documentation for details on these options.

--knownSites

Known indel files in .vcf.gz format. These should be compressed vcf files for known SNPs and indels. You can use this option multiple times. If you provide this option, then you must also provide an --out-recal-file.

--no-markdups

Defaults to False.

Do not mark duplicates, generate bam after co-ordinate sorting.

--bwa-options

Pass supported bwa mem options as one string. Current

original bwa mem supported options: -M, -Y, -T .

--markdups-assume-sortorder-queryname

Defaults to False.

Assume the reads are sorted by queryname for Marking Duplicates. This will mark secondary, supplementary and unmapped reads as duplicates as well. This flag will not impact variant calling while increasing processing times.

--optical-duplicate-pixel-distance

The maximum offset between two duplicate clusters in order to consider them optical duplicates. This option is only used if you provide an --out-duplicate-metrics.

--read-group-sm

SM tag for read groups in this run.

--read-group-lb

LB tag for read groups in this run.

--read-group-pl

PL tag for read groups in this run.

--read-group-id-prefix

Prefix for ID and PU tag for read groups in this run. This prefix will be used for all pair of fastq files in this run. The ID and PU tag will consist of this prefix and an identifier which will be unique for a pair of fastq files.

--tmp-dir

Defaults to ..

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

--num-gpus

Defaults to number of GPUs in the system.

The number of GPUs to be used for this analysis task.