Code Monkey home page Code Monkey logo

frameshift-finder's Introduction

Frameshift-Finder

A Django app to identify frame shift loci in bacteriophage genomes

Python Version

2.7.11

Django Version

1.10.3

App Name

fsfinder

For info on django's architechture please see this django tutorial.

To run the app on your local machine, you will need to create a django project to contain the app: (this repository currently only holds the app file tree, not an entire project). In your console, navigate to the directory you would like to work in and run $ django-admin startproject [arbitrary project name]. Next, build the app directory. Move into the project directory -- $ cd [arbitrary project name] and execute $ python manage.py startapp fsfinder. This will create the fsfinder directory within your django project. You can then fork this directory (click the fork button in the top right corner of this page) and clone the repository into your fsfinder directory. To do this, make sure you are in your fsfinder directory. Now navigate to your fork of this repository (there should be a link on the right hand side of your github homepage) and click the clone or download button in the top right corner. This will diplay a url, copy this url and paste it into the command $ git clone [your clone link] within your console (i.e. if we were to clone the original repo, it would look like $ git clone https://github.com/jcpiper/Frameshift-Finder.git). That's it! You should be good to go after executing these commands.

Run app locally with python manage.py runserver from command line. Note, you must execute this command while in the django project directory (the parent directory of fsfinder). You cannot execute this command from the fsfinder directory. Then, you can navigate to localhost:8000/fsfinder to view the app in your browser.

frameshift-finder's People

Contributors

jcpiper avatar ryj4 avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar Jim Zheng avatar  avatar

frameshift-finder's Issues

Decide how to implement DFA

Would it be best to just dedicate a class to it within the views file? Or build it in another python file? A google search into how to implement data structures in a django app will hopefully provide some insight.

Glimmer...

The algorithm is functional, but right now it checks all potential overlapping ORFs for a slippery sequence.
We need to incorporate Glimmer and only run the sequence check functions against the glimmer output.
Also, now that I think about it the frameshift check should only return an shift if there is a start codon in the new frame within a threshold bp distance from from the slippery sequence. I'll check the paper for details on this and implement it. Just wanted to document it while I was thinking of it.

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.