人类线粒体变异的hmtvar注释。
hmtnote的Python项目详细描述
hmt注意
使用hmtvar注释人类线粒体变体。
- 自由软件：麻省理工学院许可证
- 文档：https://hmtnote.readthedocs.io rel="nofollow">https://hmtnote.readthedocs.io
- Github回购： https://github.com/robertopreste/hmtnote
- 出版物：https://doi.org/10.1101/600619" rel="nofollow">https://doi.org/10.1101/600619
功能
hmtnote是一个生物信息学python模块和命令行接口，可以使用 hmtvar
根据注释提供的信息类型，注释分为基本注释、交叉引用注释、可变性注释和预测注释。可以使用所有注释对VCF文件进行完全注释，也可以选择感兴趣的特定注释。
hmtnote的工作原理是动态地从hmtvar中提取所需的数据，但是如果您打算离线注释vcf文件，可以下载注释数据库，以便hmtnote可以在没有Internet连接时使用它。
有关详细信息，请参阅文档的 用法部分。
安装
请注意：hmtnote仅支持python>；=3.6！
hmtnote的首选安装方法是使用 pip ：
$ pip install hmtnote
有关详细信息，请参阅文档的安装部分。
用法
命令行界面
hmtnote可以用作命令行工具，使用
annotate
命令，并提供输入的vcf文件名以及保存带注释的vcf的文件名或路径：
hmtnote annotate input.vcf annotated.vcf
默认情况下，hmtnote将使用所有四组注释（basic、cross-reference、variability和predictions）注释vcf文件。如果需要，可以分别使用
--basic
，
--crossref
选择所需的特定注释，
--变量b
和
--预测
（或
-b
，
-c
，
-v
，
-p
），或这些选项的任意组合：
hmtnote annotate input.vcf annotated_basic.vcf --basic
hmtnote annotate input.vcf annotated_crossreferences.vcf --crossref
hmtnote annotate input.vcf annotated_variability.vcf --variab
hmtnote annotate input.vcf annotated_predictions.vcf --predict
hmtnote annotate input.vcf annotate_basic_variability.vcf --basic --variab
也可以通过简单地指定
--csv
选项
（请注意，必须提供输出的vcf文件名）
：
hmtnote annotate input.vcf annotated.vcf --csv
在annotated.vcf的同一目录中将创建一个附加的
annotated.csv
文件。
默认情况下，hmtnote的工作方式是动态地从hmtvar中提取所需的数据，但是如果您计划离线注释vcf文件，请首先使用dump命令下载注释数据库：
hmtnote dump
之后，即使没有可用的Internet连接，hmtnote也可以工作；这可以使用常规注释命令之后的
--offline
选项来实现：
hmtnote annotate input.vcf annotated.vcf --offline
hmtnote annotate input.vcf annotated_variability.vcf --variab --offline
python模块
hmtnote也可以导入到python脚本中，它的函数 annotate_vcf（） 可以用于注释给定的vcf:
from hmtnote import annotate
annotate("input.vcf", "annotated.vcf")
默认情况下， annotate_vcf（） 将使用所有四组注释（基本、交叉引用、可变性和预测）来注释vcf。如果需要，可以分别使用 basic=true 、 crossref=true 、 variab=true 、 predict=true 参数或它们的任意组合来指定所需的注释类型：
annotate("input.vcf", "annotated_basic.vcf", basic=True)
annotate("input.vcf", "annotated_crossreferences.vcf", crossref=True)
annotate("input.vcf", "annotated_variability.vcf", variab=True)
annotate("input.vcf", "annotated_predictions.vcf", predict=True)
可以使用 csv=true 参数从输出vcf生成附加注释的csv：
annotate("input.vcf", "annotated.vcf", csv=True)
还可以使用 dump（） 函数下载注释数据库，并通过意味着将 offline=true 参数添加到 annotate vcf（） ：
$ pip install hmtnote
0
学分
这个包是用cookiecutter和cc pypackage项目模板创建的。
欢迎加入QQ群-->： 979659372
