9
9
## Overview
10
10
11
11
ANIclustermap is easy-to-use tool for drawing ANI(Average Nucleotide Identity) clustermap between all-vs-all microbial genomes.
12
- ANI between all-vs-all genomes are calculated by fastANI and clustermap is drawn using seaborn.
12
+ ANI between all-vs-all genomes are calculated by [ fastANI] ( https://github.com/ParBLiSS/FastANI )
13
+ (or [ skani] ( https://github.com/bluenote-1577/skani ) ) and clustermap is drawn using seaborn.
13
14
14
15
![ ANIclustermap.png] ( https://raw.githubusercontent.com/moshi4/ANIclustermap/main/images/normal_dataset/ANIclustermap.png )
15
16
Fig1. ANI clustermap between all-vs-all 33 genomes.
@@ -19,7 +20,7 @@ Fig2. ANI clustermap between all-vs-all 18 genomes. If no similarity detected by
19
20
20
21
## Installation
21
22
22
- ANIclustermap is implemented in Python3. [ fastANI] ( https://github.com/ParBLiSS/FastANI ) is required to calculate ANI.
23
+ ANIclustermap is implemented in Python3. [ fastANI] ( https://github.com/ParBLiSS/FastANI ) is required to calculate ANI.
23
24
24
25
** Install bioconda package:**
25
26
@@ -33,11 +34,14 @@ ANIclustermap is implemented in Python3. [fastANI](https://github.com/ParBLiSS/F
33
34
34
35
pip install git+https://github.com/moshi4/ANIclustermap.git
35
36
37
+ > :information_source : From ANIclustermap v1.2.0, ANI calculation with [ skani] ( https://github.com/bluenote-1577/skani ) is also supported.
38
+ > This is still an experimental implementation and is being tested with skani v0.1.0. Please install skani if needed.
39
+
36
40
## Workflow
37
41
38
42
Description of ANIclustermap's automated workflow.
39
43
40
- 1 . Calculate ANI between all-vs-all microbial genomes by fastANI.
44
+ 1 . Calculate ANI between all-vs-all microbial genomes by fastANI (or skani) .
41
45
If no similarity detected by fastANI, NA is output. In that case, NA is replaced by 0.0.
42
46
If previous result available at the time of re-run, reuse previous result.
43
47
2 . Clustering ANI matrix by scipy's UPGMA method.
@@ -51,10 +55,11 @@ Description of ANIclustermap's automated workflow.
51
55
52
56
### Options
53
57
54
- -h, --help show this help message and exit
55
58
-i I, --indir I Input genome fasta directory (*.fa|*.fna[.gz]|*.fasta)
56
59
-o O, --outdir O Output directory
57
- -t , --thread_num fastANI thread number parameter (Default: MaxThread - 1)
60
+ -m , --mode ANI calculation mode ('fastani'[default]|'skani')
61
+ -t , --thread_num Thread number parameter (Default: MaxThread - 1)
62
+ --overwrite Overwrite previous ANI calculation result (Default: OFF)
58
63
--fig_width Figure width (Default: 10)
59
64
--fig_height Figure height (Default: 10)
60
65
--dendrogram_ratio Dendrogram ratio to figsize (Default: 0.15)
@@ -63,6 +68,7 @@ Description of ANIclustermap's automated workflow.
63
68
--cmap_ranges Range values (e.g. 80,90,95,100) for discrete cmap (Default: None)
64
69
--annotation Show ANI value annotation (Default: OFF)
65
70
-v, --version Print version information
71
+ -h, --help Show this help message and exit
66
72
67
73
### Example Command
68
74
0 commit comments