GithubHelp home page GithubHelp logo

kish's Introduction

kish (kmer fishing)

This is a simple Python package designed to allow kmers to be screened against a GenBank file, in this case H37Rv to see if they match.

If they do, the gemucator package is used to identify, if possible, the gene affected.

Installation and pre-requisites

Since gemucator is not in PyPi, you will need to install it as per the instructions in the README on its GitHub page.

The only other pre-requsite is BioPython, which if not present, should be installed automatically during the below process.

First, clone the repository

$ git clone https://github.com/philipwfowler/kish
$ cd kish/

Now install either as a simple static package

$ python setup.py install --user

or, as a link if you anticipate updating the package via git pull frequently (do this way if the package is being developed and changed rapidly)

$ python setup.py develop --user

Usage

Fairly simple, you give it a kmer and it tells you if it can find it

$ kish-run.py --kmer CGGGGTTGACCCACAAGCGCCGACTGTCGGC
CGGGGTTGACCCACAAGCGCCGACTGTCGGC exactly matches forward starting at genbank location 761127 encoding rpoB_S441

It also considers all single base variants using a regular expression

$ kish-run.py --kmer CGGGGTTGACCCACAAGCGCCGACTGTCCGC
CGGGGTTGACCCACAAGCGCCGACTGTCCGC matches forward (C->G at pos 28) starting at genbank location 761127 encoding rpoB_S441

If you want to restrict it to exact matches then

$ kish-run.py --kmer CGGGGTTGACCCACAAGCGCCGACTGTCCGC --exact
CGGGGTTGACCCACAAGCGCCGACTGTCCGC no matches found!

Future developments

  • allow a file containing a kmer-per-line to be specified to increase speed/ease of use
  • if a single base has been changed, work out what mutation in the reference genome that corresponds to
  • can we think about 2 base changes? Or will that be too slow.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.