用于搜索基因组变异的web用户界面
puzzle的Python项目详细描述
#拼图[![生成状态][特拉维斯图像][特拉维斯URL][![测试覆盖范围][工作服img]][工作服url]
文档请访问www.robinandeer.com/puzzle/
变异呼叫者图形用户界面和遗传病分析工具。
`bash $ 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 `
##使用拼图 拼图将寻找各种调用资源,如vcf文件和[gemini][gemini]数据库,并可视化其内容。它允许您检查、注释和分析变量调用。
拼图主要不是作为一个持久服务器运行,而是作为一个webinterface来快速旋转以可视化您的变量调用。
我们开始制作拼图,既简单又直观。您可以在几分钟内启动并运行,只需满足最低的先决条件。
##发展之谜 puzzle是一个带有命令行界面的python flask应用程序。它可以使用插件处理多个后端:原始vcf、gemini、mongodb。
任何人都可以帮助使这个项目更好-阅读[贡献](contribution.md)开始!
###安装用于开发 我决定在这个项目中试用[otto][otto],所以一定要安装:smile:
`bash $ 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 `
##测试拼图 要运行测试,需要在系统中安装[Pytest](Pytest)。您可以一起安装pytest 与其他开发库一起运行pip install-r requirements-dev.txt。
您还需要下载用于测试的数据库,可以通过执行以下命令来完成此操作:
` wget https://s3-us-west-2.amazonaws.com/robinandeer/HapMapFew.db-O tests/fixtures/HapMapFew.db `
要使用结构变体测试gemini数据库,请执行以下操作:
` wget https://s3-us-west-2.amazonaws.com/robinandeer/HapMapSv.db-O tests/fixtures/HapMapSv.db `
然后,运行py.test tests/
##使用双子座数据库
确保在本地环境中安装了gemini
` puzzle view path/to/gemini_database.db `
##使用PED信息
puzzle使用ped文件在family view和variant calls中显示更多信息:
` puzzle view tests/fixtures/hapmap.vcf --family_file/-f tests/fixtures/hapmap.ped `
##建立持久的本地数据库
拼图可以建立一个持久的本地数据库,因此您可以在会话之间保持工作。 这可以实现其他关键特性,例如用于筛选和变异分类的基因列表。 首先,需要初始化本地数据库。然后可以加载一个或多个案例 一旦启动web服务器就可以查看。
` puzzle init --root tests/fixtures puzzle load --root tests/fixtures tests/fixtures/hapmap.vcf puzzle view --root tests/fixtures `
##结构变量可视化
拼图也可以通过使用带有“-load”或“-view”的“-variant type sv”来可视化结构变体。 享受存储在双子座或VCF格式的SVS列表视图。默认情况下,会启用染色体带和大小等关键字段。
如果下载了带有sv:s的gemini数据库,如上所述,请执行:
` puzzle view tests/fixtures/HapMapSv.db `
使用sv:s:
查看示例文件` puzzle view tests/fixtures/hapmap.sv.vep.vcf.gz `
##生成文档 文档是使用[gitbook][gitbook]生成的。在本地生成文档需要gitbook cli。
`bash $ cd puzzle/ $ npm install -ggitbook-cli $ gitbook serve ./docs `
现在可以在http://localhost:4000/上查看文档。
##学分 名词项目创意摊位拼图
##许可证 麻省理工学院。有关详细信息,请参阅[许可证](许可证)文件。
[travis url]:https://travis-ci.org/robinandeer/puzzle?branch=master [特拉维斯图像]:https://img.shields.io/travis/robinandeer/puzzle/master.svg?style=flat-square [工作服URL]:https://coveralls.io/github/robinandeer/puzzle [工作服img]:https://img.shields.io/coveralls/robinandeer/puzzle.svg?style=flat-square [奥托]:https://ottoproject.io/ [双子座]:https://github.com/arq5x/gemini [pytest]:http://pytest.org/latest/ [Gitbook]:https://www.gitbook.com/