broadinstitute/picard

Picard 镜像文档

镜像概述和主要用途

Picard 是一套 Java 命令行工具集，用于处理高通量测序 (HTS) 数据和格式。该工具集基于 HTSJDK Java 库实现，支持处理 SAM、VCF 等高通量测序领域常用的文件格式。自 3.0 版本起，Picard 需要 Java 1.17 或更高版本运行环境。

核心功能和特性

• 提供多种用于高通量测序数据处理的命令行工具
• 基于 HTSJDK 库实现对标准测序文件格式的支持
• 支持通过 Gradle 构建系统进行构建和测试
• 可配置不同版本的 HTSJDK 依赖
• 支持构建包含所有依赖的可执行 Jar 包
• 提供两种命令行解析器（传统解析器和新解析器）

使用场景和适用范围

• 高通量测序数据处理和分析
• 测序文件格式转换与操作
• 生物信息学研究与应用开发
• 基因组数据分析流程集成

详细的使用方法和配置说明

环境要求

• Java 1.17 或更高版本
• Git（用于源码克隆）
• Gradle（可选，项目已包含 gradlew 包装器）

源码获取与构建

克隆代码仓库

bash
git clone https://github.com/broadinstitute/picard.git
cd picard/

构建可执行 Jar 包（包含所有依赖）

bash
./gradlew shadowJar

构建结果位于 build/libs 目录下，可通过以下命令运行：

bash
java -jar build/libs/picard.jar
# 或
java -jar build/libs/picard-<VERSION>-all.jar

构建仅包含 Picard 类的 Jar 包（不含依赖）

bash
./gradlew jar

清理构建目录

bash
./gradlew clean

运行测试

运行所有测试

bash
./gradlew test

运行特定测试

使用传统命令行解析器：

bash
./gradlew legacyTest --tests "*TestClassName*"

使用新解析器：

bash
./gradlew barclayTest --tests "*TestClassName*"

配置 HTSJDK 依赖版本

修改为已发布版本

1. 打开 build.gradle 文件
2. 编辑以下行中的 VERSION 为所需的 HTSJDK 发布版本：

   groovy
   final htsjdkVersion = System.getProperty('htsjdk.version', 'VERSION')
   

3. HTSJDK 发布版本列表可在 https://github.com/samtools/htsjdk/releases 查看

使用自定义 HTSJDK 版本构建

基于 HTSJDK 主分支未发布版本构建

bash
./gradlew shadowJar -Dhtsjdk.version=VERSION

其中 VERSION 为 Broad artifactory 中的快照版本，可在 https://artifactory.broadinstitute.org/artifactory/simple/libs-snapshot-local/com/github/samtools/htsjdk/ 查找。

基于本地 HTSJDK 版本构建

1. 克隆 HTSJDK 仓库并检出所需分支或标签：

   bash
   git clone https://github.com/samtools/htsjdk/
   cd htsjdk/
   git checkout <branch-or-tag>
   

2. 安装 HTSJDK 到本地 Maven 仓库：

   bash
   ./gradlew install printVersion
   

   记录打印的版本号

3. 切换到 Picard 目录，使用本地 HTSJDK 版本构建：

   bash
   cd ../picard/
   ./gradlew shadowJar -Dhtsjdk.version=记录的版本号
   

云存储支持

构建支持云存储的版本：

bash
./gradlew cloudJar

运行支持云存储的工具：

bash
java -jar build/lib/picardcloud.jar <Picard 参数>

示例（使用 Google Cloud Storage）：

bash
java -jar build/lib/picardcloud.jar CrosscheckFingerprints \
   I=gs://sample1.vcf \
   I=gs://sample2.vcf \
   CROSSCHECK_BY=FILE \
   H=Haplotype_db.txt \
   O=crosscheck.out

Docker 部署方案

Dockerfile 示例

dockerfile
FROM openjdk:17-jdk-slim

WORKDIR /picard

# 安装依赖工具
RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*

# 克隆代码仓库
RUN git clone https://github.com/broadinstitute/picard.git .

# 构建可执行 Jar 包
RUN ./gradlew shadowJar

# 设置入口点
ENTRYPOINT ["java", "-jar", "/picard/build/libs/picard.jar"]

使用 docker run 运行

bash
# 构建镜像
docker build -t picard:latest .

# 运行 Picard 工具
docker run --rm -v $(pwd):/data picard:latest <command> [arguments]

# 示例：显示帮助信息
docker run --rm picard:latest --help

# 示例：运行特定工具
docker run --rm -v $(pwd):/data picard:latest CrosscheckFingerprints \
   I=/data/sample1.vcf \
   I=/data/sample2.vcf \
   CROSSCHECK_BY=FILE \
   H=/data/Haplotype_db.txt \
   O=/data/crosscheck.out

docker-compose 配置示例

yaml
version: '3'
services:
  picard:
    build: .
    volumes:
      - ./data:/data
    entrypoint: ["java", "-jar", "/picard/build/libs/picard.jar"]

使用方式：

bash
# 构建服务
docker-compose build

# 运行工具
docker-compose run --rm picard <command> [arguments]

用户支持

用户问题请首先在 https://gatk.broadinstitute.org/hc/en-us/community/topics 中查找答案或提问。

引用说明

使用 Picard 工具发表论文时，请引用此仓库：

"Picard Toolkit." 2019. Broad Institute, GitHub Repository. https://broadinstitute.github.io/picard/; Broad Institute

@misc{Picard2019toolkit,
  title = {Picard toolkit},
  year = {2019},
  publisher = {Broad Institute},
  journal = {Broad Institute, GitHub repository},
  howpublished = {\url{https://broadinstitute.github.io/picard/}}
}

软件注册标识符：(biotools:picard_tools) 或 (RRID:SCR_006525)

版本控制说明

Picard 正在迁移到语义化版本控制。在明确官方 API 定义之前，建议用户假设每个版本都可能包含对公共方法的微小更改。

更多信息请参见 https://broadinstitute.github.io/picard%E3%80%82

依赖项目

• https://github.com/samtools/htsjdk
• https://samtools.github.io/hts-specs/
• https://samtools.github.io/hts-specs/