Skip to main content

Fast and accurate tool for calculating Average Nucleotide Identity (ANI) and clustering virus genomes and metagenomic contigs

Project description

Vclust logo Vclust

GitHub Release PyPI - Version Build and tests License: GPL v3

PyPI - Total Downloads PyPI - Downloads GitHub downloads Bioconda downloads

x86-64 ARM Apple M Linux macOS

Vclust is an alignment-based tool for fast and accurate calculation of Average Nucleotide Identity (ANI) between complete or metagenomically-assembled viral genomes. The tool also performs ANI-based clustering of genomes according to standards recommended by international virus consortia, including International Committee on Taxonomy of Viruses (ICTV) and Minimum Information about an Uncultivated Virus Genome (MIUViG).

Features

:gem: Accurate ANI calculations

Vclust uses a Lempel-Ziv-based pairwise sequence aligner (LZ-ANI) for ANI calculation. LZ-ANI achieves high sensitivity in detecting matched and mismatched nucleotides, ensuring accurate ANI determination. Its efficiency comes from a simplified indel handling model, making LZ-ANI magnitudes faster than alignment-based tools (e.g., BLASTn, MegaBLAST) while maintaining comparable accuracy to the most sensitive BLASTn searches.

:triangular_ruler: Multiple similarity measures

Vclust offers multiple similarity measures between two genome sequences:

  • ANI: The number of identical nucleotides across local alignments divided by the total length of the alignments.
  • Global ANI (gANI): The number of identical nucleotides across local alignments divided by the length of the query/reference genome.
  • Total ANI (tANI): The number of identical nucleotides between query-reference and reference-query genomes divided by the sum length of both genomes. tANI is equivalent to the VIRIDIC's intergenomic similarity.
  • Coverage (alignment fraction): The proportion of the query/reference sequence aligned with the reference/query sequence.
  • Number of local alignments: The number of local alignments between the two genome sequences.
  • Ratio between genome lengths: The length of the shorter genome divided by the longer one.

:star2: Multiple clustering algorithms

Vclust provides six clustering algorithms tailored to various scenarios, including taxonomic classification and dereplication of viral genomes.

  • Single-linkage
  • Complete-linkage
  • UCLUST
  • CD-HIT (Greedy incremental)
  • Greedy set cover (adopted from MMseqs2)
  • Leiden algorithm [optional]

:fire: Speed and efficiency

Vclust uses three efficient C++ tools - Kmer-db, LZ-ANI, Clusty - for prefiltering, aligning, calculating ANI, and clustering viral genomes. This combination enables the processing of millions of virus genomes within a few hours on a mid-range workstation.

:earth_americas: Web service

For datasets containing up to 1000 viral genomes, Vclust is available at http://www.vclust.org.

Quick start

# Install Vclust (requires Python >= 3.7)
pip install vclust

# Prefilter similar genome sequence pairs before conducting pairwise alignments.
vclust prefilter -i example/multifasta.fna -o fltr.txt

# Align similar genome sequence pairs and calculate pairwise ANI measures.
vclust align -i example/multifasta.fna -o ani.tsv --filter fltr.txt

# Cluster genome sequences based on given ANI measure and minimum threshold.
vclust cluster -i ani.tsv -o clusters.tsv --ids ani.ids.tsv --metric ani --ani 0.95

Documentation

The Vclust documentation is available on the GitHub Wiki and includes the following sections:

  1. Features
  2. Installation
  3. Quick Start
  4. Usage
    1. Input data
    2. Prefilter
    3. Align
    4. Cluster
    5. Deduplicate
  5. Optimizing sensitivity and resource usage
  6. Use cases
    1. Classify viruses into species and genera following ICTV standards
    2. Assign viral contigs into vOTUs following MIUViG standards
    3. Dereplicate viral contigs into representative genomes
    4. Process large dataset of diverse virus genomes (IMG/VR)
    5. Deduplicate (remove duplicate sequences) between and within multiple datasets
    6. Process large dataset of highly redundant virus genomes
    7. Cluster plasmid genomes into pOTUs
    8. Calculate pairwise similarities between all-versus-all genomes
  7. FAQ: Frequently Asked Questions

Citation

Zielezinski A, Gudyś A, Barylski J, Siminski K, Rozwalak P, Dutilh BE, Deorowicz S. Ultrafast and accurate sequence alignment and clustering of viral genomes. Nat Methods. https://doi.org/10.1038/s41592-025-02701-7

License

GNU General Public License, version 3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

vclust-1.3.1-py3-none-manylinux2014_x86_64.whl (5.6 MB view details)

Uploaded Python 3

vclust-1.3.1-py3-none-manylinux2014_aarch64.whl (4.9 MB view details)

Uploaded Python 3

vclust-1.3.1-py3-none-macosx_11_0_arm64.whl (3.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

vclust-1.3.1-py3-none-macosx_10_9_x86_64.whl (4.1 MB view details)

Uploaded Python 3macOS 10.9+ x86-64

File details

Details for the file vclust-1.3.1-py3-none-manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for vclust-1.3.1-py3-none-manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6d428fabf5e5cb7de9c2990736fb3992e7dde74ede1e351bd1cff00ee7d5d918
MD5 ebfe0b301315ac0a39c607574156fcbc
BLAKE2b-256 3fee1bb525fd4d8b144c519770c85f0a8b9b97553323205b5b75d421229a9e73

See more details on using hashes here.

File details

Details for the file vclust-1.3.1-py3-none-manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for vclust-1.3.1-py3-none-manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 85d7c401b2b51d1576bc798454ccd1536011330ac48c74d9c2c2466ee92d645c
MD5 4937d87d4b10596510eba00b2c845d42
BLAKE2b-256 0f597bc47dd06a8a35b28fa9f39e123ffd92928de56641b29eaeed86ae40f339

See more details on using hashes here.

File details

Details for the file vclust-1.3.1-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vclust-1.3.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b015074b18a39ad08204ce64e7c853c6c61805e7ce04001b33eac8d883f3abda
MD5 6adf7330b90a1a1d95c00b4bce562e85
BLAKE2b-256 ae6b9cf886373ec2732fee163af07319a7b5adaa192cd63bea689d2afa81dbcc

See more details on using hashes here.

File details

Details for the file vclust-1.3.1-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for vclust-1.3.1-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ab47ca446b21a28cee57635d0aa28e321db1fea2c13fef5244496a9d0afd6d1d
MD5 9a0dbcc342356353ab865c0214362335
BLAKE2b-256 274e3f107f851666b5049be44c38c929b2a2223ece0bdd50e1d9053dedc95d2c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page