Metadata-Version: 2.1
Name: pool-sharq
Version: 0.0.12
Summary: pool-sharq: python interface for Broad Institute GPP's poolq software.
Home-page: https://github.com/mvinyard/pool-sharq
Author: Michael E. Vinyard - Harvard University - Massachussetts General Hospital - Broad Institute of MIT and Harvard
Author-email: mvinyard@broadinstitute.org
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >3.7.0
Description-Content-Type: text/markdown
License-File: LICENSE


[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pool-sharq.svg)](https://pypi.python.org/pypi/pool-sharq/)
[![PyPI version](https://badge.fury.io/py/pool-sharq.svg)](https://badge.fury.io/py/pool-sharq)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# pool-sharq
Python wrapper for the Broad Institute GPP's [poolq software](https://portals.broadinstitute.org/gpp/public/software/poolq)

Uses the [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/) webscraping library to check for the latest distribution of poolq from the Broad Institute's GPP. Downloads the latest distribution if it is not already downloaded.

### Install

```BASH
pip install pool_sharq
```

### Usage

```python
import pool_sharq

poolq = pool_sharq.poolq(dir="/path/to/data/") # contains rows.txt and columns.txt along with fastq files. 
poolq.run()
```

### You can also download / use test data provided by the GPP
```python
pool_sharq.download_test_data()
```

```python
poolq = pool_sharq.poolq() # point to test data
poolq.run()
```



