Clusty is a tool for large-scale clustering. By using sparse distance matrices it allows clustering data sets with millions of objects.

git clone --recurse-submodules https://github.com/refresh-bio/clusty
cd clusty
make -j

cd ./test

# Run single linkage clustering on the pairwise similarities stored in ictv.ani file, output cluster identifiers
# (two first columns are used as sequence identifiers, third one is assumed to store similarities).
../clusty --algo single --similarity ictv.ani ictv.single

# Run uclust clustering accepting pairwise connectios with values greater or equal 0.70 in the ani column, output cluster representatives.
../clusty --algo uclust --similarity --min ani 0.70 --out-representatives ictv.ani ictv.uclust.70

# Run CD-HIT clustering accepting pairwise connectios with values greater or equal 0.95 in the ani column, output cluster identifiers
# (use id2 and id2 columns as object identifiers and ani column as the similarity).
../clusty --algo cd-hit --similarity --min ani 0.95 --id-cols id2 id1 --distance-col ani vir61.ani vir61.single.95

# Run complete linkage clustering, consider all objects from ictv.list file (including those without pairwise connections).
../clusty --algo complete --objects-file ictv.list --similarity ictv.ani ictv.complete

Clusty comes with a set of precompiled binaries for Windows and Linux. They can be found under Releases tab. The package can be also built from the sources distributed as:

• Visual Studio 2022 solution for Windows,
• MAKE project for Linux (g++-10 required).

Clusty provides igraph's implementation of the Leiden algorithm. However, as igraph requires several external dependencies (CMake 3.18, Flex, Bison), it is by default not linked to the Clusty software. To install dependencies under Debian/Ubuntu linux use the following command:

sudo apt-get install cmake flex bison

Then, one need to build the package with an additional option enabled:

make -j LEIDEN=true

Under Windows, Clusty is by default linked against igraph and it requires CMake as the only system dependency. After installing it (https://cmake.org) a user can run build_igraph.bat batch script which downloads Flex and Bison binaries to the appropriate locations and then builds igraph. After that it is possible to build Clusty using Visual Studio (the solution is located in ./src/clusty.sln).

clusty [options] <distances> <assignments>

Parameters:

• <distances> - input TSV/CSV table with pairwise distances
• <assignments> - output TSV/CSV file with cluster assignments

Options:

• --objects-file <string> - optional TSV/CSV file with object names in the first column sorted decreasingly w.r.t. representativness

• --algo <single | complete | uclust | set-cover | cd-hit | leiden> - clustering algorithm:

  • single - single linkage (connected component, MMseqs mode 1)
  • complete - complete linkage
  • uclust - UCLUST
  • set-cover - greedy set cover (MMseqs mode 0)
  • cd-hit - CD-HIT (greedy incremental; MMseqs mode 2)
  • leiden - Leiden algorithm

• --id-cols <column-name1> <column-name2> - names of columns with object identifiers (default: two first columns)

• --distance-col <column-name> - name of the column with pairwise distances (or similarities; default: third column)

• --similarity - use similarity instead of distance (has to be in [0,1] interval; default: false)

• --percent-similarity - use percent similarity (has to be in [0,100] interval; overrides --similarity flag, default: false)

• --min <column-name> <real-threshold> - accept pairwise connections with values greater or equal a given threshold in a specified column

• --max <column-name> <real-threshold> - accept only pairwise connections with values lower or equal a given threshold in a specified column

• --numeric-ids - use when sequences in the distances file are represented by numbers (can be mapped to string ids by the object file)

• --out-representatives - output representative objects for each cluster instead of cluster numerical identifiers

• --out-csv -- output a CSV table instead of a default TSV

• --leiden-resolution - resolution parameter for Leiden algorithm (default: 0.7)

• --leiden-beta - beta parameter for Leiden algorithm (default: 0.01)

• --leiden-iterations - number of interations for Leiden algorithm (default: 2)

The minimum input requirement is a CSV/TSV table with pairwise distances between objects (or similarities, if --use-similarity flag is used). By default, identifiers are assumed to be in the two first columns while distances are expected in the third one. Lack of a distance for a given pair of objects is translated to infinite distance. The example input table is given below:

id1,id2,distance
a,b,0.04
a,f,0.25
a,c,0.02
d,b,0.70
b,c,0.51
e,f,0.01

If the table is organized differenty, one can specify columns with ids and distances by using --id-cols and --distance-col parameters. The algorithm produces as a result a TSV table (or CSV if --out-csv flag is specified) with object identifiers followed by 0-based numerical identifiers of clusters. The objects appear in the order as in the distance table.

object	cluster
a	0
b	0
f	1
c	0
d	2
e	1

Alternatively, instead of numerical identifiers, package can output a representative object for every cluster using --out-representatives flag. The representative of a cluster is the first object on the list that was assigned to the cluster:

object	cluster
a	a
b	a
f	f
c	a
d	d
e	f

An optional TSV/CSV file specified by --objects-file parameter contains a complete list of analyzed objects. This file can be useful when distance table does not contain all the object (e.g., due to some filtering). Additionally, this file determines order in which objects appear in ouput table (thus, it also affects cluster representatives when using --out-representatives flag). For instance, if one specifies following objects file:

objects
b
x
a
c
e
d
f

the following output will be produced:

object	cluster
b	b
x	x
a	b
c	b
e	e
d	d
f	e

In the following section one can find detailed information on clustering algorithms in Clusty, with n representing the number of objects (vertices) and e the number of distances (edges) in the data set (graph).