Skip to main content

Python framework for interpretable protein prediction

Project description

Welcome to the AAanalysis documentation!

Package

PyPI - Status PyPI - Package Version Supported Python Versions Downloads License

Testing

CI/CD Pipeline CodeQL Codecov Documentation Status

Overview of AAanalysis components

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 our explainable AI module, please use the ‘professional’ version:

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 (link if available)

dPULearn:

Breimann and Kamp et al. (2025), Charting γ-secretase substrates by explainable AI, Nature Communications (link if available)

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

aaanalysis-1.0.2.tar.gz (8.1 MB view details)

Uploaded Source

Built Distribution

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

aaanalysis-1.0.2-py3-none-any.whl (8.1 MB view details)

Uploaded Python 3

File details

Details for the file aaanalysis-1.0.2.tar.gz.

File metadata

  • Download URL: aaanalysis-1.0.2.tar.gz
  • Upload date:
  • Size: 8.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.2 Linux/5.11.22-100.fc32.x86_64

File hashes

Hashes for aaanalysis-1.0.2.tar.gz
Algorithm Hash digest
SHA256 7430eb5a6a292662a7915baf8fb73882f9cd773dd69620cf8f30ae426968f8b9
MD5 4cd19cd20f616864d78f7e4687c5494e
BLAKE2b-256 eaecd4aeab87673d1d7c5d091ee41f2aee6138f4b3b4fd4510535a577ed436ff

See more details on using hashes here.

File details

Details for the file aaanalysis-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: aaanalysis-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.2 Linux/5.11.22-100.fc32.x86_64

File hashes

Hashes for aaanalysis-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5bdbf0c3765245fdb601fba512501f383f64ff63ba33d08ddf08b8dec8a46dba
MD5 c6dc458b760ebfc2403f5fa800d129ab
BLAKE2b-256 5f6c6fa6051f6f2db65bbe7ca5de30dd4b4f7c51c9937fbe8db28883742f2840

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