Python package for processing Infinum DNA methylation arrays
Project description
mepylome: Methylation Array Analysis Toolkit
Mepylome is a Python toolkit for parsing, processing, and analyzing methylation array IDAT files.
Note: Mepylome is still under construction.
Features
- Support for Illumina array types: 450k, EPIC, EPICv2
- Parsing of IDAT files
- Extraction of methylation signals
- Calculation of copy number variations (CNV) with Plotly plots visualization
- 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
Installation
From PyPI
You can install mepylome directly from PyPI using pip:
pip install mepylome
pip install mepylome[cgb]
Ensure you install the 'cgb' variant after (!) the regular package (cgb is used for CNV segmentation).
From Source
- Clone the repository:
git clone https://github.com/brj0/mepylome.git
cd mepylome
- Build and install the package:
pip install .
pip install .[cgb]
Usage
Parsing and methylation extraction
Refer to tests/basic_usage.py for a detailed example.
Methylation analysis: Command-line interface
Basic usage:
To start the interface, run the following command (you'll need to manually copy directories into the interface):
mepylome
Prefered usage:
For a more streamlined experience, specify the analysis IDAT files directory, reference IDAT directory, and CpG array type. This command also improves UMAP speed by saving betas to disk:
sh
mepylome -a /path/to/idats -r /path/to/ref -c 450k -s
Show All Parameters
To display all available command-line parameters, use:
mepylome --help
C++ parser
Mepylome also includes a C++ parser (_IdatParser
) with Python bindings. Due to no significant speed gain, it is currently not included by default. To enable it, install from source after you execute the following command:
export MEPYLOME_CPP=1
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] (https://github.com/hansenlab/minfi) and [conumee2] (https://github.com/hovestadtlab/conumee2). Some functionalities, such as the manifest handler and parser, are adapted from methylprep.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mepylome-0.0.0.tar.gz
.
File metadata
- Download URL: mepylome-0.0.0.tar.gz
- Upload date:
- Size: 825.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ab137085c4cd93e85b1b6ea7893c458829221cfafac21677f6447172df1664e |
|
MD5 | 962fa132053e8055b5b0736612435992 |
|
BLAKE2b-256 | 7dc4de36e598364975844e88c275380c73bbde3ccd4131b38ce1a01cbbd1b1aa |
Provenance
File details
Details for the file mepylome-0.0.0-py3-none-any.whl
.
File metadata
- Download URL: mepylome-0.0.0-py3-none-any.whl
- Upload date:
- Size: 829.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49b2b2db65a49ae41656a5063893f9afa72c074401e5e3c2286ccd9336c449b7 |
|
MD5 | 987c3198e4d454615e9706a0729e1347 |
|
BLAKE2b-256 | ce7ec6d48f732f2ef940b2b106273b86c5bfc8db7defd4f6761ef34dd8ac6732 |