开源项目 Picard 使用指南

1. 项目目录结构及介绍

Picard 是一个专为处理高通量测序（High-Throughput Sequencing, HTS）数据设计的工具集，它以Java命令行形式提供。以下是对Picard项目在GitHub上的大致目录结构的概述：

• src: 包含所有源代码文件。
  • main: 项目的主要源代码，分为不同的包如picard, picard.cmdline等，用于存放核心逻辑和命令行接口实现。
  • test: 单元测试相关的代码和资源。
• docs: 文档相关资料，可能包括API文档、用户手册或者开发指引。
• scripts: 可能包含一些脚本文件，用于自动化构建或辅助任务。
• LICENSE: 项目使用的开放源代码许可协议，MIT License。
• README.md: 项目的快速入门指南和基本信息描述。
• BUILDING.md: 详细的构建项目指导，对于开发者非常重要。
• (picard.jar): 在最新发布的版本中，你会找到这个jar文件，它是Picard工具的可执行文件，用户主要通过这个文件来运行命令。

2. 项目的启动文件介绍

启动文件主要是指picard.jar。要使用Picard工具，用户无需编译源代码，而是直接通过Java运行这个jar文件。启动基本命令格式如下：

java -jar picard.jar <COMMAND> [OPTIONS]

其中，<COMMAND>是你要执行的具体操作，比如MarkDuplicates, SortSam等，而[OPTIONS]则是根据不同命令需要指定的参数和选项。

3. 项目的配置文件介绍

Picard本身并不依赖于一个集中式的配置文件进行日常操作。其配置主要通过命令行参数传递。每个工具都有特定的输入输出参数和可选设置，这些通常在执行具体命令时指定。例如，当使用MarkDuplicates时，你可能会指定输入BAM文件(I=), 输出文件路径(O=), 和是否计算校正指标(M=)等。

然而，对于复杂的流水线或是需要重复使用相同参数集的场景，用户可以通过创建脚本或使用环境变量的方式来“配置”这些常用参数，但这不是Picard内置的功能，而是用户自定义的做法。

为了更好地利用Picard，建议查看每个工具的详细帮助文档，这可以通过在命令行中执行java -jar picard.jar <COMMAND> --help获得。这样做可以获取到所有可用选项的完整列表以及它们的用途说明。

请注意，确保你的系统已安装Java 1.8或更高版本，这是运行Picard的必要条件。此外，熟悉SAM/BAM/CRAM和VCF文件格式对有效使用Picard工具非常关键。