Skip to main content

Python package for processing Infinum DNA methylation arrays

Project description

Mepylome Logo

PyPI version License: GPL v3 PyPI - Python Version Documentation Status


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
  • 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.

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 GPL-3.0 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.4.5.tar.gz (856.6 kB view details)

Uploaded Source

Built Distribution

mepylome-0.4.5-py3-none-any.whl (859.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mepylome-0.4.5.tar.gz
  • Upload date:
  • Size: 856.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mepylome-0.4.5.tar.gz
Algorithm Hash digest
SHA256 6b70d8a1d1dca3561c175eaeb257e6dab0de7eac2e02bb09ab9304cef29f9637
MD5 b57ce01bf8edaa732e3c7d7a60e83949
BLAKE2b-256 04105151de301993384efa9d101269d3dbae13eac5500c2fab4ae2abe838d64e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mepylome-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 859.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mepylome-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 163bb819425304919a0847c7e427eb865b9e2f4b0812bc32b7bc26055378c31d
MD5 24f026daf15c4585bbf9eeb9d45257f4
BLAKE2b-256 7413377bc09dac1ec2a83446e2e8519b1f037a18611233c333e57d0bb2fa94ec

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page