GATK 4 开源项目安装与使用教程
1. 目录结构及介绍
GATK(Genome Analysis Toolkit)版本4及其以上,存储在GitHub仓库中,地址为https://github.com/broadinstitute/gatk.git。本项目遵循清晰的结构设计,以支持高效的基因组数据处理。以下是主要目录和它们的简要说明:
-
根目录:
AUTHORS
: 作者列表。CODE_OF_CONDUCT.md
: 项目的行为准则。Dockerfile
,.yml
相关文件: 用于构建和运行Docker容器的配置。LICENSE.TXT
: 许可证信息,表明采用Apache 2.0许可证。README.md
: 项目的主要读我文件,包含快速入门指南和重要链接。
-
src: 源代码核心部分,分为不同子目录,如Java源码位于
src/main/java
下。scripts
: 脚本文件集合,可能包括辅助工具或启动脚本。resources_for_CI
: 针对持续集成的资源文件。- 其他如
gradle
相关的构建脚本等。
-
build.gradle,
settings.gradle
,gradlew
: Gradle构建系统的关键文件,用于编译、测试和打包项目。 -
*git`: 相关Git配置和忽略文件,保证开发流程的一致性。
2. 启动文件介绍
GATK不是一个传统意义上的“启动”应用,而是一套命令行工具集。其运行依赖于Gradle进行构建后,通过执行.gradlew
脚本下的任务或者直接调用生成的二进制可执行文件来进行。最常见的启动交互是通过命令行调用gatk
命令,例如,通过以下步骤:
- 构建项目:
./gradlew bundle
,这将在build/
目录下生成可用于运行的ZIP文件。 - 运行GATK工具:通过指定工具名及参数,例如
./gatk PrintReads ...
来执行具体任务。
3. 配置文件介绍
GATK的配置更多地体现在环境配置和特定工具的参数传递上,而非传统的单一配置文件。对于环境配置,特别是Python依赖和R依赖,推荐使用Conda环境(特别是通过GATK提供的gatkcondaenv.yml
文件),该配置确保了所有必要的Python和R包被正确安装。在构建和运行GATK时,虽然不需要手动编辑特定的配置文件,但可以通过以下方式调整行为:
- 环境变量:可以设置一些环境变量来影响GATK的运行,比如指向外部资源的路径。
- JVM选项:通过向
gatk
命令传递-Dkey=value
参数来传递给Java虚拟机。 - 工具参数:每个工具都有自己的参数集,这些参数在运行时通过命令行直接指定,实现配置和定制功能。
总结,GATK 4的使用更侧重于命令行操作和环境准备,而不是通过直接编辑配置文件。用户需关注的是正确安装依赖、理解和利用GATK丰富的命令行接口以及相应的工具参数。