Git Product home page Git Product logo

puzzle's Introduction

Puzzle Build Status Test Coverage

Variant Caller GUI and genetic disease analysis tool.

$ git clone https://github.com/robinandeer/puzzle.git
$ cd puzzle
$ pip install --editable .
$ puzzle view tests/fixtures/
# open webbrowser on port 5000
$ open http://localhost:5000

Using Puzzle

Puzzle will look for variant calling resources such as VCF files and GEMINI databases and visualize their content. It lets you inspect, annotate, and analyze variant calls.

Puzzle is not primarily meant to be run as a persistant server but think of it more as an webinterface to quickly spin to visualize your variant calls.

We set out to make Puzzle both very simple to install as well as intuitive to use. You can be up and running in minutes with minimal prerequisites.

Developing Puzzle

Puzzle is a Python Flask app with a command line interface. It can work with multiple backends using plugins; raw VCFs, GEMINI, MongoDB.

Anyone can help make this project better - read CONTRIBUTING to get started!

Install for development

I decided to try out Otto for this project so make sure you have it installed ๐Ÿ˜„

$ git clone https://github.com/robinandeer/puzzle.git
$ cd puzzle
$ otto dev
$ otto dev ssh
> npm install
> sudo apt-get install vim python-pip git
> pip install --user --editable .
> puzzle /vagrant/tests/
# open webbrowser on port 5000

Testing Puzzle

To run the tests, you need pytest installed in your system. You can install pytest together with the other development libraries by running pip install -r requirements-dev.txt.

You will also need to download the database used for testing, which you can do by executing this command:

wget https://s3-us-west-2.amazonaws.com/robinandeer/HapMapFew.db -O tests/fixtures/HapMapFew.db

Then, just run py.test tests/

Use a gemini database

Make sure you have gemini installed in your local environment

puzzle --mode gemini view -i path/to/gemini_database.db

Use ped info

Puzzle uses the ped file to show more information in family view and in variant calls:

puzzle view -i tests/fixtures/hapmap.vcf --family_file/-f tests/fixtures/hapmap.vcf

Credits

Puzzle Piece by Creative Stall from the Noun Project

License

MIT. See the LICENSE file for more details.

puzzle's People

Contributors

dnil avatar guillermo-carrasco avatar henrikstranneheim avatar j35p312 avatar moonso avatar robinandeer avatar vasiliosz avatar

Watchers

 avatar  avatar

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.