Skip to main content

A Python package for applying pre-trained epigenomic classification models

Project description

ALMA Classifier

A Python package for epigenomic diagnosis and prognosis of acute myeloid leukemia.

Models

  1. ALMA Subtype: Classifies 28 subtypes (27 WHO 2022 acute leukemia subtypes + normal control)
  2. AML Epigenomic Risk: Predicts 5-year mortality probability for AML patients
  3. 38CpG AML Signature: Risk stratification using targeted 38 CpG panel

Installation

Docker (Recommended)

docker pull fmarchi/alma-classifier:0.1.4

pip

python -m venv .venv && source .venv/bin/activate
pip install pacmap==0.7.0
# MacOS users need `brew install lightgbm`
pip install alma-classifier
python -m alma_classifier.download_models

Usage

Docker

# Demo
docker run --rm -v $(pwd)/output:/output fmarchi/alma-classifier:0.1.4 --demo --output /output/demo_predictions.xlsx

# Your data
## Transfer your input data to ./data/
docker run --rm -v "$(pwd)/data":/data -v "$(pwd)/output":/output   fmarchi/alma-classifier:0.1.4 --input /data/your_file.pkl --output /output/your_results.xlsx

Command Line

alma-classifier --input data.pkl --output predictions.xlsx
alma-classifier --demo --output demo_results.csv
alma-classifier --input data.pkl --output results.xlsx --confidence 0.5

Input Formats

For Illumina Methylation450k or EPIC, prepare a .pkl dataset in python3.8 with the following structure:

  • Rows: Samples
  • Columns: CpG sites
  • Values: Beta values (0-1)

For nanopore WGS, follow the standard bedMethyl format with these key columns:

  • Column 1: chrom - Chromosome name
  • Column 2: start_position - 0-based start position
  • Column 4: modified_base_code - Single letter code for modified base
  • Column 11: fraction_modified - Percentage of methylation (0-100)

Output

Results include subtype classification, risk prediction, and confidence scores. Predictions below confidence threshold (default 0.5) are marked "Not confident".

Limitations

The diagnostic model does not recognize: AML with Down Syndrome, juvenile myelomonocytic leukemia, transient abnormal myelopoiesis, low-risk MDS, or lymphomas.

Citation

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]

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.4.tar.gz (16.9 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.4-py3-none-any.whl (17.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alma_classifier-0.1.4.tar.gz
  • Upload date:
  • Size: 16.9 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.4.tar.gz
Algorithm Hash digest
SHA256 2d3f7f8f40cf46cf2552bf668d7785da9a03798781127b219e433ce0b1b6c222
MD5 f8632455ba69a5d710bdf257a3af1100
BLAKE2b-256 2f14dc2c3dca2fc70793a78b4ef5873419cddbb316c20c11c556cc924426bb3d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for alma_classifier-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 abc7cf8deb4536cf0b9688fdebc5b62f89e020b8cc9a28a9363bad584653ad81
MD5 53578b0d3032bb70543fca9b21a6b738
BLAKE2b-256 10c22d2baafb9ed9e58b8052fca4ed3fc087a6cadc0f9c46217873fb36775b38

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