Skip to content

Commit 2aa02fb

Browse files
authored
Bump to v1.2.0 (#8)
- Change v1.1.0 to v1.2.0 - Add support for ANI calculation with `skani` - Add `--overwrite` CLI argument option - Fix a bug that removed end of certain filenames
1 parent a5c01ca commit 2aa02fb

File tree

7 files changed

+675
-207
lines changed

7 files changed

+675
-207
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ jobs:
1414
strategy:
1515
matrix:
1616
os: [ubuntu-latest]
17-
python-version: [3.7, 3.8, 3.9]
17+
python-version: [3.8, 3.9, "3.10"]
1818
steps:
1919
- name: Checkout
20-
uses: actions/checkout@v2
20+
uses: actions/checkout@v3
2121

2222
- name: Setup Python ${{ matrix.python-version}}
23-
uses: actions/setup-python@v2
23+
uses: actions/setup-python@v4
2424
with:
2525
python-version: ${{ matrix.python-version }}
2626

@@ -40,11 +40,3 @@ jobs:
4040

4141
- name: Run pytest
4242
run: poetry run pytest tests --tb=line --cov=src --cov-report=xml --cov-report=term
43-
44-
# - name: Upload coverage to Codecov
45-
# if: ${{ matrix.python-version==3.8 }} && ${{ matrix.os=='ubuntu-latest' }}
46-
# uses: codecov/codecov-action@v2
47-
# with:
48-
# name: pytest-codecov
49-
# files: coverage.xml
50-
# fail_ci_if_error: true

.github/workflows/publish_to_pypi.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ jobs:
1212
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
1313
steps:
1414
- name: Checkout
15-
uses: actions/checkout@v2
15+
uses: actions/checkout@v3
1616

17-
- name: Setup Python 3.8
18-
uses: actions/setup-python@v2
17+
- name: Setup Python 3.9
18+
uses: actions/setup-python@v4
1919
with:
20-
python-version: 3.8
20+
python-version: 3.9
2121

2222
- name: Install Dependencies
2323
run: |

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
## Overview
1010

1111
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.
1314

1415
![ANIclustermap.png](https://raw.githubusercontent.com/moshi4/ANIclustermap/main/images/normal_dataset/ANIclustermap.png)
1516
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
1920

2021
## Installation
2122

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.
2324

2425
**Install bioconda package:**
2526

@@ -33,11 +34,14 @@ ANIclustermap is implemented in Python3. [fastANI](https://github.com/ParBLiSS/F
3334

3435
pip install git+https://github.com/moshi4/ANIclustermap.git
3536

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+
3640
## Workflow
3741

3842
Description of ANIclustermap's automated workflow.
3943

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).
4145
If no similarity detected by fastANI, NA is output. In that case, NA is replaced by 0.0.
4246
If previous result available at the time of re-run, reuse previous result.
4347
2. Clustering ANI matrix by scipy's UPGMA method.
@@ -51,10 +55,11 @@ Description of ANIclustermap's automated workflow.
5155

5256
### Options
5357

54-
-h, --help show this help message and exit
5558
-i I, --indir I Input genome fasta directory (*.fa|*.fna[.gz]|*.fasta)
5659
-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)
5863
--fig_width Figure width (Default: 10)
5964
--fig_height Figure height (Default: 10)
6065
--dendrogram_ratio Dendrogram ratio to figsize (Default: 0.15)
@@ -63,6 +68,7 @@ Description of ANIclustermap's automated workflow.
6368
--cmap_ranges Range values (e.g. 80,90,95,100) for discrete cmap (Default: None)
6469
--annotation Show ANI value annotation (Default: OFF)
6570
-v, --version Print version information
71+
-h, --help Show this help message and exit
6672

6773
### Example Command
6874

0 commit comments

Comments
 (0)