griffithlab/regtools

regtools Docker 镜像文档

镜像概述

regtools 是一款专门用于整合 DNA-seq 和 RNA-seq 数据的生物信息学分析工具。该 Docker 镜像封装了 regtools 及其所有依赖项，旨在帮助研究人员在基因调控和 RNA 剪接的背景下，深入分析和解释基因组突变的功能性影响。通过容器化部署，用户可以免去复杂的环境配置，快速开展多组学数据分析。

核心功能和特性

• 异常剪接识别：识别给定变异（variants）列表附近 RNA 测序 reads 中存在异常剪接的证据。
• 外显子连接提取：从 RNA-seq 的 BAM 比对文件中高效提取外显子-外显子连接（exon-exon junctions）。
• 连接注释：利用已知的转录组参考信息，对提取出的外显子-外显子连接进行详细注释。
• 变异注释：使用剪接区域（splice-region）信息对基因组变异进行注释（剪接区域的定义范围支持自定义配置）。

使用场景和适用范围

• 癌症基因组学：研究体细胞突变（如非编码区突变或同义突变）对 RNA 剪接模式和基因表达调控的潜在影响。
• 罕见病与遗传病研究：分析致病性变异是否通过破坏正常的剪接位点或引入隐蔽剪接位点而导致异常剪接事件。
• 多组学联合分析：结合 DNA 和 RNA 测序数据，全面评估基因组变异在转录层面的功能性后果。

使用方法和配置说明

1. 数据准备

在运行容器前，请确保将本地的测序数据（如 BAM 文件、VCF 文件）和参考基因组文件挂载到容器内部。

2. Docker Run 部署示例

使用 docker run 命令运行 regtools，并将本地数据目录挂载到容器的 /data 目录：

bash
# 查看帮助信息
docker run --rm -v /path/to/your/data:/data docker.xuanyuan.run/griffithlab/regtools regtools --help

# 提取外显子-外显子连接示例
docker run --rm -v /path/to/your/data:/data docker.xuanyuan.run/griffithlab/regtools regtools junctions extract /data/input.bam

# 变异注释示例
docker run --rm -v /path/to/your/data:/data docker.xuanyuan.run/griffithlab/regtools regtools variants annotate /data/variants.vcf /data/reference.fa /data/genes.bed

3. Docker Compose 配置示例

对于需要频繁运行或集成到流水线中的场景，可以使用 docker-compose.yml 进行配置：

yaml
version: '3.8'

services:
  regtools:
    image: docker.xuanyuan.run/griffithlab/regtools:latest
    volumes:
      - ./data:/data
    working_dir: /data
    # 默认执行帮助命令，实际使用时可通过 docker-compose run 覆盖
    command: regtools --help 

运行特定任务时，可通过命令行覆盖默认命令：

bash
docker-compose run --rm regtools regtools junctions extract input.bam

4. 配置参数说明

• 剪接区域（Splice-region）配置：在进行变异注释时，剪接区域的范围定义是高度可配置的。用户可以通过命令行参数调整距离外显子边界的阈值，以精确控制注释的敏感度。
• 完整的命令行参数和高级配置选项，请在容器内运行 regtools --help 或查阅官方文档。

其他信息

• 官方文档：https://regtools.readthedocs.org/en/latest/
• 源码仓库：https://github.com/griffithlab/regtools
• 问题反馈：可通过 https://github.com/griffithlab/regtools/issues 提交 Bug 报告或功能建议，或发送邮件至官方邮件列表 regtools@googlegroups.com。
• 开源许可证：本项目基于 https://opensource.org/licenses/MIT 开源。