自动呈现来自Chanjo Out的覆盖率报告
chanjo-report的Python项目详细描述
啊![示例报告(eng)](artwork/screenshot.png)
#禅宗报告[![Pypi版本][Fury图片]][Fury网址][![生成状态][Travis图像][Travis URL] 从Chanjo SQL数据库自动生成基本覆盖率报告。此插件作为子命令(“report”)安装到chanjo命令行界面。
##用法 chanjo报告支持多种输出格式:表格、pdf和html。要打印一组“WGS准备”样本的PDF覆盖率报告,请执行以下操作:
`bash $ chanjo report --render pdf --group"WGS-prep" > ./coverage-report.pdf `
##功能
###支持的输出格式 chanjo报告多种输出格式:
- tabular: easily parsable and pipeable
- PDF: easily distributable (for humans)
- HTML: easily deliverable on the web
###支持的语言(翻译) 覆盖率报告(HTML/PDF)可以呈现以下语言:
- English
- Swedish
##动机 我们正在使用来自临床基因组学的chanjo的输出来报告基于覆盖率的外显子组测序的成功。我们的客户,主要是临床医生,特别感兴趣的是知道他们感兴趣的基因在多大程度上被测序以及一些直观的总体覆盖指标所覆盖。他们希望pdf格式的输出在他们的系统中归档。
作为发现最容易将html转换为pdf的副作用,chanjo report有一个内置的flask服务器,可用于动态呈现报表,甚至作为蓝图插入其他flask服务器。
###安装 chanjo报告通过pip分发。运行以下命令安装最新版本:
`bash $ pip install chanjo-report `
…或本地开发:
`bash $ git clone https://github.com/robinandeer/chanjo-report.git $ cd chanjo-report $ pip install --editable . `
>;请注意,我最终将提供一个完全配置的流浪环境,以简化开发设置:smiley:
##许可证 麻省理工学院。有关详细信息,请参阅[许可证](许可证)文件。
##贡献 任何人都可以帮助使这个项目更好-阅读[贡献](contribution.md)开始!
[愤怒的URL]:http://badge.fury.io/py/chanjo-report [愤怒的图像]:https://badge.fury.io/py/chanjo-report.png
[travis url]:https://travis-ci.org/robinandeer/chanjo-report [特拉维斯图像]:https://img.shields.io/travis/robinandeer/chanjo-report.svg?style=flat