Skip to main content

Redundancy removal tool for gene cluster mining hit sets

Project description

CAGEcleaner

Docs Downloads Bioconda Docker Image Version PyPI version Manuscript DOI

Description

CAGEcleaner reduces redundancy in gene cluster mining hit sets. The redundancy in typical genome mining target databases (e.g. NCBI nr) often propagates into the result set, requiring extensive manual curation to carry out downstream analyses and visualisation efficiently.

Starting from a session file from a cblaster, CAGECAT, or ✨ cfoldseeker ✨ (our new protein structure similarity-based tool), CAGEcleaner dereplicates the hits based on a representative sample of the sequence regions that encode these hits (either full genomes or only the direct genomic neighbourhood). In addition, CAGEcleaner can automatically retain additional hits associated with non-representative sequences if they exhibit significant diversity in gene cluster contents or sequence similarity. Finally, CAGEcleaner returns a filtered cblaster session file and hit table, ready for downstream analyses.

[!TIP] Although CAGEcleaner can be used as a stand-alone tool, it is the dereplication engine of the ✨ csuite ✨, our new integrated toolbox featuring streamlined workflows for both sequence and protein structure-based gene cluster mining. Try it out!

workflow

Features

  • Full genome hit dereplication: Dereplicates the full genome assemblies of the host organisms using an ANI-based approach via skDER, and retains the hits that are encoded by a representative genome assembly. The more conservative option that also takes the diversity of the host organism into account. Choose this option if you're concerned about preserving host diversity during compression, for example to identify HGT events.
  • Neighbourhood hit dereplication: Extracts a genomic region of a predefined length around each hit, clusters all extracted regions by sequence similarity using MMseqs2, and retains the hits associated with the representative genomic regions. The more aggressive option that only accounts for host diversity in the direct genomic neighbourhood. Choose this option if losing host diversity is not an issue.
  • Non-cblaster input: CAGEcleaner has originally been designed to use together with cblaster, but it supports output from other mining tools as well by supplying your hits as three formatted TSV files. See the docs and the example output for the specific formatting.

Installation, documentation and more

For installation instructions, usage, explanations and more, head over to the CAGEcleaner docs!

[!NOTE] CAGEcleaner only supports the single-mode cblaster modes (remote, local, hmm). We do not recommend using sessions from one of the combi modes.

[!IMPORTANT] CAGEcleaner has no direct Windows support. If you have a seemingly successful installation directly on your Windows system, you likely have installed v1.1.0, an old version with known bugs! Please use on of the alternative options to run CAGEcleaner on Windows.

Citations

If you found CAGEcleaner useful, please cite our manuscript:

De Vrieze, L., Biltjes, M., Lukashevich, S., Tsurumi, K., Masschelein, J. (2025) CAGEcleaner: reducing genomic redundancy in gene cluster mining. Bioinformatics https://doi.org/10.1093/bioinformatics/btaf373

CAGEcleaner relies heavily on the following tools, so please give these proper credit as well.

Salamzade, R., & Kalan, L. R. (2025). skDER and CiDDER: two scalable approaches for microbial genome dereplication. Microbial Genomics, 11(7), https://doi.org/10.1099/mgen.0.001438
Shaw, J., & Yu, Y. W. (2023). Fast and robust metagenomic sequence comparison through sparse chaining with skani. Nature Methods, 20(11), 1661–1665. https://doi.org/10.1038/s41592-023-02018-3
Steinegger, M., & Söding, J. (2017). MMseqs2 enables sensitive protein sequence searching for the analysis of massive data sets. Nature Biotechnology, 35, https://doi.org/10.1038/nbt.3988
Gilchrist, C.L.M., Booth, T.J., van Wersch, B., van Grieken, L., Medema, M.H., & Chooi, Y-H. (2021). cblaster: a remote search tool for rapid identification and visualisation of homologous gene clusters. Bioinformatics Advances, https://doi.org/10.1093/bioadv/vbab016

License

CAGEcleaner is freely available under an MIT license.

Use of the third-party software, libraries or code referred to in the References section above may be governed by separate terms and conditions or license provisions. Your use of the third-party software, libraries or code is subject to any such terms and you should check that you can comply with any applicable restrictions or terms and conditions before use.

Project details


Download files

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

Source Distribution

cagecleaner-1.5.2.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

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

cagecleaner-1.5.2-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

Details for the file cagecleaner-1.5.2.tar.gz.

File metadata

  • Download URL: cagecleaner-1.5.2.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.0

File hashes

Hashes for cagecleaner-1.5.2.tar.gz
Algorithm Hash digest
SHA256 cc452fd5d8fcbb075de870e68c301c861e60f3d94074e62b77f90764f867086a
MD5 75299ff083fd311a17ff0f9a9e9bfc28
BLAKE2b-256 8d70ffdd7c762c3b496bfc75d43be6ea50af079257c8772ec648e317fddb30b5

See more details on using hashes here.

File details

Details for the file cagecleaner-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: cagecleaner-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 54.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.0

File hashes

Hashes for cagecleaner-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6ed19911e3879d3143c5c7821db9e2ae10fd105e2f43fbf7885e5c12a455d7fc
MD5 4b42d07e7684aa5fc361008678ec3526
BLAKE2b-256 631656e638b9df7e1047ca03bd6a0b97db1fb5518eb7fd703291d9a2170cb2f2

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