|
0
|
1 JBrowse2 in Galaxy
|
|
1
|
2 ==================
|
|
0
|
3
|
|
|
4 JBrowse2 is a fast, embeddable genome browser built completely with
|
|
|
5 JavaScript and HTML5
|
|
|
6
|
|
|
7 Thus, it makes an ideal fit with Galaxy, especially for use as a
|
|
|
8 workflow summary. E.g. annotate a genome, then visualise all of the
|
|
|
9 associated datasets as an interactive HTML page. This tool MUST be whitelisted
|
|
|
10 (or ``sanitize_all_html=False`` in galaxy.ini) to function correctly.
|
|
|
11 gunicorn does not support byte range requests, so this tool must be served by nginx
|
|
|
12 or other web server, correctly configured to support range requests.
|
|
|
13
|
|
|
14 Installation
|
|
|
15 ============
|
|
|
16
|
|
|
17 It is recommended to install this wrapper via the Galaxy Tool Shed.
|
|
|
18
|
|
|
19 Running Locally
|
|
|
20 ===============
|
|
|
21
|
|
|
22 The Galaxy tool interface writes out a xml file which is then used to generate
|
|
|
23 the visualizations. An example used during development/testing can be seen in
|
|
|
24 `test-data/*/test.xml`. The format is in no way rigorously defined and is
|
|
|
25 likely to change at any time! Beware. ;)
|
|
|
26
|
|
|
27 History
|
|
|
28 =======
|
|
|
29
|
|
|
30 - 2.10.0+galaxy2
|
|
|
31
|
|
|
32 - UPDATED to JBrowse 2.10.0
|
|
|
33 - REMOVED most colour and track control from XML and script.
|
|
|
34 - seems to work well with defaults.
|
|
|
35 - need to document and implement track settings by running the browser locally.
|
|
|
36 - works well enough to be useful in workflows such as TreeValGal.
|
|
|
37 - JB2 seems to set defaults wisely.
|
|
|
38 - not yet ideal for users who need fine grained track control.
|
|
|
39
|
|
|
40 - 1.16.11+galaxy0
|
|
|
41
|
|
|
42 - UPDATED to JBrowse 1.16.11
|
|
|
43
|
|
|
44 - 1.16.10+galaxy0
|
|
|
45
|
|
|
46 - UPDATED to JBrowse 1.16.10
|
|
|
47 - ADDED GALAXY_JBROWSE_SYMLINKS environment variable: if set, the tool will make symlinks to bam/bigwig files instead of copying them
|
|
|
48
|
|
|
49 - 1.16.9+galaxy0
|
|
|
50
|
|
|
51 - UPDATED to JBrowse 1.16.9
|
|
|
52
|
|
|
53 - 1.16.8+galaxy0
|
|
|
54
|
|
|
55 - UPDATED to JBrowse 1.16.8
|
|
|
56
|
|
|
57 - 1.16.5+galaxy0
|
|
|
58
|
|
|
59 - UPDATED to JBrowse 1.16.5
|
|
|
60
|
|
|
61 - 1.16.4+galaxy0
|
|
|
62
|
|
|
63 - UPDATED to JBrowse 1.16.4
|
|
|
64 - ADDED filter too big metadata
|
|
|
65 - CHANGED default value for topLevelFeatures (gene subfeatures are now inferred) and style.className (feature style was fixed)
|
|
|
66
|
|
|
67 - 1.16.2+galaxy0
|
|
|
68
|
|
|
69 - UPDATED to JBrowse 1.16.2
|
|
|
70 - ADDED support for NeatHTMLFeatures and NeatCanvasFeatures track types
|
|
|
71
|
|
|
72 - 1.16.1+galaxy0
|
|
|
73
|
|
|
74 - UPDATED to JBrowse 1.16.1
|
|
|
75 - ADDED support for MultiBigWig plugin
|
|
|
76 - ADDED support for tabix indexing of fasta and gff
|
|
|
77 - ADDED support for REST and SPARQL endpoints
|
|
|
78 - ADDED option to change chunk size for BAM tracks
|
|
|
79 - FIXED loading of VCF files. They were gzipped and the URLs were incorrect
|
|
|
80 - FIXED metadata on tracks types other than GFF+HTML
|
|
|
81 - FIXED infrastructure URL parsing (and embedding in links) for some tracks
|
|
|
82 - REMOVED support for selecting multiple genomes as input due to tracking of track metadata
|
|
|
83 - REMOVED support for themes as JBrowse no longer allow runtime loading of plugins
|
|
|
84
|
|
|
85 - 0.7 Support for plugins (currently GC Content, Bookmarks, ComboTrackSelector),
|
|
|
86 track metadata
|
|
|
87 - 0.5.2 Support for CanvasFeatures options.
|
|
|
88 - 0.5.1 Support for contextual menus. Conda tests.
|
|
|
89 - 0.5 Update existing instances on disk. Index names. Support HTML tracks
|
|
|
90 instead of Canvas. Support default tracks. General JBrowse optinos
|
|
|
91 - 0.4 Support for dataset collections and customisation of tracks including
|
|
|
92 labelling, colours, styling. Added support for genetic code selection.
|
|
|
93 Fixed package installation recipe issues.
|
|
|
94 - 0.3 Added support for BigWig, etc.
|
|
|
95 - 0.2 Added support for BAM, Blast, VCF.
|
|
|
96 - 0.1 Initial public release.
|
|
|
97
|
|
|
98 Wrapper License (MIT/BSD Style)
|
|
|
99 ===============================
|
|
|
100
|
|
|
101 Permission to use, copy, modify, and distribute this software and its
|
|
|
102 documentation with or without modifications and for any purpose and
|
|
|
103 without fee is hereby granted, provided that any copyright notices
|
|
|
104 appear in all copies and that both those copyright notices and this
|
|
|
105 permission notice appear in supporting documentation, and that the names
|
|
|
106 of the contributors or copyright holders not be used in advertising or
|
|
|
107 publicity pertaining to distribution of the software without specific
|
|
|
108 prior permission.
|
|
|
109
|
|
|
110 THE CONTRIBUTORS AND COPYRIGHT HOLDERS OF THIS SOFTWARE DISCLAIM ALL
|
|
|
111 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
|
|
|
112 WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
|
|
|
113 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
|
|
|
114 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
|
|
|
115 USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
|
116 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
|
117 PERFORMANCE OF THIS SOFTWARE.
|
