|
8 | 8 |
|
9 | 9 | No idea what those squiggles are supposed to be? Read the [Introduction](doc/intro.md).
|
10 | 10 |
|
11 |
| -## Online Version: Explore Without Installing Anything |
| 11 | +## Online Version |
| 12 | +**Explore Without Installing Anything** |
12 | 13 |
|
13 | 14 | The easiest way to have a look at some graph visualizations is to check out the online demo at [https://vgteam.github.io/sequenceTubeMap/](https://vgteam.github.io/sequenceTubeMap/). There you can play with visualizations from a few different data sets as well as look at some examples showcasing different structural features of variation graphs. You can even provide your own [vg](https://github.com/vgteam/vg)-generated data as an input (limited to small file sizes only).
|
14 | 15 |
|
15 |
| -## Local Version: Run the Sequence Tube Map On Your Own |
| 16 | +## Local Version |
| 17 | +**Run the Sequence Tube Map on Your Own** |
16 | 18 |
|
17 | 19 | If you are using vg and want visualize the graphs it generates, the online version is limited to small file sizes. For visualizing bigger data sets you can run the Sequence Tube Map on your own. You can either run the Tube Map completely on your local machine or use your local browser to access a Tube Map server running on any other machine you have access to.
|
18 | 20 |
|
19 |
| -(Previously we provided a docker image at [https://hub.docker.com/r/wolfib/sequencetubemap/](https://hub.docker.com/r/wolfib/sequencetubemap/), which contained the build of this repo as well as a vg executable for data preprocessing and extraction. We now recommend a different installation approach.) |
20 |
| - |
21 | 21 | ### Prerequisites
|
22 | 22 |
|
23 | 23 | * The NodeJS version [specified in the `.nvmrc` file](https://github.com/vgteam/sequenceTubeMap/blob/master/.nvmrc), which as of this writing is **18.7.0**. Other several other NodeJS versions will work, or at least mostly work, but only this version is tested. This version of NodeJS can be installed on most systems with [nvm](https://github.com/nvm-sh/nvm).
|
@@ -71,11 +71,15 @@ To set up a custom visualization of particular files, you will need to configure
|
71 | 71 |
|
72 | 72 | ### Adding your Own Data
|
73 | 73 |
|
74 |
| -To load your own data into the Sequence Tube Map, see the guide to [Adding your Own Data](doc/data.md). |
| 74 | +To load your own data into the Sequence Tube Map, see the guide to [Adding Your Own Data](doc/data.md). |
| 75 | + |
| 76 | +## Docker |
| 77 | + |
| 78 | +Previously we provided a Docker image at [https://hub.docker.com/r/wolfib/sequencetubemap/](https://hub.docker.com/r/wolfib/sequencetubemap/), which contained the build of this repo as well as a vg executable for data preprocessing and extraction. We now recommend a different installation approach, either using the [online version](#online-version) or a full installation of the [local version](#local-version). However, if you would like to Dockerize the Sequence Tube Map, the repository includes a `Dockerfile`. |
75 | 79 |
|
76 | 80 | ## Contributing
|
77 | 81 |
|
78 |
| -For information on how to develop on the Sequence Tube Map codebase, pleas see [the Development Guide](doc/development.md). |
| 82 | +For information on how to develop on the Sequence Tube Map codebase, pleas see the [Development Guide](doc/development.md). |
79 | 83 |
|
80 | 84 | ## License
|
81 | 85 |
|
|
0 commit comments