Skip to content

gear-genomics/halo

Repository files navigation

C/C++ CI Docker CI GitHub Releases

Halo: Haplotype processor

GEAR hosts the halo web application at https://www.gear-genomics.com/halo/. The halo command-line tool is needed to compute the input file for the halo web application.

Installing halo

The halo command-line tool is available as a pre-compiled statically linked binary from Halo's github release page, as a singularity container SIF file or as a minimal Docker container.

git clone --recursive https://github.com/gear-genomics/halo.git
cd halo/
make all
make install

Usage

Halo is used to create the input JSON file for the web application.

./bin/halo -h

This command-line application was designed for Strand-Seq single-cell DNA data but the viewer can also be used for any haplotype-resolved data. To convert the Strand-Seq alignment data into JSON format please provide one input BAM file for each input cell, e.g.:

halo count -g hg38.fa -o sc.json.gz sc1.bam sc2.bam sc3.bam

The output file sc.json.gz can then be uploaded and visualized at https://www.gear-genomics.com/halo/.

Haplotype-resolved alignments

Besides Strand-Seq data, halo can also be used on any haplotype-tagged BAM file that uses the HP tag.

halo count -r -t HP_tagged -w 25000 -g hg38.fa input.bam

This command generates coverage data by haplotype using 25Kbp windows. The output file can then be uploaded and visualized at https://www.gear-genomics.com/halo/.

License

Halo is distributed under the GPLv3 license. Consult the accompanying LICENSE file for more details.

Credits

HTSlib is heavily used for all genomic alignment variant processing. Boost for various data structures and algorithms.