igv 2.13.11 → 2.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,24 +7,30 @@
7
7
 
8
8
  igv.js is an embeddable interactive genome visualization component developed by the
9
9
  [Integrative Genomics Viewer (IGV)](https://igv.org) team.
10
+
11
+ ## Citing igv.js
12
+
13
+ James T Robinson, Helga Thorvaldsdottir, Douglass Turner, Jill P Mesirov, igv.js: an embeddable JavaScript
14
+ implementation of the Integrative Genomics Viewer (IGV), Bioinformatics, Volume 39, Issue 1, January 2023,
15
+ btac830, https://doi.org/10.1093/bioinformatics/btac830
10
16
 
11
17
  Below are examples and a quickstart guide. See the [Wiki](https://github.com/igvteam/igv.js/wiki) for more documentation.
12
18
 
13
19
  # Examples
14
20
 
15
- ***[Alignments](https://igv.org/web/release/2.13.11/examples/cram-vcf.html)***
21
+ ***[Alignments](https://igv.org/web/release/2.15.1/examples/cram-vcf.html)***
16
22
 
17
- ***[Interactions](https://igv.org/web/release/2.13.11/examples/interact.html)***
23
+ ***[Interactions](https://igv.org/web/release/2.15.1/examples/interact.html)***
18
24
 
19
- ***[Copy number](https://igv.org/web/release/2.13.11/examples/copyNumber.html)***
25
+ ***[Copy number](https://igv.org/web/release/2.15.1/examples/copyNumber.html)***
20
26
 
21
- ***[Multiple regions](https://igv.org/web/release/2.13.11/examples/multi-locus.html)***
27
+ ***[Multiple regions](https://igv.org/web/release/2.15.1/examples/multi-locus.html)***
22
28
 
23
- ***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.13.11/examples/maf-tcga.html)***
29
+ ***[Mutation Annotation Format (MAF)](https://igv.org/web/release/2.15.1/examples/maf-tcga.html)***
24
30
 
25
- ***[Variant color options](https://igv.org/web/release/2.13.11/examples/variant-colors.html)***
31
+ ***[Variant color options](https://igv.org/web/release/2.15.1/examples/variant-colors.html)***
26
32
 
27
- ***[More](https://igv.org/web/release/2.13.11/examples/)***
33
+ ***[More](https://igv.org/web/release/2.15.1/examples/)***
28
34
 
29
35
 
30
36
  # Quickstart
@@ -32,19 +38,19 @@ Below are examples and a quickstart guide. See the [Wiki](https://github.com/ig
32
38
  ## Installation
33
39
  igv.js consists of a single javascript file with no external dependencies.
34
40
 
35
- Pre-built files for ES5 (igv.min.js) and ES6 (igv.esm.min.js)
36
- can be downloaded from [https://cdn.jsdelivr.net/npm/igv@2.13.11/dist/](https://cdn.jsdelivr.net/npm/igv@2.13.11/dist/).
41
+ Pre-built files for script include, AMD, or CJS module systems (igv.min.js) and an ES6 module (igv.esm.min.js)
42
+ can be downloaded from [https://cdn.jsdelivr.net/npm/igv@2.15.1/dist/](https://cdn.jsdelivr.net/npm/igv@2.15.1/dist/).
37
43
 
38
44
  To import igv as an ES6 module
39
45
 
40
46
  ```javascript
41
- import igv from "https://cdn.jsdelivr.net/npm/igv@2.13.11/dist/igv.esm.min.js"
47
+ import igv from "https://cdn.jsdelivr.net/npm/igv@2.15.1/dist/igv.esm.min.js"
42
48
  ```
43
49
 
44
50
  Or as a script include (defines the "igv" global)
45
51
 
46
52
  ```html
47
- <script src="https://cdn.jsdelivr.net/npm/igv@2.13.11/dist/igv.min.js"></script>
53
+ <script src="https://cdn.jsdelivr.net/npm/igv@2.15.1/dist/igv.min.js"></script>
48
54
  ```
49
55
 
50
56
  Alternatively you can install with npm
@@ -110,7 +116,7 @@ npm run build
110
116
 
111
117
  This creates a dist folder with the following files
112
118
 
113
- * igv.js - ES5 compatible UMDS file for script include, AMD, or CJS modules. A script include will define an "igv" global.
119
+ * igv.js - UMDS file for script include, AMD, or CJS modules. A script include will define an "igv" global.
114
120
  * igv.min.js - minified version of igv.js
115
121
  * igv.esm.js -- ES6 module
116
122
  * igv.esm.min.js -- minified version of igv.esm.js
@@ -139,7 +145,7 @@ Then open [http://localhost:8080/examples](http://localhost:8080/examples) in a
139
145
 
140
146
  # Supported Browsers
141
147
 
142
- igv.js require a modern web browser with support for Javascript ECMAScript 2015.
148
+ igv.js require a modern web browser with support for Javascript ECMAScript 2015 (ES6).
143
149
 
144
150
  # License
145
151
 
@@ -149,4 +155,4 @@ igv.js is [MIT](/LICENSE) licensed.
149
155
 
150
156
  ### [Release Notes](https://github.com/igvteam/igv.js/releases)
151
157
 
152
-
158
+