Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/at-cg/PanAligner
Long read aligner for cyclic and acyclic pangenome graphs
https://github.com/at-cg/PanAligner
pangenome read-alignment variation-graphs
Last synced: 2 months ago
JSON representation
Long read aligner for cyclic and acyclic pangenome graphs
- Host: GitHub
- URL: https://github.com/at-cg/PanAligner
- Owner: at-cg
- License: other
- Created: 2023-01-27T11:07:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-20T14:03:47.000Z (10 months ago)
- Last Synced: 2024-02-12T15:20:55.003Z (8 months ago)
- Topics: pangenome, read-alignment, variation-graphs
- Language: C
- Homepage:
- Size: 3.79 MB
- Stars: 33
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-pangenomes - PanAligner
README
```sh
git clone https://github.com/at-cg/PanAligner
cd PanAligner && make
# Map sequence to graph
./PanAligner -cx lr test/MT.gfa test/MT-orangA.fa > out.gaf
```
## Table of Contents
- [Getting Started](#started)
- [Introduction](#intro)
- [Users' Guide](#uguide)
- [Installation](#install)
- [Sequence mapping](#map)
- [Hybrid method](#hybrid)
- [Benchmark](#bench)
- [Citation](#cite)
PanAligner is an efficient tool to align long-reads or assembly contigs to a cyclic pangenome graph. We follow the seed-chain-extend procedure. We provide the first exact implementation of co-linear chaining technique which is generalized to cyclic graphs. The details of the formulation and the algorithm are provided in our paper. If the input graph is a DAG, PanAligner works similarly as [minichain](https://github.com/at-cg/minichain.git). We benefit from open-source code from [minichain](https://github.com/at-cg/minichain.git), [minigraph](https://github.com/lh3/minigraph.git), and [GraphChainer](https://github.com/algbio/GraphChainer.git) for other necessary components besides co-linear chaining. PanAligner can scale to human pangenome graphs and whole-genome sequencing read sets.
### Installation
To install PanAligner, type `make` in the source code directory.
#### Dependencies
1) [gcc9][gcc9] or later version
2) [zlib][zlib]
### Sequence mapping
PanAligner can be used for both sequence-to-sequence alignment and sequence-to-graph mapping. For sequence-to-sequence alignment, PanAligner maps a read to a reference in fasta format and provide read mapping output in [PAF][paf] format. For sequence-to-graph mapping, PanAligner takes the graph in [GFA][gfa1] and [rGFA][rGFA] format as input, and provides read mapping in [GAF][gaf] format.
```sh
# Map sequence to sequence
./PanAligner -cx lr test/MT-human.fa test/MT-orangA.fa > out.paf
# Map sequence to graph
./PanAligner -cx lr test/MT.gfa test/MT-orangA.fa > out.gaf
```
### Hybrid method
The Hybrid method leverages the strengths of both [minigraph](https://github.com/lh3/minigraph.git) and PanAligner to achieve efficient and accurate sequence-to-graph mapping. This method is designed to identify a subset of reads that are relatively "easy-to-align" and utilizes the fast [minigraph](https://github.com/lh3/minigraph.git) heuristics for aligning them. For the remaining reads, PanAligner is used for the alignment.
Before running the HybridMethod.sh, ensure that [conda](https://docs.conda.io/en/latest/) is installed and available in your PATH.
```sh
# One time installation of dependencies
chmod +x get_dependencies.sh
./get_dependencies.sh
# create a hybrid_test folder
mkdir hybrid_test
cp hybrid_method.sh hybrid_test
cd hybrid_test
# Map a sequence using the hybrid method in the hybrid_test folder
./hybrid_method.sh ../test/MT.gfa ../test/MT-human.fa out.gaf 4
# Here hybrid_method.sh takes 1st argument as graph file 2nd argument as query file 3rd argument as output "gaf" file and last argument specifies the count of threads
```
## Benchmark
We evaluated PanAligner and Hybrid method against other sequence-to-graph aligners to assess its scalability and accuracy advantages. The evaluation utilized human pangenome graphs constructed from [94 high-quality haplotype assemblies](https://github.com/human-pangenomics/HPP_Year1_Assemblies) provided by the Human Pangenome Reference Consortium, along with the [CHM13 human genome assembly](https://www.ncbi.nlm.nih.gov/assembly/GCA_009914755.4) from the Telomere-to-Telomere consortium. Simulated long-reads with 0.5× coverage and 5% error-rate were used for the experiments, employing cyclic graphs of sizes 10H, 40H, and 95H, where the prefix integer represents the haplotype count in each graph. The results demonstrated superior read mapping precision, as shown in the [figure](#Plot). Notably, even on the largest graph with 95 haplotypes, PanAligner achieved efficient performance, requiring 2 hours and 36 minutes, 44 GB RAM, and 32 threads on [perlmutter CPU nodes](https://docs.nersc.gov/systems/perlmutter/architecture/#cpu-nodes).
## Citation
Jyotshna Rajput, Ghanshyam Chandra, Chirag Jain. [Co-linear Chaining on Pangenome Graphs](https://www.biorxiv.org/content/10.1101/2023.06.21.545871v1). WABI 2023
[gwfa]: https://arxiv.org/abs/2206.13574
[paper_1]: https://genomebiology.biomedcentral.com/articles/10.1186/s13059-020-02168-z
[paper_2]: https://www.biorxiv.org/content/10.1101/2022.08.29.505691v2
[minichain]: https://github.com/at-cg/minichain
[zlib]: http://zlib.net/
[gcc9]: http://zlib.net/
[rgfa]: https://github.com/lh3/gfatools/blob/master/doc/rGFA.md
[gfa1]: https://github.com/GFA-spec/GFA-spec/blob/master/GFA1.md
[gaf]: https://github.com/lh3/gfatools/blob/master/doc/rGFA.md#the-graph-alignment-format-gaf
[paf]: https://github.com/lh3/miniasm/blob/master/PAF.md