immcantation/base

Immcantation Docker镜像文档

!Docker Pulls !AIRR-C sw-tools v1 compliant !Contributor Covenant

镜像概述和主要用途

Immcantation是一个用于高通量适应性免疫受体测序(AIRR-seq)数据集的完整分析生态系统。该框架专注于B细胞受体(BCR)分析，但方法也适用于T细胞受体(TCR)。从原始读取开始，提供了用于预处理、种群结构确定和谱系分析的Python和R包。

本Docker镜像提供了Immcantation框架、其依赖项、辅助脚本和IgBLAST的完整安装，是Immcantation开发构建的基础镜像。

核心功能和特性

• 完整集成Immcantation分析框架及其所有依赖项
• 包含IgBLAST和IMGT参考种系集
• 内置多个示例管道脚本
• 提供辅助脚本，支持IMGT、IgBLAST和VDJTools分析
• 符合AIRR-C sw-tools v1标准

使用场景和适用范围

• 高通量B细胞受体(BCR)测序数据分析
• T细胞受体(TCR)测序数据分析
• 适应性免疫受体谱系(AIRR)的系统性分析
• 从原始测序数据到结果可视化的完整分析流程

详细使用方法和配置说明

镜像获取

Immcantation镜像可从Docker Hub获取，通过标签进行版本控制：

bash
# 拉取指定版本(推荐)
docker pull immcantation/suite:<tag>

# 拉取开发版本
docker pull immcantation/suite:devel

注意：latest标签不可用，必须指定具体版本标签或使用devel标签。官方发布版本使用元版本号标签(如1.0.0)。

基本使用方法

bash
# 交互式运行容器
docker run -it --rm immcantation/suite:<tag> /bin/bash

# 运行示例管道脚本
docker run --rm immcantation/suite:<tag> /opt/immcantation/pipelines/example_pipeline.sh

数据持久化

为了保存分析结果，建议挂载本地目录到容器中：

bash
docker run -it --rm -v /本地/data目录:/data immcantation/suite:<tag> /bin/bash

仓库迁移说明

重要提示！ Immcantation已迁移至新仓库：https://github.com/immcantation/immcantation

如需更新Git配置设置，请使用：

bash
git config user.email "your-gh-user@email.com"
git config user.name "your-gh-user-name"
git remote set-url origin git@github.com:immcantation/immcantation.git

目录结构说明

容器内Immcantation框架的主要目录结构如下：

文档和资源

完整的使用文档、API文档和多个教程可在以下位置找到：

• Immcantation文档门户：[***]
• Docker Hub镜像页面：https://hub.docker.com/r/immcantation/suite
• GitHub代码仓库：https://github.com/immcantation/immcantation

docker-compose配置示例

yaml
version: '3'
services:
  immcantation:
    image: immcantation/suite:<tag>
    volumes:
      - ./data:/data
      - ./results:/results
    working_dir: /data
    command: /opt/immcantation/pipelines/run_analysis.sh /data/input.fastq /results/output

将上述内容保存为docker-compose.yml文件，然后运行：

bash
docker-compose up