staphb/samtools

StaPH-B Docker镜像集合文档

1. 镜像概述和主要用途

StaPH-B（State Public Health Lab Bioinformatics，州公共卫生实验室生物信息学联盟）维护的docker-builds仓库提供了一系列生物信息学工具的Docker镜像。该项目旨在为公共卫生领域的研究人员和实验室提供集中化、易于访问的Docker镜像资源，包含详细的构建说明和使用文档，确保工具部署的一致性和可重复性。这些镜像广泛应用于病原体基因组监测（如SARS-CoV-2）、 antimicrobial resistance (AMR) 分析、基因组组装与注释等公共卫生关键场景。

2. 核心功能和特性

2.1 集中化镜像管理

• 统一维护公共卫生领域常用生物信息学工具的Dockerfile及构建脚本，确保镜像质量和一致性。
• 提供详细的镜像文档，包括工具用途、版本信息及原始项目链接。

2.2 多仓库托管与同步

• 镜像同时托管于两个平台，支持灵活选择：
  • Dockerhub：https://hub.docker.com/r/staphb/
  • Quay.io：https://quay.io/organization/staphb/
• 定期同步两个仓库的镜像，确保可用性。

2.3 无拉取限制

• 已通过Docker "Open Source Program"认证，所有staphb镜像不受Dockerhub***用户拉取限制（如100次/6小时）影响。若遇到toomanyrequests错误，可提交issue反馈。

2.4 跨平台兼容性

• 所有镜像均兼容Singularity，支持无法使用Docker的环境（如HPC集群），可通过简单转换命令使用。

2.5 版本多样性

• 针对同一工具提供多个稳定版本（如FastQC包含0.11.8、0.11.9等），满足不同分析流程的依赖需求。

3. 使用场景和适用范围

3.1 主要应用场景

• 病原体基因组监测：如SARS-CoV-2变异株分型（Pangolin）、进化分析（Augur、Auspice）、病毒载量估计（Freyja）。
• 细菌基因组分析：耐药基因检测（ABRicate、NCBI AMRFinderPlus）、多位点序列分型（MLST）、基因组组装（Flye、Canu）。
• 测序数据质控与处理：原始数据质控（FastQC）、序列比对（BWA、bowtie2）、变异检测（bcftools、ivar）。
• 公共卫生实验室标准化流程：提供预配置的工具环境，减少实验室间工具部署差异，提升结果可比性。

3.2 适用用户

• 公共卫生实验室技术人员
• 病原体基因组学研究人员
• 生物信息学流程开发人员

4. 使用方法和配置说明

4.1 镜像获取

4.1.1 从Dockerhub获取

StaPH-B镜像在Dockerhub的命名空间为staphb/，可通过以下命令拉取：

bash
# 拉取指定工具和版本（以FastQC 0.11.9为例）
docker pull docker.xuanyuan.run/staphb/fastqc:0.11.9

# 拉取最新版本（若未指定版本标签，默认latest）
docker pull docker.xuanyuan.run/staphb/fastqc

4.1.2 从Quay.io获取

镜像同时同步至Quay.io的staphb组织，拉取命令类似：

bash
docker pull ***-quay.xuanyuan.run/staphb/fastqc:0.11.9

4.2 基本使用示例

以FastQC（测序数据质控工具）为例，展示容器运行方法：

4.2.1 查看工具帮助

bash
docker run --rm docker.xuanyuan.run/staphb/fastqc:0.11.9 fastqc --help

4.2.2 处理本地数据（挂载宿主机目录）

将宿主机的/path/to/fastq目录挂载到容器内的/data，并对sample.fastq.gz进行质控：

bash
docker run --rm -v /path/to/fastq:/data docker.xuanyuan.run/staphb/fastqc:0.11.9 fastqc /data/sample.fastq.gz -o /data/output

• --rm：容器运行后自动删除
• -v /path/to/fastq:/data：将宿主机目录挂载到容器内，实现数据共享
• -o /data/output：指定输出目录（需在宿主机/path/to/fastq下提前创建output文件夹）

4.3 Singularity兼容性

对于不支持Docker的环境（如HPC），可将Docker镜像转换为Singularity格式：

4.3.1 直接从Dockerhub拉取并转换

bash
singularity pull docker://staphb/fastqc:0.11.9

4.3.2 运行Singularity容器

bash
singularity run fastqc_0.11.9.sif fastqc sample.fastq.gz -o output

4.4 配置说明

• 数据持久化：通过-v参数挂载宿主机目录，避免容器内数据丢失。
• 性能优化：对计算密集型工具（如Flye、Canu），可通过--cpus和--memory限制资源使用：

  bash
  docker run --rm -v /data:/data --cpus 8 --memory 32g docker.xuanyuan.run/staphb/flye:2.9 flye --threads 8 --genome-size 5m /data/reads.fastq -o /data/assembly
  

5. 可用镜像列表

6. 贡献与反馈

6.1 贡献指南

若需添加新镜像或改进现有镜像，可通过以下流程贡献：

1. Fork https://github.com/StaPH-B/docker-builds%E4%BB%93%E5%BA%93
2. 创建分支并修改/添加Dockerfile及文档
3. 提交Pull Request

6.2 问题反馈

如遇镜像使用问题（如拉取失败、功能异常），请在GitHub仓库提交issue：
https://github.com/StaPH-B/docker-builds/issues

7. 注意事项

• 拉取限制：StaPH-B镜像已通过Docker Open Source Program认证，无拉取次数限制。若遇到toomanyrequests错误，请提交issue反馈。
• 版本选择：建议明确指定版本标签（如:0.11.9），避免因latest标签更新导致流程不稳定。
• 数据安全：处理敏感数据时，确保容器运行环境符合数据管理规范，避免未授权访问。