Chemical Hierarchy Approximation for secondary Metabolism clusters Obtained In Silico.
Project description
๐ CHAMOIS 
Chemical Hierarchy Approximation for secondary Metabolism clusters Obtained In Silico.
๐บ๏ธ ๏ธOverview
CHAMOIS is a fast method for predicting chemical features of natural products produced by Biosynthetic Gene Clusters (BGCs) using only their genomic sequence. It can be used to get chemical features from BGCs predicted in silico with tools such as GECCO or antiSMASH.
๐ก Usage
This section shows only the basic commands for installing and running CHAMOIS. The online documentation contains a more detailed installation guide, examples, an API reference, and a CLI reference
๐ง Installing CHAMOIS
CHAMOIS is implemented in Python, and supports all versions from Python 3.7 onwards. It requires additional libraries that can be installed directly from PyPI, the Python Package Index.
Clone the repository and install it from the local folder. This will take a little bit of time, since it will download the Pfam HMMs used for annotation and install dependencies:
$ pip install chamois-tool
Note that CHAMOIS uses HMMER3, which can only run on PowerPC, x86-64 and Aarch64 machines running a POSIX operating system. Therefore, CHAMOIS will work on Linux and OSX, but not on Windows.
๐งฌ Running CHAMOIS
Once CHAMOIS is installed, you can run it from the terminal by providing it with one or more GenBank file the genomic records of the BGCs to analyze, and an output path where to write the results in HDF5 format. For instance to predict the classes for BGC0000703, a kanamycin-producing BGC from MIBiG:
$ chamois predict -i tests/data/BGC0000703.4.gbk -o tests/data/BGC0000703.4.hdf5
๐ Viewing results
The output file can be loaded with the anndata
package, and corresponds
to a probability matrix where rows are the input BGCs, and columns are the
ChemOnt classes.
To get a summary for each predicted BGC, use the render
command:
$ chamois render -i tests/data/BGC0000703.4.hdf5
Predictions for each BGC will be shown as a tree with their computed probabilities:
CHEMONTID:0000002 (Organoheterocyclic compounds): 0.996
โโโ CHEMONTID:0002012 (Oxanes): 0.996โ
โโโ CHEMONTID:0004140 (Oxacyclic compounds): 0.976
CHEMONTID:0004150 (Hydrocarbon derivatives): 0.999
CHEMONTID:0004557 (Organopnictogen compounds): 0.948
CHEMONTID:0004603 (Organic oxygen compounds): 1.000
โโโ CHEMONTID:0000323 (Organooxygen compounds): 1.000
โโโ CHEMONTID:0000011 (Carbohydrates and carbohydrate conjugates): 0.996
โ โโโ CHEMONTID:0001540 (Monosaccharides): 0.996
โ โโโ CHEMONTID:0002105 (Glycosyl compounds): 0.977
โ โ โโโ CHEMONTID:0002207 (O-glycosyl compounds): 0.977
โ โโโ CHEMONTID:0003305 (Aminosaccharides): 0.995
โ โโโ CHEMONTID:0000282 (Aminoglycosides): 0.995
โ โโโ CHEMONTID:0001675 (Aminocyclitol glycosides): 0.995
โ โโโ CHEMONTID:0003575 (2-deoxystreptamine aminoglycosides): 0.961
โโโ CHEMONTID:0000129 (Alcohols and polyols): 1.000
โ โโโ CHEMONTID:0000286 (Primary alcohols): 0.891
โ โโโ CHEMONTID:0001292 (Cyclic alcohols and derivatives): 0.998
โ โ โโโ CHEMONTID:0002509 (Cyclitols and derivatives): 0.996
โ โ โโโ CHEMONTID:0002510 (Aminocyclitols and derivatives): 0.987
โ โโโ CHEMONTID:0001661 (Secondary alcohols): 0.999
โ โ โโโ CHEMONTID:0002647 (Cyclohexanols): 0.995
โ โโโ CHEMONTID:0002286 (Polyols): 0.972
โโโ CHEMONTID:0000254 (Ethers): 0.959
โโโ CHEMONTID:0001656 (Acetals): 0.959
CHEMONTID:0004707 (Organic nitrogen compounds): 0.999
โโโ CHEMONTID:0000278 (Organonitrogen compounds): 0.999
โโโ CHEMONTID:0002449 (Amines): 0.999
โ โโโ CHEMONTID:0002450 (Primary amines): 0.989
โ โ โโโ CHEMONTID:0000469 (Monoalkylamines): 0.989
โ โโโ CHEMONTID:0002460 (Alkanolamines): 0.999
โ โโโ CHEMONTID:0001897 (1,2-aminoalcohols): 0.992
โโโ CHEMONTID:0002674 (Cyclohexylamines): 0.987
๐ Reference
CHAMOIS can be cited using the following preprint:
Machine learning inference of natural product chemistry across biosynthetic gene cluster types. Martin Larralde, Georg Zeller. bioRxiv 2025.03.13.642868; doi:10.1101/2025.03.13.642868
๐ญ Feedback
โ ๏ธ Issue Tracker
Found a bug ? Have an enhancement request ? Head over to the GitHub issue tracker if you need to report or ask something. If you are filing in on a bug, please include as much information as you can about the issue, and try to recreate the same bug in a simple, easily reproducible situation.
๐๏ธ Contributing
Contributions are more than welcome! See CONTRIBUTING.md
for more details.
โ๏ธ License
This software is provided under the GNU General Public License v3.0 or later. CHAMOIS is developped by the Zeller Lab at the European Molecular Biology Laboratory in Heidelberg and the Leiden University Medical Center in Leiden.
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
File details
Details for the file chamois_tool-0.1.1.tar.gz
.
File metadata
- Download URL: chamois_tool-0.1.1.tar.gz
- Upload date:
- Size: 620.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
d46c70942bcdc3bf97f19629700be29a7dd9613d18ebd2b09d737861567cd889
|
|
MD5 |
f2df5f9d5668a266aa924bfff449a24d
|
|
BLAKE2b-256 |
40781650d2bd08c22011300303a4ea80fef0b2df613c3ed04d6af889e601a904
|
Provenance
The following attestation bundles were made for chamois_tool-0.1.1.tar.gz
:
Publisher:
test.yml
on zellerlab/CHAMOIS
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
chamois_tool-0.1.1.tar.gz
-
Subject digest:
d46c70942bcdc3bf97f19629700be29a7dd9613d18ebd2b09d737861567cd889
- Sigstore transparency entry: 186030498
- Sigstore integration time:
-
Permalink:
zellerlab/CHAMOIS@d3be0e8e36355706f23daf7921dc593205a0e8ab
-
Branch / Tag:
refs/tags/v0.1.1
- Owner: https://github.com/zellerlab
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
test.yml@d3be0e8e36355706f23daf7921dc593205a0e8ab
-
Trigger Event:
push
-
Statement type: