staphb/multiqc

MultiQC Docker镜像文档

镜像概述和主要用途

MultiQC Docker镜像是StaPH-B（州公共卫生实验室生物信息学）联盟维护的docker-builds仓库中的一员，用于将多个样本的生物信息学分析结果聚合为单个交互式报告。该镜像封装了MultiQC工具，旨在简化多样本分析结果的整合与可视化，方便用户快速 overview 实验数据质量和分析结果。

核心功能和特性

• 结果聚合：支持整合多种生物信息学工具（如FastQC、Samtools、BWA、Bowtie等）的输出结果
• 多样本处理：可同时分析多个样本的数据，自动识别并汇总结果
• 交互式报告：生成HTML格式的交互式报告，包含统计图表和质量指标
• 版本支持：提供1.7和1.8两个稳定版本，满足不同分析需求
• 轻量便捷：通过Docker容器化部署，无需复杂环境配置，确保跨平台一致性

使用场景和适用范围

适用于高通量测序数据分析流程中的结果汇总环节，特别适合：

• 微生物基因组学研究中的多样本质量控制报告生成
• 公共卫生实验室的批量样本检测结果整理
• 生物信息学 pipeline 中自动化报告生成步骤
• 需要快速比较多个样本分析结果的场景

详细使用方法和配置说明

前提条件

• 已安装Docker引擎（推荐版本18.09+）
• 本地存储有待分析的生物信息学工具输出文件

获取镜像

从Docker Hub拉取MultiQC镜像：

bash
# 拉取最新版本
docker pull staphb/multiqc

# 或指定版本
docker pull staphb/multiqc:1.8  # 1.8版本
docker pull staphb/multiqc:1.7  # 1.7版本

基本使用方法

将包含分析结果的本地目录挂载到容器中，运行MultiQC生成报告：

bash
docker run --rm -v /path/to/your/results:/data staphb/multiqc multiqc /data

• --rm：容器运行结束后自动清理
• -v /path/to/your/results:/data：将本地结果目录挂载到容器内的/data目录
• multiqc /data：在容器内执行MultiQC，分析/data目录下的所有结果文件

执行成功后，报告文件multiqc_report.html将生成在本地的/path/to/your/results目录中。

高级配置选项

通过命令行参数自定义报告生成：

bash
# 查看所有可用参数
docker run --rm staphb/multiqc multiqc --help

# 指定输出目录和报告名称
docker run --rm -v /path/to/results:/data staphb/multiqc multiqc /data -o /data/reports -n my_report.html

# 强制覆盖现有报告并设置标题
docker run --rm -v /path/to/results:/data staphb/multiqc multiqc /data -f --title "2023年微生物测序项目报告"

常用参数说明：

• -o/--outdir：指定报告输出目录
• -n/--filename：自定义报告文件名
• -f/--force：覆盖已存在的报告文件
• --title：设置报告标题
• --ignore：忽略指定文件或目录

Singularity兼容性

该镜像完全兼容Singularity，适合无Docker权限的HPC环境使用：

bash
# 转换为Singularity镜像
singularity pull docker://staphb/multiqc:1.8

# 运行Singularity容器
singularity run multiqc_1.8.sif multiqc /path/to/your/results

详细转换和使用方法参见https://staph-b.github.io/docker-builds/%E3%80%82

维护与贡献

维护团队

该镜像由StaPH-B联盟成员共同维护，核心维护者包括：

• @kapsakcj、@k-florek、@garfinjm、@kevinlibuit、@lskatz等

问题反馈与贡献

• 发现镜像问题：在https://github.com/StaPH-B/docker-builds%E6%8F%90%E4%BA%A4issue
• 贡献改进：Fork仓库后提交pull request，详见https://staph-b.github.io/docker-builds/contribute/
• 查看完整镜像列表：https://hub.docker.com/r/staphb/

相关资源

• MultiQC官方文档：[***]
• 源代码仓库：https://github.com/ewels/MultiQC
• StaPH-B Docker用户指南：https://staph-b.github.io/docker-builds/