Skip to main content

A Python package for applying pre-trained epigenomic classification models

Project description

ALMA Classifier

A Python package for applying pre-trained epigenomic classification models to methylation data. This package provides three main predictive models:

  1. ALMA Subtype: Predicts 28 subtypes/classes (27 WHO 2022 subtypes of acute leukemia + otherwise-normal control).
  2. AML Epigenomic Risk: Predicts the probability of death within 5 years for AML patients using ALMA.
  3. 38CpG AML Signature: Predicts same as above, but using a targeted panel of 38 CpGs.

Installation

# first make sure you are running python3.8
python --version

# create a virtual env
python -m venv .venv
source .venv/bin/activate

# install pacmap==0.7.0 (required)
pip install pacmap==0.7.0

# Then install alma-classifier
pip install alma-classifier

# Download model files (required)
python -m alma_classifier.download_models

Important Notes

  1. This is a pre-release research tool. Initial versions will be picky and annoying to deal with. Future versions will be flexible and easy to use.
  2. Our diagnostic model currently does not know about important cases, which we really need training data for: AML with Down Syndrome, juvenile myelomonocytic leukemia, transient abnormal myelopoiesis, bone marrow failures, low-risk MDS, lymphomas, and others.
  3. Our prognostic models (AML Epigenomic Risk and 38CpG AML Signature) are currently only limited to AML cases.

Usage

Command Line Interface

# Run with your own data
alma-classifier --input path/to/data.pkl --output path/to/predictions.xlsx

# Try the demo with example dataset
alma-classifier --demo --output predictions.xlsx

Input Data Format

The input data should be a matrix of methylation beta values with:

  • Rows representing samples
  • Columns representing CpG sites
  • Values between 0 and 1

Model Outputs and Prediction Behavior

The package generates predictions with the following behavior:

  1. ALMA Subtype Classification:

    • Outputs the predicted subtype and its probability
    • If confidence is below threshold (default 0.5), outputs "Not confident"
    • For predictions with confidence between 0.5-0.8, also outputs the second most likely subtype and its probability
  2. AML Epigenomic Risk (only for AML/MDS samples):

    • Outputs "High" or "Low" risk prediction
    • Includes P(Death) at 5y probability
    • Outputs "Not confident" if prediction confidence is below threshold
    • Non-AML/MDS samples receive "NaN" values
  3. 38CpG AML Signature (only for AML/MDS samples):

    • Outputs continuous hazard score (38CpG-HazardScore)
    • Provides binary risk stratification (38CpG-AMLsignature: High/Low)
    • Non-AML/MDS samples receive "NaN" values

Citation

If you use this package in your research, please cite:

Francisco Marchi, Marieke Landwehr, Ann-Kathrin Schade et al. Long-read epigenomic diagnosis and prognosis of Acute Myeloid Leukemia, 12 December 2024, PREPRINT (Version 1) available at Research Square [https://doi.org/10.21203/rs.3.rs-5450972/v1]

License

See license file.

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

alma_classifier-0.1.3.tar.gz (11.4 MB view details)

Uploaded Source

Built Distribution

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

alma_classifier-0.1.3-py3-none-any.whl (10.5 MB view details)

Uploaded Python 3

File details

Details for the file alma_classifier-0.1.3.tar.gz.

File metadata

  • Download URL: alma_classifier-0.1.3.tar.gz
  • Upload date:
  • Size: 11.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for alma_classifier-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a9e26ea7323e1a8e57b87bca4cec3cbb50a01ac5c57e35499ecf636edb295b37
MD5 a5f42961e3ef399903c29b89d617f7fd
BLAKE2b-256 65a7a0f7adf40a015ee1de82cbb04ebba69e87c119a221559f39ead788b1cb96

See more details on using hashes here.

File details

Details for the file alma_classifier-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for alma_classifier-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e6c63bc8ab21b95c04df9b008e99c137e394ea758178189aa315d1909bd020da
MD5 5462612aac483ee3e155960eb9665888
BLAKE2b-256 85fc3ba53b4fb7552f56cfa036b7952511b17d10cf481d939baeef685cba660e

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