VarDictJava 开源项目使用教程

VarDictJava 开源项目使用教程

VarDictJava VarDict Java port 项目地址: https://gitcode.com/gh_mirrors/va/VarDictJava

1. 项目的目录结构及介绍

VarDictJava 是一个基于 Java 和 Perl 编写的变异发现程序，是 VarDict 变异调用器的 Java 端口版本。项目目录结构如下：

• bin/：包含启动脚本。
• build/：构建过程中生成的文件，包括可执行文件和文档。
• dist/：构建生成的发布包，包括 tar 和 zip 格式。
• gradle/：包含 Gradle 配置文件。
• src/：源代码目录，包含 Java 源文件。
• testdata/：测试数据。
• tests/：集成测试代码。
• var2vcf/：Perl 脚本，用于将 VarDict 输出转换为 VCF 格式。
• .gitignore：指定 Git 忽略的文件。
• .gitmodules：定义 Git 子模块。
• .java-version：指定项目使用的 Java 版本。
• .travis.yml：Travis CI 配置文件。
• LICENSE：项目许可证文件。
• README.md：项目自述文件。
• build.gradle：Gradle 构建脚本。
• changelog.txt：项目更新日志。
• gradlew：Gradle 包装器脚本。
• gradlew.bat：Windows 系统下的 Gradle 包装器脚本。
• settings.gradle：Gradle 设置文件。

2. 项目的启动文件介绍

项目的启动文件位于 build/install/VarDict/bin/ 目录下，主要包含以下文件：

• VarDict：VarDictJava 的启动脚本，用于运行程序。

启动脚本使用方法示例：

/path/to/VarDict/build/install/VarDict/bin/VarDict -H

该命令将显示帮助信息。

3. 项目的配置文件介绍

VarDictJava 使用 Gradle 作为构建工具，因此主要的配置文件是 build.gradle。以下是 build.gradle 文件的一些关键部分：

• java { ... }：Java 插件配置，包括 Java 版本和编译选项。
• dependencies { ... }：项目依赖配置，包括第三方库。
• jar { ... }：JAR 文件打包配置。
• distZip { ... } 和 distTar { ... }：生成发布包的配置。

要构建项目，需要在项目根目录下运行以下命令：

./gradlew clean installDist

此命令将执行清理操作并构建项目，生成的文件将位于 build/install/VarDict/ 目录下。

此外，VarDictJava 还使用了一些 Perl 脚本进行数据处理，这些脚本的配置通常在脚本自身中指定，例如 teststrandbias.R、var2vcf_valid.pl 等。

通过上述教程，用户可以了解到 VarDictJava 的目录结构、如何启动项目以及如何配置项目。

VarDictJava VarDict Java port 项目地址: https://gitcode.com/gh_mirrors/va/VarDictJava