nextgenusfs/funannotate

funannotate 镜像文档

1. 镜像概述和主要用途

funannotate 是一个基因组注释流程，专为真菌基因组设计，理论上也适用于其他真核生物。该工具通过简单命令即可实现从基因组组装到功能注释的全流程分析，生成包含 InterPro、PFAM、MEROPS、CAZymes、GO 本体等功能注释结果的基因组数据，支持直接提交至 NCBI。此外，其集成的轻量级比较基因组学模块可辅助分析不同注释基因组间的差异。

2. 核心功能和特性

• 全流程自动化：仅需少量命令即可完成从基因组组装到功能注释的完整流程，降低操作复杂度。
• 全面功能注释：支持多种数据库注释，包括 InterPro（蛋白质结构域）、PFAM（蛋白家族）、MEROPS（蛋白酶）、CAZymes（碳水化合物活性酶）、GO 本体（基因本体）等。
• NCBI 兼容性：生成符合 NCBI 提交标准的注释结果，简化数据上传流程。
• 比较基因组学支持：集成比较基因组分析工具，可快速比较不同注释基因组的差异。
• 跨平台适用性：基于 Docker 容器化，确保环境一致性，支持 Linux/macOS/Windows（需 Docker 环境）。

3. 使用场景和适用范围

• 适用生物类型：真菌基因组（主要设计目标）、其他真核生物基因组（如植物、动物等）。
• 研究场景：
  • 真菌功能基因组学研究中的基因结构与功能注释；
  • 比较基因组学分析（如不同菌株/物种间基因家族、功能元件差异）；
  • 基因组数据提交至 NCBI 前的标准化注释处理；
  • 中小型实验室的自动化基因组注释流程部署。

4. 使用方法和配置说明

4.1 基础使用条件

• 需安装 Docker 环境（Docker Engine 20.10+ 或兼容版本）；
• 输入文件：基因组组装序列（FASTA 格式）、可选的 RNA-seq 数据或蛋白质同源序列；
• 输出目录：用于存储注释结果（GFF3、蛋白质序列、功能注释表格等）。

4.2 Docker Run 命令示例

bash
# 基础注释流程示例（假设输入文件位于本地 ./input，输出至 ./output）
docker run -it --rm \
  -v $(pwd)/input:/input \          # 挂载输入目录（含基因组 FASTA 文件）
  -v $(pwd)/output:/output \        # 挂载输出目录（存储注释结果）
  funannotate:latest \              # 镜像名称（需替换为实际镜像标签）
  funannotate annotate \            # funannotate 子命令（注释流程）
  --genome /input/genome.fasta \    # 输入基因组文件路径（容器内路径）
  --out /output/annotation_results \# 输出目录（容器内路径）
  --species "Fungi species" \       # 物种名称（用于注释参数优化）
  --isolate "isolate_id"            # 菌株编号（可选，用于结果标记）

4.3 Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  funannotate:
    image: funannotate:latest
    volumes:
      - ./input:/input          # 输入目录（本地路径:容器内路径）
      - ./output:/output        # 输出目录
      - ./config:/config        # 可选：挂载配置文件目录（如自定义数据库路径）
    command: >
      funannotate annotate 
      --genome /input/genome.fasta 
      --out /output/annotation_results 
      --species "Fungi species" 
      --cpus 8                  # 指定 CPU 核心数（加速分析）
    environment:
      - EMAIL=user@example.com  # 可选：NCBI 提交时的联系邮箱
      - DATABASE_PATH=/config/db # 可选：自定义数据库存储路径（若需本地数据库）

启动命令：

bash
docker-compose up -d  # 后台运行

4.4 参数说明

4.4.1 环境变量

4.4.2 核心命令参数

4.5 数据挂载说明

• 输入目录（/input）：需包含基因组 FASTA 文件，可选 RNA-seq 数据（BAM/FASTQ 格式）、蛋白质同源序列（FASTA 格式）等。
• 输出目录（/output）：注释完成后将生成以下文件：
  • annotations.gff3：基因结构注释结果（GFF3 格式）；
  • proteins.fasta：预测蛋白质序列；
  • functional_annotation.tsv：功能注释表格（含 InterPro、GO 等信息）；
  • ncbi_submit/：NCBI 提交所需的格式化文件。

5. 注意事项

• 数据库初始化：首次运行需下载功能注释数据库（约 10-20 GB），建议通过 -v $(pwd)/db:/opt/funannotate/db 挂载本地目录持久化缓存，避免重复下载。
• 计算资源：基因组注释为高计算量任务，建议分配 ≥8 CPU 核心和 16 GB 内存，大型基因组（>50 Mb）需更高配置。
• 物种特异性：针对非真菌真核生物，建议通过 --kingdom 参数指定界（如 --kingdom Metazoa 动物、--kingdom Plantae 植物）以优化注释参数。