-
Notifications
You must be signed in to change notification settings - Fork 198
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
18 additions
and
12 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 |
---|---|---|
@@ -1,29 +1,35 @@ | ||
CategoryURL - JBrowse plugin | ||
# CategoryURL - JBrowse plugin | ||
|
||
Add URL parameter "cat" to specify a category of tracks to display. | ||
All tracks with the given category will be displayed. | ||
If any "tracks" are specified in the URL, "cat" tracks will be appended to list. | ||
|
||
Usage: Add &cat=myCategory | ||
Usage: Add `&cat=myCategory` to the URL | ||
Result: all tracts with category "myCategory" will be displayed. | ||
Sub-categories are supported as well (i.e. "&cat=myCategory/mySubCategory" | ||
Sub-categories are supported as well (i.e. `&cat=myCategory/mySubCategory`) | ||
|
||
The cat= URL parameter allows the display of tracks with the given category | ||
defined in the track metadata that are used to group tracks in the hierarchical | ||
track selector. For example: | ||
|
||
"category" : "Miscellaneous", | ||
"category" : "Miscellaneous", | ||
|
||
Example: | ||
http://<jbrowse>/?data=sample_data/json/volvox&cat=Miscellaneous | ||
http://<jbrowse>/?data=sample_data/json/volvox&cat=Quantitative/Density | ||
|
||
Install / Activate: | ||
http://<jbrowse>/?data=sample_data/json/volvox&cat=Miscellaneous | ||
|
||
http://<jbrowse>/?data=sample_data/json/volvox&cat=Quantitative/Density | ||
|
||
|
||
### Install / Activate: | ||
|
||
For JBrowse 1.11.6+, copy the `CategoryUrl` directory to the `JBrowse` plugins directory. | ||
Add this to appropriate `trackList.json` under the plugins section (create section, if it doesn't exist): | ||
|
||
"plugins": [ | ||
'CategoryUrl' | ||
], | ||
|
||
|
||
For JBrowse 1.11.6+, copy the CategoryUrl directory to the JBrowse 'plugins' directory. | ||
Add this to appropriate trackList.json under the plugins section (create section, if it doesn't exist): | ||
|
||
"plugins": [ | ||
'CategoryUrl' | ||
], | ||
|