mgibio/custom-clinvar-vcf

ClinVar VCF生成工具镜像

镜像概述

本镜像提供了将NCBI ClinVar数据转换为自定义VCF文件的工具和脚本，主要用于生物信息学工作流中处理ClinVar变异数据。通过整合ClinVar的表格型数据和VCF数据，生成适用于下游分析的标准化VCF文件。

核心功能

• 包含ncbi_to_vcf.py脚本，用于合并ClinVar的TSV文件和VCF文件
• 内置bgzip工具，支持压缩文件的解压处理
• 提供VCF头文件模板（header.txt），确保生成的VCF文件格式合规

使用场景

适用于需要处理ClinVar变异数据并生成自定义VCF文件的生物信息学分析流程，例如：

• 变异注释流程
• 临床基因组数据分析
• 变异数据库构建

使用方法

1. 准备数据文件

需从NCBI ClinVar FTP下载以下文件：

• TSV文件：位于ftp://ftp.ncbi.nlm.nih.gov/pub/clinvar/tab_delimited/，如variant_summary.txt.gz（建议同时下载MD5哈希文件variant_summary.txt.gz.md5进行校验）
• VCF文件：位于ftp://ftp.ncbi.nlm.nih.gov/pub/clinvar/vcf_GRCh38/，如clinvar_20181028.vcf.gz（文件名包含版本日期，需根据实际情况调整）

2. 解压文件

使用镜像内置的bgzip工具解压下载的压缩文件：

bash
# 删除原压缩文件，生成解压后的文件（.gz后缀会被移除）
bgzip -d variant_summary.txt.gz
bgzip -d clinvar_20181028.vcf.gz

# 或保留原压缩文件，将解压内容输出到stdout
bgzip -cd variant_summary.txt.gz > variant_summary.txt
bgzip -cd clinvar_20181028.vcf.gz > clinvar_20181028.vcf

3. 运行转换脚本

在Docker容器内执行ncbi_to_vcf.py脚本，合并TSV和VCF文件：

bash
# 基本命令格式
python /usr/bin/ncbi_to_vcf.py <tsv_file> <vcf_file>

# 示例（假设已解压文件为variant_summary.txt和clinvar_20181028.vcf）
python /usr/bin/ncbi_to_vcf.py variant_summary.txt clinvar_20181028.vcf

脚本默认将结果输出到stdout。

4. 生成完整VCF文件

将镜像提供的header.txt（包含自定义字段描述）与脚本输出合并，生成完整VCF：

bash
# 复制header.txt内容到自定义VCF文件
cp header.txt custom.vcf

# 将脚本输出追加到custom.vcf
python /usr/bin/ncbi_to_vcf.py variant_summary.txt clinvar_20181028.vcf >> custom.vcf

注意事项

• 由于ClinVar数据源格式可能不定期变化，ncbi_to_vcf.py脚本可能需要根据数据格式更新进行修改
• TSV文件在主目录中无版本标识，建议通过MD5哈希校验文件完整性
• VCF文件在主目录中包含版本日期（如clinvar_20181028.vcf.gz），使用时需根据最新文件名调整
• 镜像中文件以压缩格式存储以节省空间，使用前需解压