<img alt="Mepylome Logo" src="https://raw.githubusercontent.com/brj0/mepylome/main/mepylome/data/assets/mepylome.svg" width="300">
[](https://badge.fury.io/py/mepylome)
[](https://opensource.org/licenses/GPL-3.0)
[](https://mepylome.readthedocs.io/en/latest/?badge=latest)
-----------------
# 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](https://github.com/plotly/plotly.py).
- Support for the following Illumina array types: 450k, EPIC, EPICv2
- Significantly faster compared to [minfi](https://github.com/hansenlab/minfi)
and [conumee2](https://github.com/hovestadtlab/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
```python
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
<img alt="Mepylome Logo" src="https://raw.githubusercontent.com/brj0/mepylome/main/docs/images/screenshot.png">
#### 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:
```sh
mepylome --analysis_dir /path/to/idats --reference_dir /path/to/ref
```
If you want to perform a **quick test**, use:
```sh
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](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](https://github.com/FoxoTech/methylprep).
Raw data
{
"_id": null,
"home_page": "https://github.com/brj0/mepylome",
"name": "mepylome",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Illumina, Methylation, Infinum, Microarray, BeadChip",
"author": "Jon Brugger",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/00/20/f14e00ff0fb6bd2662bb41570f22abb0a9246e435e132714e7f2e6864d29/mepylome-0.7.3.tar.gz",
"platform": null,
"description": "<img alt=\"Mepylome Logo\" src=\"https://raw.githubusercontent.com/brj0/mepylome/main/mepylome/data/assets/mepylome.svg\" width=\"300\">\n\n\n[](https://badge.fury.io/py/mepylome)\n[](https://opensource.org/licenses/GPL-3.0)\n\n[](https://mepylome.readthedocs.io/en/latest/?badge=latest)\n\n-----------------\n\n\n# Mepylome: Methylation Array Analysis Toolkit\n\nMepylome is an efficient Python toolkit tailored for parsing, processing, and\nanalyzing methylation array IDAT files. Serving as a versatile library,\nMepylome supports a wide range of methylation analysis tasks. It also includes\nan interactive GUI that enables users to generate UMAP plots and CNV plots\n(Copy Number Variation) directly from collections of IDAT files.\n\n\n## Features\n\n- Parsing of IDAT files\n- Extraction of methylation signals\n- Calculation of Copy Number Variations (CNV) with visualization using\n [plotly](https://github.com/plotly/plotly.py).\n- Support for the following Illumina array types: 450k, EPIC, EPICv2\n- Significantly faster compared to [minfi](https://github.com/hansenlab/minfi)\n and [conumee2](https://github.com/hovestadtlab/conumee2).\n- Methylation analysis tool with a graphical browser interface for UMAP\n analysis, CNV plots and supervised classification\n - Can be run from the command line with minimal setup or customized through a\n Python script\n- CN-summary plots\n\n\n## Documentation\n\nThe mepylome documentation, including installation instructions, tutorial and API, is available at <https://mepylome.readthedocs.io/>\n\n\n## Usage\n\n### Methylation extraction and copy number variation plots\n\n```python\nfrom pathlib import Path\n\nfrom mepylome import CNV, MethylData\n\n# Sample\nanalysis_dir = Path(\"/path/to/idat/directory\")\nsample_file = analysis_dir / \"200925700125_R07C01\"\n\n# CNV neutral reference files\nreference_dir = Path(\"/path/to/reference/directory\")\n\n# Get methylation data\nsample_methyl = MethylData(file=sample_file)\nreference_methyl = MethylData(file=reference_dir)\n\n# Beta value\nbetas = sample_methyl.betas\n\n# Print overview of processed data\nprint(sample_methyl)\n\n# CNV anylsis\ncnv = CNV.set_all(sample_methyl, reference_methyl)\n\n# Visualize CNV in the browser\ncnv.plot()\n```\n\n### Methylation analysis: Command-line interface and GUI\n\n<img alt=\"Mepylome Logo\" src=\"https://raw.githubusercontent.com/brj0/mepylome/main/docs/images/screenshot.png\">\n\n#### Basic usage:\n\nMepylome provides a command-line interface for launching a GUI and performing\nmethylation analysis. Ensure you have an analysis directory, a CNV reference\ndirectory, and an annotation file (located within the analysis directory). Use\nthe following command to initiate the analysis:\n\n```sh\nmepylome --analysis_dir /path/to/idats --reference_dir /path/to/ref\n```\n\nIf you want to perform a **quick test**, use:\n\n```sh\nmepylome --tutorial\n```\n\nThis command downloads sample IDAT files and provides a demonstration of the\npackage's functionality.\n\nSee <https://mepylome.readthedocs.io/> for details.\n\n\n## C++ parser\n\nMepylome also includes a C++ parser. See <https://mepylome.readthedocs.io/> for\ndetails.\n\n\n## Contributing\n\nContributions are welcome! If you have any bug reports, feature requests, or suggestions, please open an issue or submit a pull request.\n\n\n## License\n\nThis project is licensed under the [GPL-3.0 license](LICENSE).\n\n\n## Acknowledgements\n\nMepylome 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](https://github.com/FoxoTech/methylprep).\n",
"bugtrack_url": null,
"license": "GPL-3.0 license",
"summary": "Python package for processing Infinum DNA methylation arrays",
"version": "0.7.3",
"project_urls": {
"Homepage": "https://github.com/brj0/mepylome"
},
"split_keywords": [
"illumina",
" methylation",
" infinum",
" microarray",
" beadchip"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2883815665b7e18056f2fe8e4b7b94ffc1b96ae2c3a665d2297543a74ce95623",
"md5": "54bc951db645132bd168dbf3fc6b7925",
"sha256": "83b124ae72c53b0917b34f2052b6e67f3e8360180bd26146b7d9117d6e0a1556"
},
"downloads": -1,
"filename": "mepylome-0.7.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54bc951db645132bd168dbf3fc6b7925",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 868901,
"upload_time": "2024-12-21T16:30:15",
"upload_time_iso_8601": "2024-12-21T16:30:15.826071Z",
"url": "https://files.pythonhosted.org/packages/28/83/815665b7e18056f2fe8e4b7b94ffc1b96ae2c3a665d2297543a74ce95623/mepylome-0.7.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0020f14e00ff0fb6bd2662bb41570f22abb0a9246e435e132714e7f2e6864d29",
"md5": "c8fa22a90c85c93958ebc37f14d2ff13",
"sha256": "f1db692ae181cac6f961d4a0f30e24d6902e4aeea97d82fc402ac2ce18325657"
},
"downloads": -1,
"filename": "mepylome-0.7.3.tar.gz",
"has_sig": false,
"md5_digest": "c8fa22a90c85c93958ebc37f14d2ff13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 864317,
"upload_time": "2024-12-21T16:30:21",
"upload_time_iso_8601": "2024-12-21T16:30:21.339086Z",
"url": "https://files.pythonhosted.org/packages/00/20/f14e00ff0fb6bd2662bb41570f22abb0a9246e435e132714e7f2e6864d29/mepylome-0.7.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 16:30:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brj0",
"github_project": "mepylome",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mepylome"
}
JSON
