Metadata-Version: 2.1
Name: gRNAsearch
Version: 0.0.1
Summary: Search for guide RNA sites in PCR tags
Home-page: https://github.com/rhong3/gRNAsearch
Author: Runyu Hong
Author-email: Runyu.Hong@nyu.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Requires-Dist: biopython (>=1.76)
Requires-Dist: numpy (>=1.17.5)
Requires-Dist: pandas (>=0.23)

# **Search for guide RNA sites in PCR tags**
### Usage
 - Install the package version through pip `pip install gRNAsearch `
 - `from gRNAsearch.search import search`
 - `summary, frames = search(syn="../seq.fa", tag="../tag.csv", save=True, output_dir="~", output_name="gRNA")`
### Parameters 
`search(syn, tag, save=True, output_dir='~', output_name="gRNA"):`
 - syn: full path to sequence file in '.fa' format
 - tag: PCR tag file
 - save: save the outputs in csv (default=True)
 - output_dir: output directory (full path) to save the files (default='~')
 - output_name: name of the output file (default="gRNA")
### Outputs
 - summary: the search results data frame
 - frames: the intermediate data frame with WT sequences


