Skip to main content

Genomic redundancy removal tool for cblaster hit sets

Project description

cagecleaner

DOI

>>> cagecleaner has now been integrated into cblaster! <<<

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 reinclude hits that are different at the gene cluster level despite the genomic redundancy, and this by different gene cluster content and/or by outlier cblaster scores. Finally, cagecleaner returns a filtered cblaster session file as well as a list of retained gene cluster IDs for easier downstream analysis.

For installation instructions, usage, explanations and more, head over to the cagecleaner wiki!

workflow

Citations

If you found cagecleaner useful, please cite our manuscript:

Coming soon!

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. 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


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.1.0.tar.gz (15.8 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.1.0-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cagecleaner-1.1.0.tar.gz
Algorithm Hash digest
SHA256 95bac43ac19f11008c38ea1c9477e00403fd44bf4a425ccec70426b8f25b50b9
MD5 bbf50a09f84c123d12caf750a44275ac
BLAKE2b-256 a8b9d6f6d74ef0b8fda19788ee8ce2380bcb1cada011c46e2ba00fdf4860d75d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cagecleaner-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.9 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3dc5e85a75588752924a7a98c650035ff9d8e1cc2fdd424f58c877e5d60ec7ca
MD5 037d425d26ec184bf7252c8348eef584
BLAKE2b-256 ace080b675b5da3479bc920175fb19032b00adb8dd2878a05c51800d2d8b4e12

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