【亲测免费】 Resistance Gene Identifier (RGI) 项目教程

1. 项目的目录结构及介绍

rgi/
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── docs/
│   ├── README.rst
│   └── ...
├── images/
│   └── ...
├── tests/
│   └── ...
├── .gitignore
├── CITATION.cff
├── LICENSE
├── README.rst
├── conda_env.yml
├── requirements.txt
├── setup.py
└── test.sh

目录结构介绍

• app/: 包含项目的主要代码文件，如 main.py 是项目的启动文件。
• docs/: 包含项目的文档文件，如 README.rst 是项目的介绍文档。
• images/: 包含项目相关的图片文件。
• tests/: 包含项目的测试代码文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CITATION.cff: 项目的引用信息文件。
• LICENSE: 项目的开源许可证文件。
• README.rst: 项目的介绍文档，通常包含项目的概述、安装方法、使用说明等。
• conda_env.yml: Conda 环境配置文件，用于创建项目的运行环境。
• requirements.txt: Python 依赖文件，列出了项目所需的 Python 包。
• setup.py: Python 项目的安装脚本。
• test.sh: 项目的测试脚本。

2. 项目的启动文件介绍

app/main.py

main.py 是 Resistance Gene Identifier (RGI) 项目的启动文件。它包含了项目的主要逻辑和功能实现。通过运行 main.py，用户可以启动 RGI 并执行相关的分析任务。

# app/main.py

def main():
    # 项目的主要逻辑代码
    pass

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

conda_env.yml

conda_env.yml 是 Conda 环境配置文件，用于定义项目的运行环境。通过该文件，用户可以创建一个包含所有依赖项的 Conda 环境。

# conda_env.yml

name: rgi
channels:
  - conda-forge
  - bioconda
  - defaults
dependencies:
  - python=3.6
  - ncbi-blast=2.14.0
  - prodigal=2.6.3
  - diamond=0.8.36
  - biopython=1.78
  - filetype=1.0.0
  - pytest=3.0.0
  - pandas=0.15.0
  - matplotlib=2.1.2
  - seaborn=0.8.1
  - pyfaidx=0.5.4.1
  - pyahocorasick=1.1.7
  - oligoarrayaux=3.8
  - samtools=1.9
  - bamtools=2.5.1
  - bedtools=2.27.1
  - jellyfish=2.2.10
  - bowtie2=2.3.4.3
  - bwa=0.7.17
  - kma=1.3.4

requirements.txt

requirements.txt 是 Python 依赖文件，列出了项目所需的 Python 包及其版本。通过该文件，用户可以使用 pip 安装所有依赖项。

# requirements.txt

biopython==1.78
filetype==1.0.0
pytest==3.0.0
pandas==0.15.0
matplotlib==2.1.2
seaborn==0.8.1
pyfaidx==0.5.4.1
pyahocorasick==1.1.7

通过以上配置文件，用户可以轻松地搭建项目的运行环境，并开始使用 Resistance Gene Identifier (RGI) 进行抗生素抗性基因的预测和分析。