Human Par Pipeline

Given one or more pairs of fastq files, you can run the human_par pipeline workflow to generate output including BAM, recal, and variants called with proper pseudoautosomal region ploidy values.

The human_par pipeline shown below resembles the GATK4 best practices pipeline. The inputs are BWA-indexed reference files, pair-ended fastq files, knownSites for BQSR calculation, and specifications to determine which sex to run variant calling. Male samples run Haplotype Caller first on non-X/Y regions and the pseudoautosomal region with ploidy 1 and second on X/Y regions without the pseudoautosomal region with ploidy 2. Female samples run Haplotype Caller on all regions with ploidy 2. The outputs of this pipeline are:

  • Aligned, co-ordinate sorted, duplicated marked bam

  • BQSR report

  • Variants in vcf/g.vcf/g.vcf.gz format

Three options are used to determine the sex of the input sample. The --sample-sex option can be used to manually set the sex as male or female, overriding the sex detected from the number of X and Y reads. Additionally, two X/Y ratio range options can be used to automatically detect the sex of the sample based on the number of X and Y reads. Both --range-male and --range-female options provide a range for the possible value of the X/Y ratio. If the X/Y ratio falls in any of the given ranges, that sex will be used for Haplotype Caller; however, if the X/Y ratio is not in any range, the pipeline relies on the --sample-sex option to continue. At least one of these three options must be provided.

Quick Start

Run a human_par pipeline:

CLI
$ pbrun human_par --ref Homo_sapiens_assembly38.fasta \
--in-fq sample0_0.fq.gz sample_0_1.fq.gz \
--knownSites known.vcf.gz \
--range-male 1-10 \
--range-female 150-250 \
--sample-sex male \
--out-bam output.bam \
--out-variants output.vcf \
--out-recal-file report.txt

Compatible CPU based bwa-mem, GATK4 commands

The command below is the bwa-0.7.12 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
# Run ApplyBQSR Step
$ gatk ApplyBQSR --java-options -Xmx30g -R Ref/Homo_sapiens_assembly38.fasta \
-I=mark_dups_cpu.bam --bqsr-recal-file=recal_file.txt -O=cpu_nodups_BQSR.bam
#Run Haplotype Caller on the non-X/Y regions and the pseudoautosomal region
$ gatk HaplotypeCaller --java-options -Xmx30g --input cpu_nodups_BQSR.bam --output \
result_cpu_non_xy.vcf --reference Ref/Homo_sapiens_assembly38.fasta \
-L non_xy_regions_with_par.list --native-pair-hmm-threads 16
#Run Haplotype Caller on the X/Y regions without the pseudoautosomal region
$ gatk HaplotypeCaller --java-options -Xmx30g --input cpu_nodups_BQSR.bam --output \
result_cpu_xy.vcf --reference Ref/Homo_sapiens_assembly38.fasta \
-L xy_regions_without_par.list --native-pair-hmm-threads 16 \
(--ploidy 1 for male samples)
#Merge the variants from both Haplotype Caller runs
$ gatk MergeVcfs -I result_cpu_non_xy.vcf -I result_cpu_xy.vcf -O result_cpu.vcf

Options

CLI

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 .fq.gz or .fastq.gz format. You can provide multiple pairs as inputs like so:...--in-fq $fq1 $fq2 --in-fq $fq3 $fq4 ...

--out-bam (required)

Path to the file that will contain BAM output.

--out-variants (required)

Name of VCF/GVCF/GVCF.GZ file after Variant Calling. Absolute or relative path can be given.

--sample-sex

Sex of the sample input. This option will override the sex determined from --range-male or --range-female. Required if --range-male and --range-female are not given. Must be either male or female.

--range-male

Inclusive male range for the X/Y read ratio. The sex is declared male if the actual ratio falls in the specified range. Required if --sample-sex and --range-female are not given. Syntax is <min>-<max> .

--range-female

Inclusive female range for the X/Y read ratio. The sex is declared female if the actual ratio falls in the specified range. Required if --sample-sex and --range-male are not given. Syntax is <min>-<max> .

--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.

--out-recal-file

Path of report file (.txt format) after Base Quality Score Recalibration.

--knownSites

Full path to a known indels file. Must be in vcf format. This option can be used multiple times.

--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.

--no-markdups

Defaults to False.

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

--markdups-assume-sortorder-queryname

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. Ignored if --out-duplicate-metrics is not passed.

--mba

Run MergeBAMAlignment after alignment.

--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.

--static-quantized-quals

Use static quantized quality scores to a given number of levels. Repeat this option multiple times for multiple bins.

--batch

Given an input list of BAMs, run the variant calling of each BAM using one GPU, and process BAMs in parallel based on how many GPUs the system has.

--disable-read-filter

Disable the read filters for bam entries. Currently supported read filters that can be disabled are: MappingQualityAvailableReadFilter, MappingQualityReadFilter, and NotSecondaryAlignmentReadFilter.

--ploidy

Defaults to 2. ploidy assumed for the bam file. Currently only haploid (ploidy 1) and diploid (ploidy 2) are supported.

--interval

(-L)

Interval within which to call the variants from the bam file. This option can be used multiple times. All intervals will have a padding of 100 and overlapping intervals will be combined. The intervals can be specified in a file using the BED file format or GATK style format. e.g. "-L chr1 -L chr2:1000-3100" or "-L interval.bed".

--gvcf

Defaults to False. Generate variant calls in gvcf format. Final output will have .g.vcf extension.

--bwa-options

Pass supported bwa mem options as one string. Current original bwa mem supported options, -M, -Y, -T.

--haplotypecaller-options

Pass supported haplotype caller options as one string. Current original original haplotypecaller supported options, - min_pruning <int>, -standard-min-confidence-threshold-for- calling <int>.