MToolBox的变量注释器。
mtoolnote的Python项目详细描述
mtoolnote
MToolBox的变量注释器。在
- 免费软件:麻省理工学院许可证
- GitHub回购:https://github.com/mitoNGS/mtoolnote
特点
mtoolnote可以从以下方面注释线粒体变体:
用法
安装后,mtoolnote提供了一个CLI命令和一个Python函数来注释人类和非人类的VCF文件。在
人类线粒体变体注释
使用CLI:
$ mtoolnote INPUT_VCF OUTPUT_VCF
其中INPUT_VCF和OUTPUT_VCF表示文件路径。除了VCF输出之外,使用--csv标志选项创建一个带注释的CSV文件。在
使用Python模块:
^{pr2}$除了VCF输出之外,使用csv=True选项创建带注释的CSV文件。在
非人类线粒体变体注释
使用CLI:
$ mtoolnote INPUT_VCF OUTPUT_VCF SPECIES
其中SPECIES表示样本物种,oaries,ptroglodytes,scerevisiae之一, ecaballus,fcatus,cfamiliaris,pabelii,ggallus,mmulatta, rnorvegicus,btaurus,oanatinus,sscrofa,nleucogenys,chircus, ^{tt21},{tt21},{tt22},{tt22}。除了VCF输出之外,使用--csv标志选项创建一个带注释的CSV文件。在
使用Python模块:
import mtoolnote mtoolnote.annotate("input.vcf", "output_vcf", "species")
{$vc4}附加一个带注释的CSV}选项。在
安装
克隆此存储库后,cd,并使用以下方法安装mtoolnote:
$ python setup.py install # in case this does not work: $ pip install -r requirements.txt $ pip install .
或在开发模式下:
$ pip install -r requirements_dev.txt $ pip install -e .
测试
安装后,使用以下各项运行所有测试:
$ pytest
或完整的套件(使用python3.6、python3.7、flake8进行测试)和:
$ tox
学分
此包是用Cookiecutter和cc-pypackage项目模板创建的。在
历史
0.1.0(2019-08-27)
- 第一个开发版本。在
0.1.1(2019-09-02)
- 添加从带注释的vcf文件创建csv的选项。在
0.1.2(2019-09-17)
- 确定需求
- 重新定位本地数据库以进行人工注释。在
0.1.3(2019-09-25)
- 为非人工注释添加多线程处理(修复1)。在
0.1.4(2019-11-30)
- 将单倍型特异等位基因频率添加到最终注释中(fix#4)
- 将外部预测器添加到最终注释(修复5)。在
0.1.5(2020-02-09)
- 将基因座名称添加到基本信息中,即使是未注释的人类变体(fix#14)
- 更新需求(修复17)
- 重组代码。在
0.1.6(2020-03-04)
- 使用轨迹表提供基本轨迹注释(fix#22)。在
0.1.7(2020-04-04)
- 使用FuncLocals表添加功能轨迹注释(fix#24)。在
0.2.0(2020-04-08)
- 添加选项以选择要包含在人工数据中的特定注释(fix#28)。在
- 项目
标签: