Metadata-Version: 2.0
Name: Meth5py
Version: 0.4.0
Summary: A class for converting BSMAPz methratio output into a fast and compressed hdf5 format
Home-page: https://github.com/zyndagj/Meth5py
Author: Greg Zynda
Author-email: zyndagj@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Requires: h5py
Requires: numpy
Description-Content-Type: text/markdown

Meth5py
==========

This will parse output from

* [BSMAP's](https://sites.google.com/a/brown.edu/bioinformatics-in-biomed/bsmap-for-methylation) methratio.py
* [BSMAPz's](https://github.com/zyndagj/BSMAPz) methratio.py

and make a sparse, compressed hdf5 representation for fast queries based on position.
Indexing is 1-based and follows the same conventions as samtools's faidx.

Installation
------------

Test the package

```
python setup.py test
```

then install it into the system package location

```
pip install .
```

or, your local path

```
pip install --user .
```

Usage
-------------

```python
from Meth5py import Meth5py
m5 = Meth5py('tests/test_meth.txt', 'tests/test.fa')
for record in m5.fetch('Chr1',10,11):
	print(record)
m5.close()
```

Documentation
-------------

Documentation can be found [here](Documentation.md)


