eggNOG-mapper 项目安装与使用教程

1. 项目目录结构及介绍

eggnog-mapper/
├── data/
│   └── 存放项目所需的数据文件
├── eggnogmapper/
│   ├── 项目的主要代码文件
│   ├── __init__.py
│   ├── emapper.py
│   ├── hmm_mapper.py
│   ├── hmm_server.py
│   └── hmm_worker.py
├── tests/
│   └── 项目的测试文件
├── .gitignore
├── LICENSE.txt
├── MANIFEST.in
├── README.md
├── create_dbs.py
├── download_eggnog_data.py
├── emapper.py
├── hmm_mapper.py
├── hmm_server.py
├── hmm_worker.py
├── pyproject.toml
├── release.py
├── requirements.txt
├── setup.cfg
└── setup.py

目录结构说明

• data/: 存放项目运行所需的数据文件。
• eggnogmapper/: 项目的主要代码文件夹，包含核心功能实现。
• tests/: 存放项目的测试文件，用于确保代码的正确性。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE.txt: 项目的开源许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• README.md: 项目的说明文档，通常包含项目的基本信息和使用方法。
• create_dbs.py: 用于创建数据库的脚本。
• download_eggnog_data.py: 用于下载 eggNOG 数据的脚本。
• emapper.py: 项目的主启动文件，负责功能注释的主要逻辑。
• hmm_mapper.py, hmm_server.py, hmm_worker.py: 与 HMM 相关的脚本文件。
• pyproject.toml: 项目配置文件，用于指定项目的构建系统和其他元数据。
• release.py: 用于发布项目的脚本。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.cfg: 项目配置文件，包含安装和打包的配置信息。
• setup.py: 用于安装项目的脚本。

2. 项目的启动文件介绍

emapper.py

emapper.py 是 eggNOG-mapper 项目的主启动文件。它负责执行功能注释的主要逻辑，包括基因预测、序列比对、正交预测和功能注释等。

主要功能

• 基因预测: 使用 Prodigal 进行基因预测。
• 序列比对: 支持 Diamond、MMseqs2 和 HMMER3 进行序列比对。
• 正交预测: 基于 eggNOG 数据库进行正交预测。
• 功能注释: 从正交预测结果中提取功能注释信息。

使用方法

python emapper.py -i input_file -o output_file

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是 eggNOG-mapper 项目的配置文件，用于指定项目的安装和打包配置。

主要配置项

• metadata: 包含项目的元数据，如名称、版本、作者等。
• options: 包含安装和打包的选项，如依赖包、脚本文件等。

pyproject.toml

pyproject.toml 是 eggNOG-mapper 项目的配置文件，用于指定项目的构建系统和其他元数据。

主要配置项

• build-system: 指定项目的构建系统，如 setuptools。
• tool: 包含其他工具的配置，如 setuptools 的配置。

requirements.txt

requirements.txt 是 eggNOG-mapper 项目的依赖包列表，列出了项目运行所需的 Python 包及其版本。

使用方法

pip install -r requirements.txt

通过以上配置文件，可以确保 eggNOG-mapper 项目在不同环境中的一致性和可重复性。