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
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.
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!
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
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/
Make sure you have gemini installed in your local environment
puzzle --mode gemini view -i path/to/gemini_database.db
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
Puzzle Piece by Creative Stall from the Noun Project
MIT. See the LICENSE file for more details.