@jbrowse/img 2.2.2 → 2.3.0

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.
Files changed (2) hide show
  1. package/README.md +27 -20
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -4,7 +4,9 @@ Static exports of JBrowse 2 rendering.
4
4
 
5
5
  ## Prerequisites
6
6
 
7
- You don't need to have JBrowse 2 installed to use this tool. The tool can generate images using files on your hard drive or from remote files. So, all you need to run this tool is
7
+ You don't need to have JBrowse 2 installed to use this tool. The tool can
8
+ generate images using files on your hard drive or from remote files. So, all you
9
+ need to run this tool is
8
10
 
9
11
  - NodeJS v12+
10
12
 
@@ -16,24 +18,27 @@ More examples [EXAMPLES.md](EXAMPLES.md)
16
18
 
17
19
  ## Setup
18
20
 
19
- You can install the `@jbrowse/img` package from npm, which, if your node is configured in a typical configuration, will then have a command `jb2export` in your path
21
+ You can install the `@jbrowse/img` package from npm, which, if your node is
22
+ configured in a typical configuration, will then have a command `jb2export` in
23
+ your path
20
24
 
21
25
  ```bash
22
26
  npm install -g @jbrowse/img
23
27
  ```
24
28
 
25
- If you are using npm version 7+ (released 2021) you may also need to add `--legacy-peer-deps`
29
+ If you are using npm version 7+ (released 2021) you may also need to add
30
+ `--legacy-peer-deps`
26
31
 
27
- If you are a developer and want to modify the code, see [developer
28
- guide](DEVELOPER.md) for details
32
+ If you are a developer and want to modify the code, see
33
+ [developer guide](DEVELOPER.md) for details
29
34
 
30
35
  ## Example usages
31
36
 
32
37
  ### Use with local files
33
38
 
34
39
  We can call this script on local files, and it doesn't require a web browser,
35
- not even a headless webbrowser, it just runs a node script and React SSR is
36
- used to create the SVG
40
+ not even a headless webbrowser, it just runs a node script and React SSR is used
41
+ to create the SVG
37
42
 
38
43
  ```bash
39
44
  ## generate an indexed fasta e.g. fai file
@@ -52,7 +57,8 @@ If `--out` is not specified it writes to out.svg
52
57
  ### Generate PNG instead of SVG
53
58
 
54
59
  Supply a file with the png extension to `--out`, uses rsvg-convert so you will
55
- need to install rsvg-convert to your system e.g. with `sudo apt install librsvg2-bin`
60
+ need to install rsvg-convert to your system e.g. with
61
+ `sudo apt install librsvg2-bin`
56
62
 
57
63
  ```bash
58
64
  jb2export --fasta yourfile.fa --bam yourfile.bam --loc chr1:1,000,000-1,001,000 --out file.png
@@ -61,7 +67,8 @@ jb2export --fasta yourfile.fa --bam yourfile.bam --loc chr1:1,000,000-1,001,000
61
67
  ### Generate PDF instead of SVG
62
68
 
63
69
  Supply a file with the pdf extension to `--out`, uses rsvg-convert so you will
64
- need to install rsvg-convert to your system e.g. with `sudo apt install librsvg2-bin`
70
+ need to install rsvg-convert to your system e.g. with
71
+ `sudo apt install librsvg2-bin`
65
72
 
66
73
  ```bash
67
74
  jb2export --fasta yourfile.fa --bam yourfile.bam --loc chr1:1,000,000-1,001,000 --out file.pdf
@@ -122,9 +129,9 @@ jb2export --fasta data/volvox/volvox.fa --configtracks refseq --loc ctgA:1-100
122
129
 
123
130
  ### Use with a jbrowse config.json (remote files in the config.json)
124
131
 
125
- A config.json can be specified, and then we just refer to trackIds in this
126
- file, and extra tracks can also be supplied that are outside of the config e.g.
127
- with --bam
132
+ A config.json can be specified, and then we just refer to trackIds in this file,
133
+ and extra tracks can also be supplied that are outside of the config e.g. with
134
+ --bam
128
135
 
129
136
  ```bash
130
137
  jb2export --config data/config.json \
@@ -184,8 +191,8 @@ jb2export --loc all \
184
191
 
185
192
  ### Use with a jbrowse config.json (local files in the config.json)
186
193
 
187
- The jbrowse CLI tool (e.g. npm install -g @jbrowse/cli) refers to "uri" paths
188
- by default, but you replace them with localPath like this
194
+ The jbrowse CLI tool (e.g. npm install -g @jbrowse/cli) refers to "uri" paths by
195
+ default, but you replace them with localPath like this
189
196
 
190
197
  ```js
191
198
 
@@ -209,8 +216,8 @@ jb2export --config data/volvox/config.json \
209
216
  --loc ctgA:1-50,000
210
217
  ```
211
218
 
212
- The localPaths will be resolved relative to the file that is supplied so in
213
- this example we would resolve data/volvox/volvox.dup.vcf.gz if "localPath":
219
+ The localPaths will be resolved relative to the file that is supplied so in this
220
+ example we would resolve data/volvox/volvox.dup.vcf.gz if "localPath":
214
221
  "volvox.dup.vcf.gz" is used, and `--config data/volvox/config.json` is passed
215
222
 
216
223
  See data/volvox/config.json for a config that contains localPaths, or
@@ -337,13 +344,13 @@ convert -size 2048x out.svg out.png
337
344
  ### I don't get any outputted svg and no message
338
345
 
339
346
  The error reporting from the app is not very good at the moment so often has
340
- silent failures. Confirm that your fasta file to your pass to --fasta is
341
- indexed in this case e.g. `samtools faidx yourfile.fa` so that your have a
347
+ silent failures. Confirm that your fasta file to your pass to --fasta is indexed
348
+ in this case e.g. `samtools faidx yourfile.fa` so that your have a
342
349
  yourfile.fa.fai alongside yourfile.fa
343
350
 
344
351
  ### I get a lot of warnings during npm install -g @jbrowse/img
345
352
 
346
353
  There are some new features in the latest NPM (2021, v7) related to
347
354
  peerDependencies that may produce some warnings. It should work even despite
348
- making warnings, but you can use yarn to install or use legacy peer
349
- dependencies if you want to avoid install time warningsvg
355
+ making warnings, but you can use yarn to install or use legacy peer dependencies
356
+ if you want to avoid install time warningsvg
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/img",
3
- "version": "2.2.2",
3
+ "version": "2.3.0",
4
4
  "main": "dist/index.js",
5
5
  "module": "esm/index.js",
6
6
  "author": "JBrowse Team",
@@ -29,11 +29,11 @@
29
29
  "@babel/runtime": "^7.17.9",
30
30
  "@emotion/cache": "^11.7.1",
31
31
  "@emotion/react": "^11.9.0",
32
- "@jbrowse/plugin-linear-genome-view": "^2.2.2",
33
- "@jbrowse/react-linear-genome-view": "^2.2.2",
32
+ "@jbrowse/plugin-linear-genome-view": "^2.3.0",
33
+ "@jbrowse/react-linear-genome-view": "^2.3.0",
34
34
  "abortcontroller-polyfill": "^1.7.3",
35
35
  "canvas": "^2.9.1",
36
- "jsdom": "^19.0.0",
36
+ "jsdom": "^20.0.3",
37
37
  "mobx": "^6.6.0",
38
38
  "node-fetch": "^2.6.7",
39
39
  "react": "^17.0.0",
@@ -44,5 +44,5 @@
44
44
  "publishConfig": {
45
45
  "access": "public"
46
46
  },
47
- "gitHead": "abbc00e8feedbc58de84a7a3e735ec0224909b29"
47
+ "gitHead": "a85b280a8af4d1a11e81ab42913f5f6049e6e580"
48
48
  }