ultimagenomics/trimmer

Trimmer Docker镜像文档

概述

Trimmer是一款用于解析和处理SAM格式读取数据的工具，它根据JSON格式的描述文件，将每个读取分割为不同的段，并对每段执行特定操作（如pass-through、修剪、条形码和适配器匹配等）。处理后的段信息可写入可配置的SAM标签，适用于测序数据的后续分析与处理。

核心功能和特性

• SAM格式解析：支持解析标准SAM格式的读取数据
• 段分割与操作：根据JSON描述文件将读取分割为多个段，并对每段执行以下操作：
  • pass-through（直接通过段）
  • 修剪（Trimming）
  • 条形码（Barcode）匹配
  • 适配器（Adapter）匹配
• SAM标签写入：段相关信息可写入用户配置的SAM标签，便于后续数据分析追踪

使用场景

• SAM格式测序数据的标准化处理
• 读取序列的定向修剪（如去除冗余序列）
• 条形码或适配器序列的识别与去除
• 测序读取中不同功能段的标记与信息提取

使用方法和配置说明

获取Trimmer Docker镜像

拉取镜像

使用以下命令从Docker Hub拉取Trimmer镜像：

bash
$ docker pull ultimagenomics/trimmer

重命名镜像（可选）

为简化后续命令，可将镜像重命名为较短的名称（如下例中的trimmer）：

bash
$ docker tag ultimagenomics/trimmer trimmer

运行容器

Trimmer可执行文件已加入镜像的环境变量PATH，可直接通过命令行调用。

基本调用：查看版本

验证镜像是否正常工作，查看Trimmer版本：

bash
$ docker run --rm trimmer trimmer --version
trimmer: 5.2.0 2f06933+ 2024-02-07 14:39:18+0000

注：--rm参数会在容器退出后自动删除容器。

查看容器内README

容器工作目录中包含完整的README.md文件，可通过命令行Markdown查看器（如mdless）查看：

bash
$ docker run --rm trimmer cat README.md | mdless

提示：README中包含JSON格式描述文件的创建指南（如“Example Formats”部分），建议先查看以创建符合要求的格式文件。

挂载外部格式文件

若需使用容器外部的JSON格式描述文件，需通过卷挂载文件所在目录，并使用-i标志。以下示例将本地formats目录挂载到容器/mnt/formats，并指定JSON描述文件路径：

bash
$ docker run --rm -v ./formats:/mnt/formats -i trimmer trimmer --desc /mnt/formats/formats.json --format "no trimming" < input.sam > out.sam

以当前用户身份处理数据文件

为避免文件权限问题，可挂载本地数据目录并以当前用户身份运行容器。以下示例将./data目录挂载到容器/data，并指定输入输出文件路径：

bash
$ docker run --rm -v ./formats:/mnt/formats -v ./data:/data --user $(id -u):$(id -g) trimmer trimmer --desc /mnt/formats/formats.json --format "no trimming" --input /data/input.sam --output /data/out.sam

进入容器内部操作

若需在容器内进行交互式操作，可通过-it参数进入bash终端：

bash
$ docker run -it --rm -v ./formats:/mnt/formats -v ./data:/data --user $(id -u):$(id -g) trimmer bash

# 在容器内执行Trimmer命令
trimmer --version
trimmer --desc /mnt/formats/formats.json --format "no trimming" --input /data/input.sam --output /data/out.sam

注意事项

原Trimmer文档中的示例命令直接调用可执行文件，使用Docker镜像时需按上述方法修改命令（如添加卷挂载、用户指定等）。