WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 87983c3

Browse files
committed
Minor changes
1 parent 55bbd24 commit 87983c3

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ FastANI
22
========================================================================
33
[![Apache 2.0 License](https://img.shields.io/badge/license-Apache%20v2.0-blue.svg)](LICENSE)
44

5-
FastANI is a fast alignment-free estimator of Average Nucleotide Identity (ANI) between two genomes. ANI is defined as mean nucleotide identity of orthologous gene pairs between two microbial genomes. FastANI supports comparison of both complete and draft genomes. FastANI follows a similar workflow as described by [Goris et al. 2007](http://www.ncbi.nlm.nih.gov/pubmed/17220447). However, it avoids expensive sequence alignments and uses [Mashmap](https://github.com/marbl/MashMap) as its MinHash based sequence mapping engine. Based on our experiments with complete and draft genomes, its accuracy is on par with [BLAST-based ANI solver](http://enve-omics.ce.gatech.edu/ani/) and achieves two to three orders of magnitude speedup. Therefore, it is useful for ANI analysis of large number of genome pairs. Detailed results and comparisons with existing methods are described in our paper.
5+
FastANI is developed for fast alignment-free computation of whole-genome Average Nucleotide Identity (ANI). ANI is defined as mean nucleotide identity of orthologous gene pairs between two microbial genomes. FastANI supports both complete and draft genome assemblies. It follows a similar workflow as described by [Goris et al. 2007](http://www.ncbi.nlm.nih.gov/pubmed/17220447). However, it avoids expensive sequence alignments and uses [Mashmap](https://github.com/marbl/MashMap) as its MinHash based sequence mapping engine. Based on our experiments with complete and draft genomes, its accuracy is on par with [BLAST-based ANI solver](http://enve-omics.ce.gatech.edu/ani/) and achieves two to three orders of magnitude speedup. Therefore, it is useful for pairwise ANI computation of large number of genome pairs. Detailed results and comparisons with existing methods are described in our paper.
66

77
### Download and Compile
88

@@ -67,18 +67,20 @@ ANI output file = fastani.out
6767
INFO, skch::main, Time spent post mapping : 0.00310319 sec
6868
```
6969

70-
Output is saved in file **fastani.out**. It should contain the ANI estimate between *E. coli* and *S. flexneri* genomes.
70+
Output is saved in file `fastani.out`, provided above using the `-o` option.
7171

7272
```sh
7373
$ cat fastani.out
7474
data/Shigella_flexneri_2a_01.fna data/Escherichia_coli_str_K12_MG1655.fna 97.7443 1305 1608
7575
```
7676

77+
Above output implies that the ANI estimate between *S. flexneri* and *E. coli* genomes is 97.7443. Out of the total 1608 sequence fragments from *S. flexneri* genome, 1305 were aligned as orthologous matches.
78+
7779
### Visualize Conserved Regions b/w Two Genomes
7880

7981
FastANI supports visualization of the reciprocal mappings computed between two genomes.
8082
Getting this visualization requires a one to one comparison using FastANI as discussed above, except an additional flag `--visualize` should be provided.
81-
This flag forces FastANI to output mapping file (with `.visual` extension) that contains information of all the reciprocal mappings.
83+
This flag forces FastANI to output a mapping file (with `.visual` extension) that contains information of all the reciprocal mappings.
8284
Finally, an [R script](scripts) is provided in the repository which uses [genoPlotR](https://cran.r-project.org/web/packages/genoPlotR/index.html) package to plot these mappings.
8385
Here we show an example run using two genomes: *Bartonella quintana* ([GenBank: CP003784.1](https://www.ncbi.nlm.nih.gov/nuccore/CP003784.1)) and *Bartonella henselae* ([NCBI Reference Sequence: NC_005956.1](https://www.ncbi.nlm.nih.gov/nuccore/NC_005956.1)).
8486

@@ -95,7 +97,7 @@ Using above commands, we get a plot file fastani.out.visual.pdf displayed below.
9597

9698
### Parallelization
9799

98-
As of now, FastANI doesn't support parallelization internally. However, for one-to-many or many-to-many genome comparisons, users can simply divide their reference database into multiple chunks, and execute them as parallel processes. We provide a [helper script](scripts) to do this splitting.
100+
As of now, FastANI doesn't support parallelization internally. However, for one-to-many or many-to-many genome comparisons, users can simply divide their reference database into multiple chunks, and execute them as parallel processes. We provide a [script](scripts) in the repository to randomly split the database.
99101

100102
### Troubleshooting
101103

src/map/include/parseCmdArgs.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ namespace skch
2929
void initCmdParser(CommandLineProcessing::ArgvParser &cmd)
3030
{
3131
cmd.setIntroductoryDescription("-----------------\n\
32-
fastANI is a fast alignment-free implementation for computing ANI between genomes\n\
32+
fastANI is a fast alignment-free implementation for computing whole-genome Average Nucleotide Identity (ANI) between genomes\n\
3333
-----------------\n\
3434
Example usage: \n\
35-
$ fastANI -s genome1.fa -q genome2.fa -o output.txt\n\
36-
$ fastANI --sl genome_list.txt -q genome2.fa -o output.txt");
35+
$ fastANI -q genome1.fa -r genome2.fa -o output.txt\n\
36+
$ fastANI -q genome1.fa --rl genome_list.txt -o output.txt");
3737

3838
cmd.setHelpOption("h", "help", "Print this help page");
3939

0 commit comments

Comments
 (0)