bromberglab/mifaser

mi-faser

宏基因组 - 测序读段功能注释

mi-faser是一款超快速（<20分钟/10GB读取）且高精度（>90%准确率）的工具，用于注释测序读段数据中编码的分子功能，无需进行组装或基因查找。

Web服务： [***]
Docker镜像： 预构建镜像可从 https://hub.docker.com/r/bromberglab/mifaser 获取

概述

mi-faser专为宏基因组研究设计，能够直接对原始测序读段进行功能注释，避免了传统方法中耗时的组装和基因预测步骤。其核心优势在于极高的速度和准确性，可广泛应用于环境微生物组、宿主相关微生物组等领域的功能分析。

核心功能与特性

• 超快速分析：处理10GB测序数据仅需不到20分钟
• 高精度注释：准确率超过90%
• 无需预处理：直接分析原始测序读段，无需组装或基因查找
• 多平台支持：兼容Linux、MacOSX和Windows系统
• 灵活输入：支持本地文件、HTTP/HTTPS/FTP链接及SRA登录号（sra:<accession_id>）
• 内置参考数据库：包含手动 curated 的GS和GS+蛋白质功能数据库

系统要求与依赖

支持系统

Linux、MacOSX、Windows

依赖项

• Python ≥ 3.6
• DIAMOND ≥ 0.8.8（已包含；源码：https://github.com/bbuchfink/diamond%EF%BC%89
• Windows：需安装Visual C++ Redistributable

注意：mi-faser在v1.11.4及之前版本中包含DIAMOND v0.8.8（与相关文献[1]一致），更新版本使用最新稳定版DIAMOND。建议始终使用最新版DIAMOND以提升速度、内存效率并修复bug（详见“DIAMOND升级”章节）。

参考数据库

mi-faser基于手动 curated 的蛋白质功能参考数据库（GS数据库；DOI: 10.5281/zenodo.***）开发。v1.5及以上版本新增GS+数据库，扩展了55个手动 curated 蛋白质序列，新增28个代表环境微生物重要功能的EC编号。

安装方法

Docker（推荐）

预构建Docker镜像是本地或云环境中运行mi-faser的最便捷方式，需挂载工作目录到容器中。

基本用法

bash
docker run --rm \
    -v <本地输入目录>:/input \
    -v <本地输出目录>:/output \
    bromberglab/mifaser -f <输入文件>

参数说明

• <本地输入目录>：宿主机中存放输入文件的目录，挂载到容器内/input
• <本地输出目录>：宿主机中接收输出结果的目录，挂载到容器内/output
• <输入文件>：位于<本地输入目录>的有效mi-faser输入文件，容器内路径相对于/input

使用方法

运行模式

单端模式（Single）

输入单个测序文件、HTTP/HTTPS/FTP链接或SRA登录号：

bash
mifaser -f/--inputfile <输入文件>

双端模式（2-Lane）

输入两个文件（R1/R2）、链接或SRA登录号：

bash
mifaser -l/--lanes <R1文件> <R2文件>

命令行界面（CLI）

帮助信息

bash
usage: mifaser [-h] [-f INPUTFILE] [-l R1 R2] [-o OUTPUTFOLDER]
               [-d DATABASEFOLDER] [-i DIAMONDFOLDER] [-m] [-s SPLIT]
               [-S [SPLITMB]] [-t THREADS] [-c CPU] [-p] [-n] [-u UPDATE]
               [-D [arg [arg ...]]] [-v] [-q] [--version]

mi-faser，宏基因组 - 测序读段功能注释  

一款超快速（<10分钟/10GB读取）且高精度（>90%准确率）的工具，无需组装或基因查找即可注释测序读段数据中的分子功能。  

公共Web服务：https://services.bromberglab.org/mifaser  

版本：1.60 [03/23/20]

可选参数:
  -h, --help            显示帮助信息并退出
  -f INPUTFILE, --inputfile INPUTFILE
                        输入DNA读段文件、HTTP/HTTPS/FTP链接或SRA登录号（sra:<id>）
  -l R1 R2, --lanes R1 R2
                        双端模式（R1/R2）文件、链接或SRA登录号（sra:<id_1> sra:<id_2>）
  -o OUTPUTFOLDER, --outputfolder OUTPUTFOLDER
                        输出文件夹路径；默认：INPUTFILE_out
  -d DATABASEFOLDER, --databasefolder DATABASEFOLDER
                        数据库名称（位于database/目录）或数据库文件绝对路径
  -i DIAMONDFOLDER, --diamondfolder DIAMONDFOLDER
                        DIAMOND可执行文件所在文件夹路径
  -m, --mapping         生成所有读段映射结果（reads{n=*} -> EC{n=1}, fasta格式）
  -s SPLIT, --split SPLIT
                        按序列数拆分输入；默认：100k；0表示不拆分
  -S [SPLITMB], --splitmb [SPLITMB]
                        按大小（MB）拆分输入；默认：25；（需GNU Coreutils的split工具）
  -t THREADS, --threads THREADS
                        线程数；默认：1
  -c CPU, --cpu CPU     每线程最大CPU数；默认：所有可用CPU
  -p, --preserve        保留中间结果
  -n, --no-check        跳过DIAMOND数据库与二进制文件兼容性检查
  -u UPDATE, --update UPDATE
                        更新命令：{ diamond[:版本号] }
  -D [arg [arg ...]], --createdb [arg [arg ...]]
                        创建参考数据库：<数据库名称> <序列文件.fasta> [merge_db=<待合并数据库名称>] [update_ec_annotations=<1|0>; 默认：0]
  -v, --verbose         设置详细输出级别；默认：INFO
  -q, --quiet           控制台输出重定向到日志文件
  --version             显示版本号并退出

示例

测试数据集验证

使用内置测试数据集（10k读段）验证安装：

bash
mifaser -f mifaser/files/test/artificial_mg.fasta -o mifaser/files/test/out

结果将保存在mifaser/files/test/out/目录下。

DIAMOND升级

通过以下命令升级（或降级）DIAMOND至指定版本（默认最新版）：

bash
mifaser --update diamond[:<DIAMOND版本号>]

创建参考数据库

步骤

1. 准备蛋白质序列文件（multi-FASTA格式），序列头格式为：
   >id|注释|e.c.-编号|附加信息

   示例（sequences.fasta）：

   fasta
   >id|annotation|e.c.-number|additional_details
   MKPNTDFMLIADGAKVLTQGNLTEHCAIEVSDGIICGLKSTISAEWTADKPHYRLTSGTL
   VAGFIDTQVNGGGGLMFNHVPTLETLRLMMQAHRQFGTTAMLPTVITDDIEVMQAAADAV
   AEAIDCQVPGIIGIHFEG
   >id|annotation|e.c.-number|additional_details
   MYYGLDIGGTKIELAIFDTQLALQDKWRLSTPGQDYSAFMATLAEQIEKADQQCGERGTV
   GIALPGVVKADGTVISSNVPCLNQRRVAHDLAQLLNRTVAIGNDCRCFALSEAVLGVGRG
   YSRVLGMI
   

2. 运行创建命令：

   bash
   mifaser -D <数据库名称> path/to/sequences.fasta
   

3. 使用新数据库：

   bash
   mifaser -d <数据库名称> -f <输入文件> -o <输出目录>
   

许可证

本项目采用 NPOSL-3.0 许可证。

引用

若在研究中使用mi-faser，请引用：
Zhu, C., Miller, M., ... Bromberg, Y. (2017). Functional sequencing read annotation for high precision microbiome analysis. Nucleic Acids Res. doi:10.1093/nar/gkx1209

关于

mi-faser由Chengsheng Zhu和Maximilian Miller开发。如有支持需求，请联系：***。