Nextflow Registry | nf-core/vclust/cluster@0.0.0-0c7146d

nf-core/vclust/cluster @ 0.0.0-0c7146d

Vclust cluster performs threshold-based clustering by assigning a genome sequence to a cluster if its similarity (e.g., ANI) to the cluster meets or exceeds a user-defined threshold.

cluster virus filter contig scaffold phage

Latest version: 0.0.0-0c7146d

Total downloads: 1

Source: nf-core/modules

Authors: @Joon-Klaps

Maintainers: @Joon-Klaps

Summary

Vclust cluster performs threshold-based clustering by assigning a genome sequence to a cluster if its similarity (e.g., ANI) to the cluster meets or exceeds a user-defined threshold.

Get started

Add the following snippet to your workflow script to include this module.

include { VCLUST_CLUSTER } from 'nf-core/vclust/cluster'

License

MIT License

Process

`Name`	`VCLUST_CLUSTER`

Input 6 channels

#1 tuple

`meta` map	Groovy Map containing sample information e.g. `[ id:'sample1' ]`
`tsv` file	Sorted TSV file, generated by `vclust align` `*.tsv`

#2 tuple

`meta2` map	Groovy Map containing sample information e.g. `[ id:'sample1' ]`
`ids` file	TSV file containing sequence IDs and their number of parts, generated by `vclust align` `*.ids.tsv`

`metric` string	Similarity metric for clustering choices: 'tani','gani' or 'ani' `tani\|gani\|ani`

`tani` float	Min. total ANI

`gani` float	Min. global ANI

`ani` float	Min. ANI

Output 3 channels

#1 log tuple

`meta` map	Groovy Map containing sample information e.g. `[ id:'sample1' ]`
`*.log` file	Log file containing the stdout `*.log`

#2 clusters tuple

`meta` map	Groovy Map containing sample information e.g. `[ id:'sample1' ]`
`*.tsv` file	A TSV file with genome identifiers followed by 0-based cluster identifiers. The file includes all input genomes, both clustered and singletons, listed in the same order as the IDs file (sorted by decreasing sequence length). The first genome in each cluster is the representative. `*.tsv`

#3 versions

`versions.yml` file	File containing software versions `versions.yml`

Tool	Description	Homepage
vclust	"Fast and accurate tool for calculating ANI and clustering virus genomes and metagenomes."	https://afproject.org/vclust/

Version	0.0.0-0c7146d
Commit ID	135d883a43b1a2324b4112cd270cf22e20835533
Release Date	08 Apr 2026 19:22:17 (UTC)
Download URL	https://registry-stage.nextflow.io/api/v1/modules/nf-core%2Fvclust%2Fcluster/0.0.0-0c7146d/download
OCI Store URL	https://public.cr.stage-seqera.io/v2/nextflow/plugin-stage/modules/nf-core/vclust/cluster/blobs/sha256:4bf3295505def77aad26cd3bba833120c0c6684adbcae0842146ec3104aa65a9
Size	3.3 KB
Checksum	sha256:4bf3295505def77aad26cd3bba833120c0c6684adbcae0842146ec3104aa65a9
Downloads	1

Version	Date	Status	Downloads	Size	Diff
0.0.0-0c7146d	08 Apr 2026 19:22:17 (UTC)		1	3.3 KB	-