Skip to main content

Python package for processing Infinum DNA methylation arrays

Project description

Mepylome Logo

PyPI version License: MIT PyPI - Python Version Documentation Status Open in Colab


Mepylome: Methylation Array Analysis Toolkit

Mepylome is an efficient Python toolkit tailored for parsing, processing, and analyzing methylation array IDAT files. Serving as a versatile library, Mepylome supports a wide range of methylation analysis tasks. It also includes an interactive GUI that enables users to generate UMAP plots and CNV plots (Copy Number Variation) directly from collections of IDAT files.

Features

  • Parsing of IDAT files
  • Extraction of methylation signals
  • Calculation of Copy Number Variations (CNV) with visualization using plotly.
  • Support for the following Illumina array types: 450k, EPIC, EPICv2, MSA48
  • Significantly faster compared to minfi and conumee2.
  • Methylation analysis tool with a graphical browser interface for UMAP analysis, CNV plots and supervised classification
    • Can be run from the command line with minimal setup or customized through a Python script
  • CN-summary plots

Documentation

The mepylome documentation, including installation instructions, tutorial and API, is available at https://mepylome.readthedocs.io/

Usage

Methylation extraction and copy number variation plots

from pathlib import Path

from mepylome import CNV, MethylData

# Sample
analysis_dir = Path("/path/to/idat/directory")
sample_file = analysis_dir / "200925700125_R07C01"

# CNV neutral reference files
reference_dir = Path("/path/to/reference/directory")

# Get methylation data
sample_methyl = MethylData(file=sample_file)
reference_methyl = MethylData(file=reference_dir)

# Beta value
betas = sample_methyl.betas

# Print overview of processed data
print(sample_methyl)

# CNV anylsis
cnv = CNV.set_all(sample_methyl, reference_methyl)

# Visualize CNV in the browser
cnv.plot()

Methylation analysis: Command-line interface and GUI

Mepylome Logo

Basic usage:

Mepylome provides a command-line interface for launching a GUI and performing methylation analysis. Ensure you have an analysis directory, a CNV reference directory, and an annotation file (located within the analysis directory). Use the following command to initiate the analysis:

mepylome --analysis_dir /path/to/idats --reference_dir /path/to/ref

If you want to perform a quick test, use:

mepylome --tutorial

This command downloads sample IDAT files and provides a demonstration of the package's functionality.

You can try the tutorial directly in Google Colab-without downloading or installing anything-by clicking the link below. Please note that GUI support is limited in Colab.

Open in Colab

See https://mepylome.readthedocs.io/ for details.

C++ parser

Mepylome also includes a C++ parser. See https://mepylome.readthedocs.io/ for details.

Contributing

Contributions are welcome! If you have any bug reports, feature requests, or suggestions, please open an issue or submit a pull request.

License

This project is licensed under the MIT license.

Acknowledgements

Mepylome is strongly influenced by minfi and conumee2. Some functionalities, such as the manifest handler and parser, are adapted from methylprep.

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

mepylome-0.9.1.tar.gz (922.6 kB view details)

Uploaded Source

Built Distribution

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

mepylome-0.9.1-py3-none-any.whl (948.0 kB view details)

Uploaded Python 3

File details

Details for the file mepylome-0.9.1.tar.gz.

File metadata

  • Download URL: mepylome-0.9.1.tar.gz
  • Upload date:
  • Size: 922.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for mepylome-0.9.1.tar.gz
Algorithm Hash digest
SHA256 adb90cd972612a54cedbd82fcf091bdf97221fb1a5a485cd0f226bde0f98daf6
MD5 73ad4ee5affca9a3fc0540a852852725
BLAKE2b-256 1a6b68c0c35c1247faee3558a9463c67ab01881a9ef2fea396a9b733dad3eb40

See more details on using hashes here.

File details

Details for the file mepylome-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: mepylome-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 948.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for mepylome-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c424548c6f17391b26e6bcaf24139c4d04f6ef1ea199759e72f8362d555d0fb6
MD5 a1297d8444ec883e1994b31bf69237b2
BLAKE2b-256 7c426f1d0909ec4768155123ba75e0705e896f5a43c926312db9193020dc4b10

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