Skip to content

Commit

Permalink
Merge pull request #66 from GMOD/comparison
Browse files Browse the repository at this point in the history
Adds a comparison table for JBrowse Jupyter features
  • Loading branch information
teresam856 committed Nov 4, 2022
2 parents 332f3c4 + 5efd6c2 commit 559f55f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,34 @@ if __name__ == "__main__":
- For example: the url to the data you wish to pass to the JBrowse view config for the local dev server running on port 8080 on local host will look like this "http://localhost:8080/<your-file-name>"
e.g `jbrowse_conf.add_track("http://localhost:8080/<your-file-name>", name="test-demo")`

## JBrowse Jupyter vs Other tools

| Features | JBrowse/ JBrowse Jupyter | IGV.js /igv-notebook | ipyIgv | Gosling/Gos | D3GB | PygBrowse | Mango |
| --------------- | ---------------- | ------------------ | ---- | ----------- | ---- | --------- | ---- |
| Binder support | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :x: |
| Colab support | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: | :x: | :x: |
| Custom Color Theming | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: | :x: | :x: |
| Deletion of tracks | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: | :x: | :x: | :x: |
| Export view as SVG | :heavy_check_mark: &ast; | :heavy_check_mark: | :heavy_check_mark:| :x: | :x: | :x: | :heavy_check_mark:|
| Local file support | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Supports Circular Genome View | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: | :x: | :x: |
| Ability to enable text searching from indexed files | :heavy_check_mark: | :x: | :x: | :x: | :x: | :x: | :x: |
| Ability to add tracks from Dataframes | :heavy_check_mark: | :x: | :x: | :x: | :x: | :heavy_check_mark: | :x:|
| Zooming in on regions of interest | :heavy_check_mark: &ast; | :heavy_check_mark: | :heavy_check_mark: &ast;| :heavy_check_mark: &ast; | :heavy_check_mark: &ast;| :x: | :heavy_check_mark: &ast; |

&ast; Feature is accessible via the component's UI and not by API.

* For more features of the JBrowse and JBrowse embedded components checkout
[our documentation](https://jbrowse.org/jb2/docs/embedded_components/)
* Igv.js [documentation](https://github.com/igvteam/igv.js/wiki/)
* igv-notebook [documentation](https://github.com/igvteam/igv-notebook)
* ipyIgv [documentation](https://github.com/QuantStack/ipyigv)
* D3GB [documentation](http://d3gb.usal.es/index.html)
* PygBrowse [documentation](https://github.com/phageghost/python-genome-browser)
* Gosling [documentaiton](https://github.com/gosling-lang/gosling.js)
* Gos [documentation](https://gosling-lang.github.io/gos/)
* Mango [documentation](https://bdg-mango.readthedocs.io/en/latest/jupyterWidgets/usage.html)

## Resources
* [JBrowse](https://jbrowse.org/jb2/) - the next generation genome browser
* [JBrowse React Linear Genome View](https://www.npmjs.com/package/@jbrowse/react-linear-genome-view) - interactive genome browser
Expand Down
4 changes: 3 additions & 1 deletion browser.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@
"GRCh38/ncbi_refseq/GCA_000001405.15_GRCh38_full" \
"_analysis_set.refseq_annotation.sorted.gff.gz"
jbrowse_conf.add_track(track_data, name="test-demo", track_id="test-track")

# deleting a track
jbrowse_conf.add_track(track_data, name="delete", track_id="test-delete-track")
jbrowse_conf.delete_track("test-delete-track")
# set location

jbrowse_conf.set_location("10:1..19999")
Expand Down

0 comments on commit 559f55f

Please sign in to comment.