ncbi/egapx

EGAPx Docker镜像文档

镜像概述和主要用途

EGAPx（Eukaryotic Genome Annotation Pipeline: eXternal）是美国国家生物技术信息中心（NCBI）真核基因组注释管道的公开可访问版本，源码托管于https://github.com/ncbi/egapx%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%95%B4%E5%90%88%E4%BA%86%E5%A4%9A%E7%A7%8D%E7%94%9F%E7%89%A9%E4%BF%A1%E6%81%AF%E5%AD%A6%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%97%A8%E5%9C%A8%E4%B8%BA%E7%A7%91%E7%A0%94%E4%BA%BA%E5%91%98%E6%8F%90%E4%BE%9B%E6%A0%87%E5%87%86%E5%8C%96%E3%80%81%E8%87%AA%E5%8A%A8%E5%8C%96%E7%9A%84%E7%9C%9F%E6%A0%B8%E5%9F%BA%E5%9B%A0%E7%BB%84%E6%B3%A8%E9%87%8A%E6%B5%81%E7%A8%8B%EF%BC%8C%E6%94%AF%E6%8C%81%E7%9C%9F%E6%A0%B8%E7%94%9F%E7%89%A9%E5%9F%BA%E5%9B%A0%E7%BB%84%E7%9A%84%E7%BB%93%E6%9E%84%E4%B8%8E%E5%8A%9F%E8%83%BD%E6%B3%A8%E9%87%8A%E5%88%86%E6%9E%90%E3%80%82

核心功能和特性

• 专业化注释流程：针对真核生物基因组设计，实现从序列数据到注释结果的完整流程。
• 工具整合：内置STAR、samtools、miniprot、bamtools等多种第三方生物信息学工具，满足注释分析中的序列比对、数据处理等需求。
• 标准化部署：通过Docker容器化封装，确保跨平台环境一致性，简化依赖管理和部署流程。

使用场景和适用范围

适用场景

• 真核生物（如动物、植物、真菌等）基因组的从头注释或重注释项目。
• 比较基因组学研究中对多个真核基因组的批量注释分析。
• 生物信息学平台中集成标准化的基因组注释模块。

适用范围

• 科研机构、高校及生物技术企业的基因组学研究团队。
• 需要自动化、可重复真核基因组注释流程的生物信息学分析场景。

使用方法和配置说明

基础使用流程

1. 获取镜像：从Docker仓库拉取或本地构建EGAPx镜像（具体方式需参考官方GitHub文档）。
2. 准备输入数据：包括待注释的基因组序列文件、参考数据（如蛋白数据库、RNA-seq数据等，根据注释需求准备）。
3. 运行容器：通过挂载本地数据目录与容器交互，执行注释流程。

Docker部署示例

1. 基础运行命令

bash
docker run -it \
  -v /本地输入目录:/input \    # 挂载输入数据目录（含基因组序列等）
  -v /本地输出目录:/output \  # 挂载输出结果目录
  ncbi/egapx \                 # 镜像名称（需替换为实际镜像标签）
  /egapx/pipeline/run_annotation.sh --input /input/genome.fasta --output /output  # 注释流程启动命令（示例）

2. Docker Compose配置（示例）

yaml
version: '3'
services:
  egapx-annotation:
    image: ncbi/egapx
    volumes:
      - ./local_input:/input
      - ./local_output:/output
    command: /egapx/pipeline/run_annotation.sh --input /input/genome.fasta --output /output
    environment:
      - THREADS=8  # 示例环境变量：设置并行线程数（具体需参考工具支持参数）

配置说明

• 输入参数：需通过命令行或配置文件指定待注释基因组文件路径、参考数据路径等（详细参数请参考https://github.com/ncbi/egapx%EF%BC%89%E3%80%82
• 环境变量：可通过-e参数设置并行线程数（如THREADS）、临时文件目录等，优化运行效率。
• 输出文件：注释结果（如GFF3、GTF格式的基因结构文件、功能注释报告等）将保存至挂载的/output目录。

许可信息

主程序许可

EGAPx主程序为美国***作品，不受美国版权法限制（17 USC 105），属于公共领域。美国国家医学图书馆（NLM）对其使用和复制无限制，但不提供任何明示或暗示的担保（包括性能、适销性或特定用途适用性）。基于本材料的任何工作或产品需引用NLM。

第三方工具许可

EGAPx使用的第三方工具及其许可如下：

STAR

• 许可类型：MIT License
• 版权：2019 Alexander Dobin
• 摘要：允许免费使用、复制、修改、分发软件，需包含版权和许可声明，软件按"原样"提供，不承担担保责任。

samtools

• 许可类型：MIT/Expat License
• 版权：2008-2024 Genome Research Ltd.
• 摘要：允许无限制使用、分发软件，需包含版权和许可声明，软件按"原样"提供，不承担担保责任。

miniprot

• 许可类型：MIT License
• 版权：2022- Dana-Farber Cancer Institute
• 摘要：允许免费使用、复制、修改、分发软件，需包含版权和许可声明，软件按"原样"提供，不承担担保责任。

bamtools

• 许可类型：MIT License
• 版权：2009-2010 Derek Barnett, Erik Garrison, Gabor Marth, Michael Stromberg
• 摘要：允许无限制使用、分发软件，需包含版权和许可声明，软件按"原样"提供，不承担担保责任。

注意：完整许可文本可通过容器内/egapx/licenses/目录或https://github.com/ncbi/egapx%E8%8E%B7%E5%8F%96%E3%80%82