Genomic redundancy removal tool for cblaster hit sets
Project description
CAGEcleaner
[!NOTE]
CAGEcleanersupports all functionalcblastermodes (remote, local, hmm). We do not recommend using one of the combi modes as we have found bugs in it.
[!TIP]
CAGEcleanerwill be integrated intocblaster! You can already check out the development version at this fork (currently integrates CAGECleaner v1.2.3).
Outline
CAGEcleaner removes genomic redundancy from gene cluster hit sets identified by cblaster. The redundancy in target databases used by cblaster often propagates into the result set, requiring extensive manual curation before downstream analyses and visualisation can be carried out.
Given a session file from a cblaster run (or from a CAGECAT run), CAGEcleaner retrieves all hit-associated genome assemblies, groups these into assembly clusters by ANI and identifies a representative assembly for each assembly cluster using skDER. In addition, CAGEcleaner can retain hits that are divergent at the gene cluster level but are associated with non-representative genomes. Finally, CAGEcleaner returns a filtered cblaster session file as well as a list of retained gene cluster IDs for more straightforward downstream analysis.
Installation and more
For installation instructions, usage, explanations and more, head over to the CAGEcleaner wiki!
[!IMPORTANT]
CAGEcleanerhas no direct Windows support. If you seem to have it installed successfully on your Windows system, you probably have just installed v1.1.0, an old version with known bugs! There are 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 skDER genome dereplication tool and its main dependency skani, so please give these proper credit as well.
Salamzade, R., & Kalan, L. R. (2023). skDER: microbial genome dereplication approaches for comparative and metagenomic applications. bioRxiv https://doi.org/10.1101/2023.09.27.559801`
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cagecleaner-1.4.5.tar.gz.
File metadata
- Download URL: cagecleaner-1.4.5.tar.gz
- Upload date:
- Size: 20.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e6a824e16d5783cfdcab3ff00939da9955ab266d62a9295ae3e82d41ab8a3bc5
|
|
| MD5 |
9f16d49e32cc0cf3f9d4be9b09eec10d
|
|
| BLAKE2b-256 |
cfc7f4378afa4b7256507ca29d7141a74dee2f7d704b8907cff4dddd62efd72c
|
File details
Details for the file cagecleaner-1.4.5-py3-none-any.whl.
File metadata
- Download URL: cagecleaner-1.4.5-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcf5f4af669fa306b2f11c0c959a3bdb51aa9d03805235da8e06aa289eaacf8a
|
|
| MD5 |
755d4929ec44f8ab112c56289a4f3e7a
|
|
| BLAKE2b-256 |
54c5c930f589c96b2e2da6f0c411f69bd0428b0c0b6001012a83e33d57956f21
|