satta/companion

Companion

基于Nextflow实现的可移植、可扩展的真核生物基因组注释管道。

https://travis-ci.org/sanger-pathogens/companion.svg?branch=master](https://travis-ci.org/sanger-pathogens/companion)
https://img.shields.io/badge/License-ISC-brightgreen.svg](https://github.com/sanger-pathogens/companion/blob/master/LICENSE)
https://img.shields.io/badge/NAR-10.1093%2Fnar.gkw292-brightgreen.svg](https://doi.org/10.1093/nar/gkw292)

该软件是一个全面的计算管道，用于真核生物基因组（如原生动物寄生虫）的注释。它执行以下任务：

• 通过参考基因组对scaffolds进行排序和定向，快速生成假分子
• 从参考基因组准确转移高度保守的基因模型
• 以基因转移为补充的从头基因预测
• 非编码RNA检测（tRNA、rRNA、sn(o)RNA等）
• 假基因检测
• 功能注释（GO、产物等）
  • 通过将参考注释转移到目标基因组
  • 通过Pfam pHMM匹配推断GO术语和产物
• 一致的基因ID分配
• 准备经过验证的GFF3、GAF和EMBL输出文件，用于启动手动注释和快速提交

它支持在单台机器以及大型集群平台（LSF、SGE等）上并行执行。

目录

• 快速开始
  • 1. 安装依赖
  • 2. 安装Companion
  • 3. 运行Companion测试任务
  • 4. 配置Companion用于注释运行
  • 5. 准备参考注释
  • 6. 运行管道
• 更多技术信息
  • 依赖
    • Java
    • Nextflow
    • Docker
  • 安装
  • 使用
    • Companion本地副本
    • 直接从仓库运行Companion
    • 准备参考注释
• 许可证
• 反馈/问题
• 引用

快速开始

以下步骤可帮助你在Ubuntu系统上快速启动，但在实际工作前请阅读完整文档。

1. 安装依赖

以root身份执行以下命令（例如使用sudo）：

apt-get install default-jre
curl -fsSL get.nextflow.io | bash && \
   mv nextflow /usr/local/bin
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \
   add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" && \
   apt-get update && \
   apt-cache policy docker-ce && \
   apt-get install --yes docker-ce && \
   systemctl enable docker

为了让普通用户无需root或sudo即可使用Docker，请运行以下命令（将<username>替换为你的用户名）：

usermod -aG docker <username>

注销并重新登录以使更改生效。

检查

• java -version应显示Java 1.8或更高版本
• nextflow info将打印系统信息（若Nextflow安装成功）
• systemctl status docker将显示Docker是否处于活动（运行）状态
• docker info将打印信息（若Docker安装成功且你有权限使用）

2. 安装Companion

在你希望保存Companion工作的目录中执行以下命令（以普通用户身份）： 将<my-companion-project>替换为有意义的名称：

curl -L -o companion-master.zip https://github.com/sanger-pathogens/companion/archive/master.zip && \
   unzip companion-master.zip && \
   mv companion <my-companion-project>
docker pull docker.xuanyuan.run/sangerpathogens/companion

3. 运行Companion测试任务

Companion包含一个小型测试运行的配置和数据（包括一些预生成的参考注释）。运行以下命令（将my-companion-project替换为你选择的项目目录名称）：

nextflow run my-companion-project -profile docker

这将创建my-companion-project/example-output目录，包含运行结果。

4. 配置Companion用于注释运行

params_default.config文件配置管道，需要根据你的注释运行进行编辑。你可能需要更改至少以下参数：

inseq 输入FASTA文件（示例参数文件中为${baseDir}/example-data/L_donovani.1.fasta）
ref_dir 参考基因组目录（示例文件中为${baseDir}/example-data/references）
ref_species 参考物种的“短名称”（示例文件中为LmjF.1）
dist_dir 新创建的输出文件目录（示例文件中为${baseDir}/example-data-output）
GENOME_PREFIX 匹配基因组前缀的文本模式（示例文件中为LDON）
CHR_PATTERN 匹配染色体名称的模式（示例文件中为LDON_(%w+)，其中%w+匹配一个或多个字母或数字）
ABACAS_BIN_CHR Abacas bin染色体（示例文件中为LDON_0）
EMBL_AUTHORS 等：请提供合适的EMBL元数据（示例文件中为虚拟值）
TAXON_ID 请为GAF输出提供合适的值（示例文件中为4711）

5. 准备参考注释

管道中使用的参考注释需要预处理才能使用。添加参考生物需要：

• 生物的描述性名称
• 生物的短缩写
• 单个FASTA文件中的基因组序列
• GFF3格式的结构基因注释
• 基因水平的GAF 1.0格式功能GO注释
• 匹配染色体头的模式（描述如何从中提取染色体编号）
• 基于参考基因训练的AUGUSTUS模型

将以下步骤中的<占位符>替换为实际文件名等：

1. 创建新数据目录（即与分发中包含的example-data目录等效的目录）
2. 编辑nextflow.config（及引用的任何配置文件），将inseq和ref_dir等参数更改为新数据目录
3. 将新参考基因组（FASTA）复制到<new_data_dir>/genomes
4. 将GFF3和GAF文件复制到<new_data_dir>/genomes
5. 将Augustus模型文件复制到data/augustus/species/<species_name>/
6. 创建新目录<new_data_dir>/references/<short_name>/
7. 向<new_data_dir>/references/references-in.json添加新部分（使用短名称，与上一步的目录名称相同）；在此部分添加复制文件的名称/路径、描述性名称和FASTA文件中染色体的匹配模式：

"<short_name>" : {   "gff"                : "../genomes/<gff3_filename>.gff3",
                     "genome"             : "../genomes/<ref_genome_name>.fasta",
                     "gaf"                : "../genomes/<ref_annot_filename>.gaf",
                     "name"               : "<参考基因组的描述性名称>",
                     "augustus_model"     : "../../data/augustus/species/<species_name>/",
                     "chromosome_pattern" : "<short_name>_(%d+)"
                  }

8. 最后，切换到<new_data_dir>/references目录（必须在此目录中执行以下命令）并运行../../bin/update_references.lua，这将写入<new_data_dir>/references/references.json文件。

6. 运行管道

以下命令（将my-companion-project替换为你选择的项目目录名称）将启动注释运行：

nextflow run my-companion-project -profile docker

更多技术信息

依赖

Companion有以下依赖：

• https://openjdk.java.net/ 8或更高版本
• http://nextflow.io
• https://www.docker.com/%EF%BC%88%E8%8B%A5%E4%BD%BF%E7%94%A8Docker%E9%95%9C%E5%83%8F%E6%BB%A1%E8%B6%B3%E4%BE%9D%E8%B5%96%EF%BC%89

Java

检查是否安装Java及版本：java -version（Java 8版本号为1.8，Java9为1.9等）
Ubuntu/Debian安装：apt-get install openjdk-8-jre
Fedora/Centos/Red Hat安装：yum install java-1.8.0-openjdk

Nextflow

安装：curl -fsSL get.nextflow.io | bash
移动到合适目录：mv nextflow /usr/local/bin/
检查路径：which nextflow

Docker

若使用Docker镜像（推荐），则需要Docker。安装指南见： https://docs.docker.com/install/linux/docker-ce/ubuntu/%E3%80%81 https://docs.docker.com/install/linux/docker-ce/centos/%E3%80%81 https://docs.docker.com/install/linux/docker-ce/debian/%E6%88%96 https://docs.docker.com/install/linux/docker-ce/fedora/%E3%80%82
将用户添加到docker组：usermod -aG docker <username>

安装

安装Companion的方法有多种，以下是使用Docker的安装细节：
拉取Docker镜像：docker pull docker.xuanyuan.run/sangerpathogens/companion

使用

Companion本地副本

创建本地副本：

curl -L -o companion-master.zip https://github.com/sanger-pathogens/companion/archive/master.zip  
unzip companion-master.zip  
mv companion-master my-companion-project  

运行测试：nextflow run my-companion-project -profile docker

直接从仓库运行Companion

从GitHub仓库运行：nextflow run sanger-pathogens/companion -profile docker
Nextflow会将仓库内容存储在.nextflow/assets/sanger-pathogens目录。

准备参考注释

更多准备参考数据的文档见https://github.com/sanger-pathogens/companion/wiki/Preparing-reference-data-sets%E3%80%82

许可证

Companion是免费软件，基于https://github.com/sanger-pathogens/companion/blob/master/LICENSE%E8%AE%B8%E5%8F%AF%E8%AF%81%E3%80%82

反馈/问题

请向https://github.com/sanger-pathogens/companion/issues%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E6%88%96%E5%8F%91%E9%80%81%E9%82%AE%E4%BB%B6%E8%87%B3***%E3%80%82

引用

若使用该软件，请引用：
Companion: a web server for annotation and analysis of parasite genomes.
Steinbiss S, Silva-Franco F, Brunk B, Foth B, Hertz-Fowler C et al.
Nucleic Acids Research, 44:W29-W34, 2016.
DOI: http://dx.doi.org/10.1093/nar/gkw292