Skip to content

A hybrid gene content and k-mer feature viral metagenomic contig identifier

License

Notifications You must be signed in to change notification settings

Strong-Lab/Phybrid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues


Logo

A viral identification tool using machine learning with nucleotide and protein features
Report Bug · Request Feature

Table of Contents
  1. About Phybrid
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About Phybrid

This project was created to identify viral contigs in metagenomics. This project combines the use of gene content features and k-mer features to select viral contiguous sequences.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Phybrid requires Python 3 and the following libraries (if installling through pip, libraries are automatically install)

  • pandas
  • scikit-learn
  • biopython

Installation

Phybrid can only be forked from this repository. Once forked, enter into the files and compile the kmer counting program.

## git download here

cd Phybrid/scripts
tar xvf kmer-counter-master.zip
cd kmer-counter-master
make

Usage

Phybrid works as a python script. Once install via pip, Phybrid the command can be accessed. To get the help screen type:

cd Phybrid
scripts/Phybrid.py -h

The paramters of Phybrid are:

  • -i: Input Fasta [required]
  • -o: Output Directory [optional]

Running Phybrid

Phybrid without a sequencing file and renaming the output

cd Phybrid
scripts/Phybrid.py -i data/Test/Viral_contigs.fasta -o data/Test/Output

Roadmap

Current Version: 0.0.1

Improvements to be made:

  • Reduce feature space to allow for smaller file processing
  • Grid search hyper parameters for models
  • Build into python package

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Cody Glickman - @glickman_Cody - [email protected]

Project Link: https://github.com/Strong-Lab/Phybrid

Acknowledgements

  • James Costello
  • Michael Strong
  • Jo Hendrix

About

A hybrid gene content and k-mer feature viral metagenomic contig identifier

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published