IGV.js

IGV.js

igv.js 是由 Integrative Genomics Viewer (IGV) 团队开发的嵌入式交互式基因组可视化组件。

引用 igv.js

James T Robinson、Helga Thorvaldsdottir、Douglass Turner、Jill P Mesirov、igv.js：综合基因组查看器 (IGV) 的可嵌入 JavaScript 实现，生物信息学，第 39 卷，第 1 期，2023 年 1 月，btac830，https://doi。 org/10.1093/生物信息学/btac830

以下是示例和快速入门指南。 有关更多文档，请参阅开发人员文档。

示例

路线

互动

拷贝数

多个地区

突变注释格式 (MAF)

多种颜色选择

更多的

快速入门

安装

igv.js 由单个 javascript 文件组成，没有外部依赖项。

脚本包含、AMD 或 CJS 模块系统 (igv.min.js) 和 ES6 模块 (igv.esm.min.js) 的预构建文件可以从 https://cdn.jsdelivr.net/npm/ 下载[email protected]/dist/。

将 igv 作为 ES6 模块导入

从“https://cdn.jsdelivr.net/npm/[email protected]/dist/igv.esm.min.js”导入 igv

或者作为脚本包含（定义“igv”全局）

或者你可以使用 npm 安装

npm install igv

并在 node_modules/igv/dist 中为您的模块系统（igv.min.js 或 igv.esm.min.js）获取适当的文件。

用法

要创建 igv.js浏览器，请向函数igv.createBrowser(div, config)提供容器 div 和定义参考基因组、初始轨迹和其他状态的初始配置。

该函数返回一个 igv.Browser 对象的承诺，该对象可用于控制浏览器。 例如，要在特定位置打开的单个对齐轨道上打开浏览器：

      var igvDiv = document.getElementById("igv-div");
      var options =
        {
            genome: "hg38",
            locus: "chr8:127,736,588-127,739,371",
            tracks: [
                {
                    "name": "HG00103",
                    "url": "https://s3.amazonaws.com/1000genomes/data/HG00103/alignment/HG00103.alt_bwamem_GRCh38DH.20150718.GBR.low_coverage.cram",
                    "indexURL": "https://s3.amazonaws.com/1000genomes/data/HG00103/alignment/HG00103.alt_bwamem_GRCh38DH.20150718.GBR.low_coverage.cram.crai",
                    "format": "cram"
                }
            ]
        };

        igv.createBrowser(igvDiv, options)
                .then(function (browser) {
                    console.log("Created IGV browser");
                })

文档

igv.js API 的完整文档位于 https://igv.org/doc/igvjs/。

发展

要求

构建 igv.js 并运行示例需要 Linux 或 MacOS。 其他 Unix 环境可能也可以工作，但尚未经过测试。

Windows 用户可以使用适用于 Linux 的 Windows 子系统。

建筑

构建 igv.js 并运行示例需要 node.js。

git clone https://github.com/igvteam/igv.js.git
cd igv.js
npm install
npm run build

这将创建一个包含以下文件的 dist 文件夹

• igv.js - 脚本包含、AMD 或 CJS 模块的 UMDS 文件。 脚本包含将定义一个“igv”全局。

• igv.min.js - igv.js 的缩小版本

• igv.esm.js -- ES6 模块

• igv.esm.min.js -- igv.esm.js 的缩小版本

测试

从命令行运行测试

npm run test

示例

要运行示例，请安装 http-server。

从项目根目录启动http-server

 npx http 服务器

然后在 Web 浏览器中打开 http://localhost:8080/examples。

支持的浏览器

igv.js 需要支持 Javascript ECMAScript 2015 (ES6) 的现代 Web 浏览器。

执照

igv.js 已获得 MIT 许可。

发行说明