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 and CNV plots
    • Can be run from the command line with minimal setup or customized through a Python script

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.2.1.tar.gz (841.7 kB view details)

Uploaded Source

Built Distribution

mepylome-0.2.1-py3-none-any.whl (846.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mepylome-0.2.1.tar.gz
  • Upload date:
  • Size: 841.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for mepylome-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ba9161f1780d56265825f5e913d0535e2c1d0d1760eb14f224e6100ae6a65792
MD5 49466860ee35f9f479ef33592e62b712
BLAKE2b-256 df1213522d0677ee6d0c181d46851e5a782a449c5e0155a26d83784b8dd5dcd4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mepylome-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 846.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for mepylome-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 934a3e3d3bea609dbcb5c46f7bf5d796b6a493c3e9297c644adee4f1ec421681
MD5 f3ca8722c2fb72efdc40dd024906e994
BLAKE2b-256 697c097eb296d90a6cba2ebe02e38f54759a17a01abcf723eb8bb80f730c74c1

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