-
Notifications
You must be signed in to change notification settings - Fork 229
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,40 +8,44 @@ | |
igv.js is an embeddable interactive genome visualization component developed by the | ||
[Integrative Genomics Viewer (IGV)](https://igv.org) team. | ||
|
||
Below are examples and a quickstart guide. | ||
See the [Wiki](https://github.com/igvteam/igv.js/wiki) for more documentation. | ||
Below are examples and a quickstart guide. See the [Wiki](https://github.com/igvteam/igv.js/wiki) for more documentation. | ||
|
||
[Release Notes](https://github.com/igvteam/igv.js/releases) | ||
|
||
|
||
# Examples | ||
|
||
***[Alignments](https://igv.org/web/release/2.9.4/examples/cram-vcf.html)*** | ||
***[Alignments](https://igv.org/web/release/2.10.0/examples/cram-vcf.html)*** | ||
|
||
***[Interactions](https://igv.org/web/release/2.9.4/examples/arcs.html)*** | ||
***[Interactions](https://igv.org/web/release/2.10.0/examples/interact.html)*** | ||
|
||
***[Copy number](https://igv.org/web/release/2.9.4/examples/copyNumber.html)*** | ||
***[Copy number](https://igv.org/web/release/2.10.0/examples/copyNumber.html)*** | ||
|
||
***[Multiple regions](https://igv.org/web/release/2.9.4/examples/multi-locus.html)*** | ||
***[Multiple regions](https://igv.org/web/release/2.10.0/examples/multi-locus.html)*** | ||
|
||
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.9.4/examples/maf-tcga.html)*** | ||
***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.10.0/examples/maf-tcga.html)*** | ||
|
||
***[Variant color options](https://igv.org/web/release/2.9.4/examples/variant-colors.html)*** | ||
***[Variant color options](https://igv.org/web/release/2.10.0/examples/variant-colors.html)*** | ||
|
||
***[More](https://igv.org/web/release/2.9.4/examples/)*** | ||
***[More](https://igv.org/web/release/2.10.0/examples/)*** | ||
|
||
|
||
# Quickstart | ||
|
||
## Installation | ||
igv.js consists of a single javascript file with no external dependencies. To link directly to the current release copy this snippet | ||
igv.js consists of a single javascript file with no external dependencies. | ||
|
||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/igv.min.js"></script> | ||
Pre-built files for ES5 (igv.min.js) and ES6 (igv.esm.min.js) | ||
can be downloaded from [https://cdn.jsdelivr.net/npm/[email protected]/dist/](https://cdn.jsdelivr.net/npm/[email protected]/dist/). | ||
|
||
To import igv as an ES6 module | ||
|
||
```javascript | ||
import igv from "https://cdn.jsdelivr.net/npm/[email protected]/dist/igv.es6.min.js" | ||
``` | ||
|
||
Pre-built files for ES5 (igv.min.js) and ES6 (igv.esm.min.js) | ||
can be downloaded from [https://cdn.jsdelivr.net/npm/[email protected]/dist/](https://cdn.jsdelivr.net/npm/[email protected]/dist/). | ||
Or as a script include (defines the "igv" global) | ||
|
||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/igv.min.js"></script> | ||
``` | ||
|
||
Alternatively you can install with npm | ||
|
||
|
@@ -154,6 +158,8 @@ igv.js require a modern web browser with support for Javascript ECMAScript 2015. | |
|
||
igv.js is [MIT](/LICENSE) licensed. | ||
|
||
# [_Release Notes_](https://github.com/igvteam/igv.js/releases) | ||
|
||
|
||
### [Release Notes](https://github.com/igvteam/igv.js/releases) | ||
|
||
|