Metadata-Version: 2.1
Name: CtrlF_TF
Version: 1.0b4
Summary: Protein-DNA binding site caller from kmer data
Author: Zachery Mielko
License: BSD 3-Clause License
Keywords: Bioinformatics,Scientific Computing
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: License :: OSI Approved
Classifier: Intended Audience :: Science/Research
Requires-Python: >3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# CtrlF-TF

CtrlF-TF is a python library and command line tool that calls transcription factor binding sites in DNA sequences. It does this by compiling high-throughput k-mer data into ranked aligned sequences containing binding sites. These sequences are then searched in a given string (ctrl-f) for matches.

This program has not yet completed peer-review and is currently designated as a beta version, with a 1.0 release afterwards.

### Installation

CtrlF-TF can be installed from pypi with the following command:

`pip install CtrlF-TF`

This installs the `ctrlf_tf` python module and the `ctrlf` command line tool. The package is compatible with Linux and macOS. It has not been tested on Windows.

### Documentation

The CtrlF-TF documentation can be found here: https://zmielko.github.io/CtrlF-TF
