karchinlab/opencravat

OpenCRAVAT Docker镜像文档

镜像概述

OpenCRAVAT Docker镜像基于Python 3.8构建，集成了OpenCRAVAT基因组变异注释工具及其依赖组件。该镜像包含完整的运行环境，包括Python库（如open-cravat-multiuser、aiosqlite3等）、R环境及相关生物信息学包（SeqArray等），并通过卷挂载实现数据持久化，支持模块管理、变异注释和Web GUI功能。

核心功能与特性

• 基因组变异注释：支持对VCF等格式的变异数据进行注释分析
• 模块管理：可安装、更新基础模块及各类注释器
• Web GUI支持：提供浏览器界面，用于提交作业和查看结果
• 数据持久化：通过卷挂载将配置、模块、作业和日志数据存储在宿主机
• 多环境兼容：集成Python和R运行环境，满足各类生物信息学分析需求

使用场景与适用范围

• 基因组变异注释分析
• 科研机构或实验室的变异数据批量处理
• 需要Web界面管理注释作业的场景
• 需持久化存储注释模块和结果数据的应用

使用方法与配置说明

模块安装

OpenCRAVAT依赖大型参考数据模块，需通过卷挂载在宿主机持久化存储。执行以下命令安装模块：

安装基础模块

bash
docker run -v /host/path/to/modules:/mnt/modules docker.xuanyuan.run/karchinlab/opencravat:latest oc module install-base

安装指定注释器

bash
docker run -v /host/path/to/modules:/mnt/modules docker.xuanyuan.run/karchinlab/opencravat:latest oc module install -y annotator_1 annotator_2

注：将annotator_1、annotator_2替换为实际需要的注释器名称

更新模块

bash
docker run -v /host/path/to/modules:/mnt/modules docker.xuanyuan.run/karchinlab/opencravat:latest oc module update -y

变异注释

容器默认工作目录为/tmp/job，挂载宿主机输入目录至该路径，输出结果将保存在挂载目录中：

基本注释命令

bash
docker run -v /host/path/to/modules:/mnt/modules -v /host/path/to/inputdir:/tmp/job docker.xuanyuan.run/karchinlab/opencravat:latest oc run input.vcf

当前目录快捷命令

bash
docker run -v /host/path/to/modules:/mnt/modules -v $PWD:/tmp/job docker.xuanyuan.run/karchinlab/opencravat:latest oc run input.vcf

注：input.vcf为宿主机输入目录中的VCF文件

Web GUI

OpenCRAVAT提供基于浏览器的图形界面，支持作业提交和结果查看。

使用docker-compose部署GUI服务

创建docker-compose.yml文件：

yaml
version: '3'
services:
  oc-gui:
    image: docker.xuanyuan.run/karchinlab/opencravat:latest
    volumes:
      - '/path/to/conf:/mnt/conf'      # 配置文件存储
      - '/path/to/modules:/mnt/modules'  # 模块数据存储
      - '/path/to/jobs:/mnt/jobs'      # 作业数据存储
      - '/path/to/logs:/mnt/logs'      # 日志存储
    ports:
      - '8080:8080'  # 映射GUI端口
    command: ['oc', 'gui']

启动服务：

bash
docker-compose up -d

访问http://localhost:8080即可打开Web界面。

查看单个作业结果

bash
docker run -v /host/path/to/modules:/mnt/modules -v $PWD:/tmp/job docker.xuanyuan.run/karchinlab/opencravat:latest oc gui oc-result.sqlite

注：oc-result.sqlite为注释生成的结果数据库文件

卷挂载说明