Python framework for interpretable protein prediction
Project description
Welcome to the AAanalysis documentation!
Package |
|
|---|---|
Testing |
AAanalysis (Amino Acid analysis) is a Python framework for interpretable sequence-based protein prediction. Its foundation are the following algorithms:
CPP: Comparative Physicochemical Profiling, a feature engineering algorithm comparing two sets of protein sequences to identify the set of most distinctive features.
dPULearn: deterministic Positive-Unlabeled (PU) Learning algorithm to enable training on unbalanced and small datasets.
AAclust: k-optimized clustering wrapper framework to select redundancy-reduced sets of numerical scales (e.g., amino acid scales).
In addition, AAanalysis provide functions for loading various protein benchmark datasets, amino acid scales, and their two-level classification (AAontology). We combined CPP with the explainable AI SHAP framework to explain sample level predictions with single-residue resolution.
If you are looking to make publication-ready plots with a view lines of code, see our Plotting Prelude.
You can find the official documentation at Read the Docs.
Install
AAanalysis can be installed from PyPi:
pip install aaanalysis
For extended features, including the explainable AI module:
pip install "aaanalysis[pro]"
If you use uv, the equivalent commands are:
uv pip install aaanalysis
uv pip install "aaanalysis[pro]"
Contributing
We appreciate bug reports, feature requests, or updates on documentation and code. For details, please refer to Contributing Guidelines. These include specifics about AAanalysis and also notes on Test Guided Development (TGD) using ChatGPT. For further questions or suggestions, please email stephanbreimann@gmail.com.
Citations
If you use AAanalysis in your work, please cite the respective publication as follows:
- AAclust:
Breimann and Frishman (2024a), AAclust: k-optimized clustering for selecting redundancy-reduced sets of amino acid scales, Bioinformatics Advances.
- AAontology:
Breimann et al. (2024b), AAontology: An ontology of amino acid scales for interpretable machine learning, Journal of Molecular Biology.
- CPP:
Breimann and Kamp et al. (2025), Charting γ-secretase substrates by explainable AI, Nature Communications.
- dPULearn:
Breimann and Kamp et al. (2025), Charting γ-secretase substrates by explainable AI, Nature Communications.
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 aaanalysis-1.0.3.tar.gz.
File metadata
- Download URL: aaanalysis-1.0.3.tar.gz
- Upload date:
- Size: 8.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.4 CPython/3.13.11 Darwin/25.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
604d43f5fa324a26527aa0ab014c979d508e11c805f28e3e5f72d48d989b2783
|
|
| MD5 |
0a7917388ed0435adba1e9c86d06a79d
|
|
| BLAKE2b-256 |
2662833eb646fefd8bb3e14cf6850735e857099f8d7078adc57dab49fe50bed2
|
File details
Details for the file aaanalysis-1.0.3-py3-none-any.whl.
File metadata
- Download URL: aaanalysis-1.0.3-py3-none-any.whl
- Upload date:
- Size: 8.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.4 CPython/3.13.11 Darwin/25.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
906b90d842844c1c2203e1ec761ee3ad6ea86e3357d71a1b10af0658c4e3b849
|
|
| MD5 |
67d9fbb77f4805e0312a63f3adbae348
|
|
| BLAKE2b-256 |
f44b2e7d17a6df7d6b47c58c1bf0f37dbeb637383ccf642d90ce66db1a9cdf6e
|