Metadata-Version: 2.1
Name: dppa
Version: 0.1.0
Summary: Deep Protein Polarity Analyser
Home-page: https://github.com/janjusti/dppa
Author: Jan Justi
Author-email: jan.ma.justi@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: tqdm (==4.31.1)
Requires-Dist: anytree (==2.6.0)
Requires-Dist: pandas (==0.24.2)
Requires-Dist: numpy (==1.16.3)
Requires-Dist: biopython (==1.73)
Requires-Dist: openpyxl (==2.6.2)
Requires-Dist: styleframe (==2.0.3)

DPPA (Deep Protein Polarity Analyser)
=====================================

Installation
------------
```bash
pip install dppa --user
```

Usage
-----
CLI:

```bash
usage: run-dppa [-h] [--reportName REPORTNAME] [--debug] TARGET REPORTTYPE

Analyse all protein alignment .fasta files from a target.

positional arguments:
  TARGET                Target .fasta file to be analysed.
  REPORTTYPE            Output report file type.

optional arguments:
  -h, --help            show this help message and exit
  --reportName REPORTNAME
                        Output report file name.
  --debug               Turn debug messages on.
```

Python:

```python
import dppa.core as pol_solver

target_name = 'example.fasta'
report_name = 'dppa-report'
report_type = 'xls'

pol_solver.set_debug_mode(True) # optional

# results[0] -> polarity results dataframe
# results[1] -> alerts dataframe
results = pol_solver.run(target_name)

pol_solver.export(report_name, report_type, results)
```

