jigv 项目使用教程

jigv 项目使用教程

项目介绍

jigv 是一个基于 igv.js 的独立页面生成器，用于自动配置和查看 BAM/CRAM/VCF/BED 文件。它能够在不到一分钟的时间内生成一个包含基因组数据的交互式页面。jigv 通过将所有变体、对齐和注释编码到一个单一的 HTML 页面中，简化了基因组数据的展示和共享。

项目快速启动

安装

首先，确保你已经安装了 Git 和 Nim 编程语言。然后，通过以下命令克隆项目并安装依赖：

git clone https://github.com/brentp/jigv.git
cd jigv
nimble install

生成 HTML 页面

使用以下命令生成包含基因组数据的 HTML 页面：

jigv --fasta path/to/fasta --sites "chr1:3453454-3453554" --annotation path/to/annotation.bed.gz > output.html

查看生成的页面

将生成的 output.html 文件在浏览器中打开，即可查看基因组数据。

应用案例和最佳实践

案例一：展示单个变体

假设你有一个变体位于 chr1:3453454-3453554，你可以使用以下命令生成一个包含该变体的 HTML 页面：

jigv --fasta path/to/fasta --sites "chr1:3453454-3453554" > variant.html

案例二：展示多个变体

如果你有多个变体需要展示，可以使用以下命令：

jigv --fasta path/to/fasta --sites "chr1:3453454-3453554" "chr2:1234567-1234667" > variants.html

最佳实践

• 确保输入的 FASTA 文件已索引。
• 使用 --annotation 参数添加额外的注释信息。
• 对于大量变体，考虑使用 --prefix 参数将数据分割到多个文件中。

典型生态项目

igv.js

igv.js 是一个用于展示基因组数据的 JavaScript 库，jigv 基于此库构建，提供了更简便的页面生成和配置方式。

igv-reports

igv-reports 是 IGV 团队开发的另一个项目，用于生成包含基因组数据的报告。jigv 在此基础上增加了对家系图谱的支持和其他功能。

通过以上教程，你可以快速上手 jigv 项目，并利用它生成和分享基因组数据的可视化页面。