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
  • 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.8.6.tar.gz (863.9 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.8.6-py3-none-any.whl (864.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mepylome-0.8.6.tar.gz
  • Upload date:
  • Size: 863.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for mepylome-0.8.6.tar.gz
Algorithm Hash digest
SHA256 25402cc17518bd5c100829ecdfb1300d7687fa647b463a9c64814dcd59fb2b73
MD5 61aa1692143a5fb82609be15fc67276a
BLAKE2b-256 a31eb369894e00f1424731132474afcc57a376b9e3ec2698cd83f417419ba885

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mepylome-0.8.6-py3-none-any.whl
  • Upload date:
  • Size: 864.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10

File hashes

Hashes for mepylome-0.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a077c74db2a35dc88c3972af8f709fed660bf589404d3c45d5663f238fa8f74c
MD5 e45c328c066bc0fe2ac8a5b0a0b9f039
BLAKE2b-256 ca603ef0176db145a026edcad8cb626d3ac2d29162f2421fab9f9e42d67afb38

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