Metadata-Version: 2.4
Name: brisktyper
Version: 0.1.8
Summary: Genome pre-processing pipeline for BRisk
Home-page: https://github.com/lmc297/brisktyper
Author: Laura M. Carroll
Author-email: lmc297@cornell.edu
License: GPL-3.0-only
Project-URL: Bug Tracker, https://github.com/lmc297/brisktyper/issues
Project-URL: Publication, https://www.sciencedirect.com/science/article/pii/S0022030224008968
Project-URL: Changelog, https://github.com/lmc297/brisktyper/blob/master/archive/CHANGELOG.md
Keywords: bacillus,risk assessment,genome
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.18
Requires-Dist: biopython>=1.74
Requires-Dist: pandas>=1.0
Requires-Dist: pyfastani>=0.3
Dynamic: license-file

# BRiskTyper
Genome pre-processing pipeline for BRisk

## Overview

BRiskTyper is a genomic pre-processing pipeline for BRisk.

Post issues at https://github.com/lmc297/BRiskTyper/issues.

------------------------------------------------------------------------

## Installation

XXX Stay tuned! XXX To add XXX

------------------------------------------------------------------------

## Citation

### If you found the BRiskTyper tool, its source code, and/or any of its associated databases useful, please cite:

> XXX

------------------------------------------------------------------------


## Quick Start

### Command Structure

```
brisktyper -i [fasta] -o [output directory] [options...]
```

For help, type `brisktyper -h` or `brisktyper --help`

For your current version, type `brisktyper --version`

------------------------------------------------------------------------

Disclaimer: BRiskTyper is pretty neat! However, no tool is perfect, and BRiskTyper cannot definitively prove whether an isolate is pathogenic or not. As always, interpret your results with caution. We are not responsible for taxonomic misclassifications, misclassifications of an isolate's pathogenic potential or industrial utility, and/or misinterpretations (biological, statistical, or otherwise) of BRiskTyper results.
