Skip to content
Assembly Based ReAligner
Branch: master
Clone or download
Latest commit 5c8772f Apr 24, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
lib
misc Added example screenshot. Apr 28, 2014
paper Removed reference to vcfallelicprimitives. May 8, 2014
poster Added poster. Feb 13, 2014
src Renamed assembler.c to assembler.cpp since it uses the C++ STL Jan 11, 2017
temp Another patch jar for Cadabra unaligned read bug. Sep 11, 2015
.gitignore Initial commit Nov 7, 2012
LICENSE.txt Update LICENSE.txt Oct 2, 2014
Makefile Renamed assembler.c to assembler.cpp since it uses the C++ STL Jan 11, 2017
README.md
pom.xml Upping to v0.97 Jun 20, 2016

README.md

ABRA - Assembly Based ReAligner

Manuscript: https://doi.org/10.1093/bioinformatics/btu376

Active development has now moved to: ABRA2

Introduction

ABRA is a realigner for next generation sequencing data. It uses localized assembly and global realignment to align reads more accurately, thus improving downstream analysis (detection of indels and complex variants in particular).

Here is an ABRA realigned region (original reads on top, ABRA realigned reads on bottom). The original set of reads have rather "noisy" alignments with several variations from the reference and a fair bit of high quality soft clipping. The ABRA realignments present a more parsimonious representation of the reads including a previously unobserved large deletion.

ABRA Example

Building

Building ABRA requires JDK 7, Maven and g++

Just run make. An executable jar will be generated under the target directory. i.e. target/abra-0.92-SNAPSHOT-jar-with-dependencies.jar

Pre-built jars are available for 64 bit linux here: https://github.com/mozack/abra/releases

Note, that the jar does contain native code. While we have tested on a variety of platforms, we cannot guarantee that the pre-built jar will work everywhere. In some cases, it may be necessary to compile for your specific platform.

Running

Running ABRA currently requires bwa 0.7.9a (or similar) in the command path and a recent version of Java.

Sample command line for v0.86:

java -Xmx4G -jar $JAR --in input.bam --out output.bam --ref hg19.fasta --targets targets.bed --threads 8 --working abra_temp_dir > abra.log 2>&1

The above command allocates 4GB for the java heap. ABRA includes native code that runs outside of the JVM. We have found that for typical exome processing using 8 threads, 16GB total is more than sufficient.

Note: The code at the HEAD may occasionally be unstable. It is recommended to work from a release.

Parameters

parameter value
--in One or more input BAMs delimited by comma
--out One or more output BAM's corresponding to the set of input BAMs
--ref BWA indexed reference genome.
--targets BED file describing target assembly regions (Usually corresponds to capture targets) with optional kmer lengths for each region. Targets must be sorted by position in ascending order within each chromosome.
--working Temp working directory

Somatic mode

If working with tumor/normal pairs, it is highly recommended to assemble your samples together. To do this, simply specify multiple input and output BAM files on the command line.

Additionally, translocations may be detected by using -sv translocation_file The output file will contain putative breakpoints with the number of reads aligned to each breakpoint in the output file.

In somatic mode, you may also consider using option --lr repeat_file This option allows for detection of moderate length repeats that could not be resolved at nucleotide precision. This feature is experimental.

Sample usage:

java -Xmx4G -jar $JAR --in normal.bam,tumor.bam --out normal.abra.bam,tumor.abra.bam --ref hg19.fasta --targets targets.bed --threads 8 --working abra_temp_dir --sv abra.sv.txt > abra.log 2>&1

The translocation file will consist of entries in the following format:

<breakpoint_id> <locus1> <locus2> <sample1_supporting_reads> <sample2_supporting_reads>

For example:

BP_1 chr11:10000000 chr17:30003455 0 112

In the above example one breakpoint is identified between chr11:10000000 and chr17:30003455 with no read support in sample1 (normal) and 112 reads supporting the breakpoint in sample2 (tumor). Users should use sample read counts to perform filtering on SV calls to identify the true somatic translocations.

Output

ABRA produces one or more realigned BAMs. It is currently necessary to sort and index the output. At present, the mate information may not be 100% accurate. Samtools fixmate or Picard Tools FixMateInformation may optionally be used to correct this.

Reads that have been realigned will contain a YO tag indicating their original alignment position. Reads that were originally unaligned will have a YO value of N/A.

After the output BAM file is sorted and indexed it can be passed into a variant caller such as FreeBayes for germline calling and Cadabra, Strelka or UNCeqr for somatic calling.

Demo / test data

A test data set and example command line is available under the demo directory. Edit demo.bash to specify your hg19 reference location (indexed by a recent version of bwa) and run demo.bash.

Speeding things up

IntelDeflator

ABRA relies heavily upon the HTSJDK for reading and writing BAM files. BAM compression can be slow and an optional native library can be used to speed up this compression on some systems. See IntelDeflator

To use this simply add: -Dsamjdk.intel_deflater_so_path=<path/to/libIntelDeflater.so> to your java command line. libIntelDeflater.so is available under the lib directory.

Assembly graph pruning

ABRA's default graph pruning is mild. Pruning more aggressively may decrease running times. The default min edge ratio value is .02 (2 percent) - appropriate for sensitive somatic variant detection. For diploid germline only cases, this can safely be increased to .10

Region kmers

ABRA computes an appropriate kmer size for each region based upon the properties of the reference. If the same bed file is used as input many times, this can be pre-computed using the KmerSizeEvaluator.

Usage:

java -Xmx4G -cp abra.jar abra.KmerSizeEvaluator  <readLength> <reference> <output_bed> <num_threads> <input_bed>

This resultant <output_bed> file will contain kmer sizes in the 4th column. Pass this into ABRA using the --target-kmers param to avoid re-computing these values repeatedly.

Cadabra

Cadabra is a somatic indel caller that works specifically with ABRA alignments. It uses SAM tags embedded by ABRA to identify assembled indels with support in the tumor, and a general lack of support in the normal. It performs very well according to our tests.

Quality scores are calculated using a Phred scaled Fisher's Exact Test.

Cadabra is embedded within the ABRA jar file.

Sample usage:

java -Xmx4G -cp $JAR abra.cadabra.Cadabra hg19.fasta normal.abra.bam tumor.abra.bam > cadabra.vcf
You can’t perform that action at this time.