pairwiseaniviz

Pairwise ANI(Average Nucleotide Identity) visulization tool.

https://github.com/runjiaji/pairwiseaniviz

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Pairwise ANI(Average Nucleotide Identity) visulization tool.

Basic Info
  • Host: GitHub
  • Owner: RunJiaJi
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 986 KB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

pairwiseANIviz

PyPI version Downloads Downloads Downloads

Pairwise ANI (Average Nucleotide Identity) visulization tool. This tool is designed to help visualize the results of pairwise comparisons among multiple genomes.

First, Scipy is used to perform hierarchical/agglomerative clustering, followed by generating a clustermap using Seaborn that supports various Matplotlib colormaps.

Main features

  • Support various matplotlib colormaps
  • Taxonomic classification result can be included to illustrate different taxa
  • Specific outrange ANI values can be set (eg. 95% ANI values)
  • Multi-format outputs (JPG, PNG, TIFF, SVG, PDF, EPS)

Example

1. Using different matplotlib colormaps

Figure

2. With taxonomy indicated by different palettes

Figure

3. With ANI values illustrated

Figure

4. With outrange ANI values (95%) colored red

Figure

Installation

```shell

Dependencies: Matplotlib, Seaborn, Scipy, Pandas

Install pairwiseANIviz using pip

pip install pairwiseANIviz==1.3 ```

Usage

overallUsage

Options

```bash usage: pairwiseANIviz [options] anifile

positional arguments: anifile File containing pairwise ANI analysis result.

options: -h, --help show this help message and exit -v, --version Show pairwiseANIviz version number and exit. -o OUTDIR, --outdir OUTDIR Directory to save the output figures (default 'pairwiseANIviz'). --method {single,complete,average,weighted,centroid,median,ward} Linkage method to use for calculating clusters (default 'average'). See https://docs.scipy.org/doc/scipy/reference/generated/scipy.cluster.hierarchy.linkage.html#scipy.cluster.hierarchy.linkage --metric {braycurtis,canberra,chebyshev,cityblock,correlation,cosine,dice,euclidean,hamming,jaccard,jensenshannon,kulczynski1,mahalanobis,matching,minkowski,rogerstanimoto,russellrao,seuclidean,sokalmichener,sokalsneath,sqeuclidean,yule} The distance metric to use (default 'euclidean'). See https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.pdist.html#scipy.spatial.distance.pdist -cmap COLORMAP, --colormap COLORMAP Matplotlib colormap used when drawing the heatmap of ANI values (default 'Blues'). See https://matplotlib.org/stable/users/explain/colors/colormaps.html --figWidth FIGWIDTH Figure width (default '15'). --figHeight FIGHEIGHT Figure height (default '15'). --linewidth LINEWIDTH Line width of the main heatmap (default 0.5) --linecolor LINECOLOR Line color of the main heatmap (default 'grey'). --rowCluster Draw the row cluster. --colCluster Draw the column cluster. --annotation Show ANI values on the plot. --outrangeValue OUTRANGEVALUE Cells have ANI values over specific threshold set to red (eg. cells have ANI value >=0.95 set to red) (default 100). -c CLASSIFICATIONFILE, --classificationFile CLASSIFICATIONFILE File containing classification result generated by GTDBTk(https://github.com/Ecogenomics/GTDBTk). -t {domain,phylum,class,order,family,genus,species}, --taxaLevel {domain,phylum,class,order,family,genus,species} Taxa level illustrated on the plot. Choose from "domain, phylum, class, order, family, genus, species". Note that this parameter only works if classification result was input. --colorPalette COLORPALETTE Color palette used to return a specified number of evenly spaced hues which are then used to illustrate different taxa (default 'hls'). Note that this parameter only works if classification result was input.

General usage

  1. ANI result visulization without classification info: $ pairwiseANIviz ani_result.txt

  2. ANI result visulization with classification info: $ pairwiseANIviz aniresult.txt --classificationFile classificationresult.tsv

  3. ANI result visualization with hierarchical clustering: $ pairwiseANIviz --rowCluster --colCluster ani_result.txt

Runjia Ji, 2023 ```

Citation

If you use pairwiseANIviz in your research, please cite our related paper:

Ji, R., Wan, J., Liu, J. et al. Linking morphology, genome, and metabolic activity of uncultured magnetotactic Nitrospirota at the single-cell level. Microbiome 12, 158 (2024). https://doi.org/10.1186/s40168-024-01837-6

Contact

If you have any questions using pairwiseANIviz, feel free to open an issue or contact me jirunjia@gmail.com.

Owner

  • Name: RunjiaJi
  • Login: RunJiaJi
  • Kind: user
  • Location: BeiJing, China
  • Company: IGGCAS

GitHub Events

Total
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 2
  • Fork event: 1
Last Year
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 2
  • Fork event: 1

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: pairwiseaniviz

Pairwise ANI (Average Nucleotide Identity) visualization tool

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15 Last month
Rankings
Dependent packages count: 7.3%
Average: 37.9%
Dependent repos count: 68.5%
Maintainers (1)
Last synced: 10 months ago