Skip to content

Commit dc37389

Browse files
readme: mention A*PA2 WABI paper; bugfix
1 parent db8557b commit dc37389

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.org

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,19 @@ An alignment of two sequences of length 10'000 with 15% error rate using A*PA2:
1616
[[file:imgs/readme/astarpa2.gif]]
1717

1818
- Papers ::
19-
For A*PA, we recommend reading the bioRxiv version which directly includes the
20-
supplement and has better formatting. But please cite the Bioinformatics version!
21-
- A*PA BioRxiv preprint:
19+
For A*PA, we recommend reading the [[https://doi.org/10.1101/2022.09.19.508631][bioRxiv version]] which directly includes the
20+
supplement and has better formatting. But please cite the published papers:
21+
- A*PA:
2222

2323
*Ragnar Groot Koerkamp*, *Pesho Ivanov*.
24-
"Exact global alignment using A* with chaining seed heuristic and match pruning".
25-
bioRxiv (2024). [[https://doi.org/10.1101/2022.09.19.508631][10.1101/2022.09.19.508631]]
26-
- A*PA OUP Bioinformatics paper:
27-
28-
*Ragnar Groot Koerkamp*, *Pesho Ivanov*.
29-
"Exact global alignment using A* with chaining seed heuristic and match pruning".
24+
Exact global alignment using A* with chaining seed heuristic and match pruning.
3025
Bioinformatics (2024). [[https://doi.org/10.1093/bioinformatics/btae032][10.1093/bioinformatics/btae032]]
3126

32-
- A*PA2 BioRxiv preprint:
27+
- A*PA2:
3328

3429
*Ragnar Groot Koerkamp*.
35-
"A*PA2: up to 20 times faster exact global alignment".
36-
bioRxiv (2024). [[https://doi.org/10.1101/2024.03.24.586481][10.1101/2024.03.24.586481]]
30+
A*PA2: up to 19x faster exact global alignment.
31+
WABI 2024. [[https://doi.org/10.4230/LIPIcs.WABI.2024.17][10.4230/LIPIcs.WABI.2024.17]]
3732

3833
- Links ::
3934
- Twitter: [[https://mobile.twitter.com/curious_coding][@curious_coding]], [[https://mobile.twitter.com/peshotrie][@peshotrie]],
@@ -48,8 +43,8 @@ reach out on twitter or matrix.
4843
To call A*PA2 from another Rust crate, simply add the =astarpa[2]= crate in this
4944
repo as a git dependency.
5045

51-
For A*PA2, use ~astarpa2_simple(a, b)~ or ~astarpa2_full(a, b)~ in the
52-
[[file:astarpa2/src/lib.rs][~astarpa2~ crate]], or customize parameters with e.g.
46+
We recommend using ~astarpa2_simple(a, b)~ or ~astarpa2_full(a, b)~ in the
47+
[[file:astarpa2/src/lib.rs][~astarpa2~ crate]]. Parameters can be customized with e.g.
5348
#+begin_src rust
5449
let mut params = astarpa2::AstarPa2Params::full();
5550
params.front.incremental_doubling = false;
@@ -73,13 +68,13 @@ simple usage. To run the resulting binary, make sure to ~export LD_LIBRARY_PATH=
7368
=pa-bin= is a small command line application that takes as input consecutive pairs of
7469
sequences from a =.fasta=, =.seq=, or =.txt= file (or can generate random input)
7570
and outputs costs and alignments to a =.csv=.
76-
#+end_src
7771

7872
This requires =cargo= and Rust =nightly=. To get both, first install [[https://rustup.rs/][rustup]]. Then enable ~nightly~: ~rustup install nightly; rustup default nightly~.
7973

8074
Install =pa-bin= to =~/.local/share/cargo/bin/pa-bin= using the following (cloning this repo is not needed):
8175
#+begin_src shell
8276
cargo install --git https://github.com/RagnarGrootKoerkamp/astar-pairwise-aligner pa-bin
77+
#+end_src
8378

8479
To run from the repository: clone and ~cargo run --release -- <pa-bin flags>~.
8580

0 commit comments

Comments
 (0)