Slivar 项目教程

Slivar 项目教程

slivargenetic variant expressions, annotation, and filtering for great good.项目地址:https://gitcode.com/gh_mirrors/sl/slivar

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

Slivar 是一个用于快速查询和过滤 VCF 文件的命令行工具集。以下是 Slivar 项目的主要目录结构及其介绍：

slivar/
├── js/
│   ├── slivar-functions.js
│   └── ...
├── tests/
│   ├── ashk-trio.ped
│   └── ...
├── README.md
├── LICENSE
├── Makefile
├── slivar
└── ...

• js/: 包含 Slivar 使用的 JavaScript 函数文件，如 slivar-functions.js。
• tests/: 包含测试文件，如 ashk-trio.ped，用于测试 Slivar 的功能。
• README.md: 项目的介绍文件，包含项目的基本信息和使用说明。
• LICENSE: 项目的开源许可证文件。
• Makefile: 用于构建和测试项目的 Makefile。
• slivar: 项目的启动文件，即 Slivar 的主要可执行文件。

2. 项目的启动文件介绍

Slivar 的启动文件是 slivar，它是一个可执行的二进制文件。该文件是 Slivar 的核心，负责执行各种 VCF 文件的查询和过滤操作。

启动文件的主要功能包括：

• 解析命令行参数
• 加载 JavaScript 函数
• 执行 VCF 文件的查询和过滤操作

使用示例：

./slivar expr --js $SLIVAR_HOME/js/slivar-functions.js -g /fdb/slivar/gnomad.hg38.genomes.v3.fix.zip --vcf sample.vcf --ped sample.ped -o output.vcf

3. 项目的配置文件介绍

Slivar 项目没有传统的配置文件，其配置主要通过命令行参数和环境变量来完成。以下是一些常用的配置方式：

环境变量

• SLIVAR_HOME: 设置 Slivar 的主目录，通常包含 JavaScript 函数文件和其他资源。

命令行参数

• --js: 指定 JavaScript 函数文件的路径。
• --vcf: 指定输入的 VCF 文件路径。
• --ped: 指定 PED 文件路径，用于定义家系信息。
• --g: 指定 GnomAD 注释文件的路径。
• -o: 指定输出文件的路径。

示例：

export SLIVAR_HOME=/path/to/slivar
./slivar expr --js $SLIVAR_HOME/js/slivar-functions.js -g /fdb/slivar/gnomad.hg38.genomes.v3.fix.zip --vcf sample.vcf --ped sample.ped -o output.vcf

通过以上配置，可以灵活地使用 Slivar 进行 VCF 文件的查询和过滤操作。

slivargenetic variant expressions, annotation, and filtering for great good.项目地址:https://gitcode.com/gh_mirrors/sl/slivar