Metadata-Version: 2.1
Name: chipseqpeaks
Version: 0.0.9
Summary: Easy management of ChIP-seq peak calling
Home-page: https://github.com/anthony-aylward/chipseqpeaks.git
Author: Anthony Aylward, Joshua Chiou
Author-email: aaylward@eng.ucsd.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# chipseqpeaks

Easy management of ChIP-seq peak calling data

A mini-module for managing ChIP-seq peak calling data. The language of this
module treats "ChIP-seq peaks" as an abstraction, but mostly handles them as 
MACS2 output stored in memory.

```
Example
-------
import chipseqpeaks
with chipseqpeaks.ChIPSeqPeaks(<bytes object or path to BAM file>) as cp:
    cp.cleans_up = False
    cp.remove_blacklisted_peaks(<path/to/blacklist.bed>)
    cp.write(<output prefix>)

Classes
-------
ChIPSeqPeaks
    object representing ChIP-seq peaks

Functions
---------
parse_input
    check that an input is str or bytes and return the bam file as a bytes
    object
```

