sigven/gvanno

gvanno - 人类DNA变异功能与临床注释通用工作流

!gvanno logo（图片位置：右侧，高130，宽113）

目录

• 概述
• 更新日志
• 注释资源
• 快速开始
• 联系信息

概述

通用变异注释器（gvanno）是一个用于人类DNA变异简单分析和解释的软件包。变异和基因会被注释疾病相关及功能关联信息。技术上，该工作流采用Python开发，并依赖Docker/Singularity技术封装软件依赖。

gvanno接受VCF格式的查询文件，可分析单核苷酸变异（SNVs）和短插入缺失（indels）。工作流主要依赖Ensembl的Variant Effect Predictor (VEP)和https://github.com/brentp/vcfanno%EF%BC%8C%E7%94%9F%E6%88%90%E6%B3%A8%E9%87%8A%E5%90%8E%E7%9A%84VCF%E6%96%87%E4%BB%B6%E5%92%8C%E5%88%B6%E8%A1%A8%E7%AC%A6%E5%88%86%E9%9A%94%E5%80%BC%E6%96%87%E4%BB%B6%EF%BC%88.tsv%EF%BC%89%EF%BC%8C%E5%90%8E%E8%80%85%E5%88%97%E5%87%BA%E6%AF%8F%E4%B8%AA%E5%8F%98%E5%BC%82%E8%AE%B0%E5%BD%95%E7%9A%84%E6%89%80%E6%9C%89%E6%B3%A8%E9%87%8A%E3%80%82%E6%B3%A8%E6%84%8F%EF%BC%9A%E8%8B%A5%E8%BE%93%E5%85%A5VCF%E5%8C%85%E5%90%AB%E5%A4%9A%E4%B8%AA%E6%A0%B7%E6%9C%AC%E7%9A%84%E5%9F%BA%E5%9B%A0%E5%9E%8B%E6%95%B0%E6%8D%AE%EF%BC%88%E5%8D%B3%E5%A4%9A%E6%A0%B7%E6%9C%ACVCF%EF%BC%89%EF%BC%8C%E8%BE%93%E5%87%BATSV%E6%96%87%E4%BB%B6%E5%B0%86**%E6%AF%8F%E4%B8%AA%E6%A0%B7%E6%9C%AC%E5%8F%98%E5%BC%82**%E5%AF%B9%E5%BA%94%E4%B8%80%E8%A1%8C%E8%AE%B0%E5%BD%95%E3%80%82

更新日志

• 2023年12月29日 - 1.7.0版本发布

  • 数据更新：ClinVar、GENCODE、GWAS catalog
  • 软件更新：VEP
  • 改进Singularity支持

• 2023年4月27日 - 1.6.0版本发布

  • 新增选项--oncogenicity_annotation - 根据致癌性对变异进行分类（Horak et al., Genet Med, 2022）
  • 数据更新：ClinVar、GENCODE、GWAS catalog、CancerMine
  • 排除Open Targets Platform的大量疾病关联数据

• 2022年9月26日 - 1.5.1版本发布

  • 新增选项--vep_coding_only - 仅报告落在转录本编码区域的变异（VEP选项--coding_only）

注释资源（v1.7.0）

• VEP - 变异效应预测器v110（基因参考数据集为GENCODE v44/v19）
• dBNSFP - 非同义变异功能预测数据库（v4.5，2023年11月）
• gnomAD - 全外显子组范围内的生殖系变异频率（2.1版本，2018年10月）- 来自VEP
• dbSNP - 短遗传变异数据库（build 154）- 来自VEP
• ClinVar - 与人类健康/疾病表型相关的变异数据库（2023年12月）
• CancerMine - 癌症中驱动基因、癌基因和肿瘤抑制因子的文献挖掘数据库（50版本，2023年3月）
• Mutation hotspots - 癌症突变热点数据库
• NHGRI-EBI GWAS Catalog - 已发表全基因组关联研究目录（2023年11月）

快速开始

步骤0：前提条件

• Python

  运行gvanno需要安装Python（版本≥3.6）。在终端输入python --version检查是否已安装。

• 其他工具

  安装参考数据的脚本要求用户已安装bgzip和tabix。安装说明见此处。该脚本还需要基本的Linux/UNIX命令（如gzip、tar）。

  注意：gvanno应安装在MacOS或Linux/UNIX操作系统上。

步骤1：安装Docker/Singularity

• gvanno工作流可通过Docker或Singularity容器技术执行。

Docker安装

1. 在首选平台安装Docker引擎
   • 在Linux上安装Docker
   • 在Mac OS上安装Docker
   • 注意：我们尚未在Windows平台进行充分测试，且收到反馈某些Docker/Windows版本与gvanno不兼容（例如https://github.com/docker/toolbox/issues/607%EF%BC%89
2. 测试Docker是否运行，例如在终端输入docker ps或docker images
3. 调整Docker的计算资源：
   • 内存：至少5GB
   • CPU：至少4核
   • 操作方法 - Mac OS X

Singularity安装

1. 安装Singularity

步骤2：下载gvanno和数据 bundle

1. https://github.com/sigven/gvanno/releases/tag/v1.7.0

2. 使用download_gvanno_refdata.py脚本安装特定组装版本的VEP缓存和gvanno特定参考数据，例如：

   • python download_gvanno_refdata.py --download_dir <下载目录路径> --genome_assembly grch38

   注意：根据本地带宽，此过程可能需要较长时间（每个组装版本的bundle约20Gb）

3. 拉取容器镜像

   • Docker

     • 从DockerHub拉取https://hub.docker.com/r/sigven/gvanno/%EF%BC%88%E7%BA%A63.8Gb%EF%BC%89%EF%BC%9A

     • docker pull sigven/gvanno:1.7.0（gvanno注释引擎）

   • Singularity

     • 下载gvanno SIF镜像（v1.7.0）（约1.2Gb），并在gvanno.py运行脚本中使用--sif_file参数指定该文件。

步骤3：输入预处理

gvanno工作流接受单个输入文件：

• 未注释的单样本VCF文件（≥v4.2），包含生殖系变异（SNVs/InDels）

强烈建议使用bgzip和tabix对输入VCF进行压缩和索引。注意：若输入VCF包含多等位基因位点，将进行分解处理。

步骤4：运行示例

使用gvanno.py运行工作流，其接受以下参数和选项：

usage:
gvanno.py -h [options]
--query_vcf <QUERY_VCF>
--gvanno_dir <GVANNO_DIR>
--output_dir <OUTPUT_DIR>
--genome_assembly <grch37|grch38>
--sample_id <SAMPLE_ID>
--container <docker|singularity>

gvanno - 生殖系核苷酸变异功能与临床注释工作流

必填参数:
--query_vcf QUERY_VCF
                包含生殖系查询变异（SNVs/InDels）的VCF输入文件。
--gvanno_dir GVANNO_DIR
                包含gvanno参考数据的目录，例如 ~/gvanno-1.7.0
--output_dir OUTPUT_DIR
                输出目录
--genome_assembly {grch37,grch38}
                基因组组装版本：grch37或grch38
--container {docker,singularity}
                使用docker或singularity运行gvanno
--sample_id SAMPLE_ID
                样本标识符 - 输出文件前缀

VEP可选参数:
--vep_regulatory        启用变异效应预测器（VEP）查找与调控区域的重叠（VEP中的--regulatory选项）。
--vep_gencode_basic     使用变异效应预测器（VEP）时仅考虑基本GENCODE转录本。
--vep_lof_prediction    使用变异效应预测器（VEP）中的LOFTEE插件预测功能丧失变异，默认：False
--vep_n_forks VEP_N_FORKS
                变异效应预测器（VEP）处理的分叉数，默认：4
--vep_buffer_size VEP_BUFFER_SIZE
                变异效应预测器（VEP）处理的变异缓冲区大小（同时读入内存的变异数）
                - 降低可减少内存使用，提高可增加速度，默认：500
--vep_pick_order VEP_PICK_ORDER
                变异效应预测器（VEP）处理中主要变异选择的有序转录本属性逗号分隔字符串，默认：canonical,appris,biotype,ccds,rank,tsl,length,mane
--vep_no_intergenic
                在变异效应预测器（VEP）处理中跳过基因间区变异，默认：False
--vep_coding_only
                仅报告落在转录本编码区域的变异（VEP），默认：False

其他可选参数:
--force_overwrite     默认情况下，若任何输出文件已存在，脚本将报错。
                使用此标志可强制覆盖现有结果文件，默认：False
--version             显示程序版本号并退出
--no_vcf_validate     跳过使用Ensembl的vcf-validator验证输入VCF，默认：False
--docker_uid DOCKER_USER_ID
                Docker用户ID。默认是主机系统用户ID。若遇到权限错误，尝试设置为root（`--docker-uid root`）
--vcfanno_n_processes VCFANNO_N_PROCESSES
                vcfanno处理的进程数（参见https://github.com/brentp/vcfanno#-p），默认：4
--oncogenicity_annotation
                    根据致癌性对变异进行分类（Horak et al., Genet Med, 2022）
--debug             将完整的Docker/Singularity命令打印到日志，不删除带有警告等的中间文件。
--sif_file		使用`--container singularity`选项运行gvanno工作流时的gvanno SIF镜像文件

“examples”文件夹包含示例VCF文件。可通过以下命令（基于Docker）分析示例VCF：

python ~/gvanno-1.7.0/gvanno.py
--query_vcf ~/gvanno-1.7.0/examples/example.grch37.vcf.gz
--gvanno_dir ~/gvanno-1.7.0
--output_dir ~/gvanno-1.7.0
--sample_id example
--genome_assembly grch37
--container docker
--force_overwrite

或基于Singularity：

python ~/gvanno-1.7.0/gvanno.py
--query_vcf ~/gvanno-1.7.0/examples/example.grch37.vcf.gz
--gvanno_dir ~/gvanno-1.7.0
--output_dir ~/gvanno-1.7.0
--sample_id example
--genome_assembly grch37
--container singularity
--sif_file gvanno_1.7.0.sif
--force_overwrite

此命令将运行基于Docker的gvanno工作流，并在“examples”文件夹中生成以下输出文件：

1. example_gvanno_grch37.pass.vcf.gz (.tbi) - 包含丰富功能/临床变异和基因注释的bgzip压缩VCF文件
2. example_gvanno_grch37.pass.tsv.gz - 包含丰富功能/临床变异和基因注释的压缩TSV文件

类似文件也会为所有变异生成，不仅是VCF FILTER列中标记为“PASS”的变异。

文档

各种变异和基因注释的文档可从注释VCF文件的头部查询。制表符分隔值（TSV）文件的列名与VCF文件头中记录的INFO标签相同。

联系信息

sigven AT ifi.uio.no