search

GMOD / jbrowse-components

Source code for JBrowse 2, a modern React-based genome browser
https://jbrowse.org/jb2
Apache License 2.0
206 stars 62 forks source link

Document differences between the embed options of full JBrowse app or LGV #2805

Closed carolinebridge closed 2 years ago

carolinebridge commented 2 years ago

Users wishing to embed JB2 into their websites have two options, running JBrowse as a separate page or running the LGV react component embedded into a webpage.

Our documentation mentions these two options, but doesn't explain to the reader what features the Linear Genome View component lacks (and conversely, what hosting the full app on their site looks like).

We should come up with a comparative list to help users understand what option best aligns with their needs as embedded users.

carolinebridge commented 2 years ago
Linear genome view embedded component Separate page JBrowse app
Only has access to the linear genome view Has access to all views loaded into the JBrowse session, including circular view, and views from plugins
Feature details open as a dialogue Feature details open as a drawer
View / add tracks open as a dialogue View / add tracks open as a drawer
Only access to plugin display types and adapters Access to all plugin extensions (displays, view, adapters, widgets, etc.)
No options to preserve users current session to load again later Save / Import / Export session for the user

Both can: - add new tracks from local files or from URL (only JB app)

cmdcolin commented 2 years ago

This is good info to have. I'll just note, the LGV is much more designed for developers to build a product around, so we don't provide an option by default to load sessions again later, but a user of @jbrowse/react-linear-genome-view can certainly make a system that does so. The wisdom of NPM is that there are so many off the shelf components that people can build on top of...just so happens that @jbrowse/react-linear-genome-view is so complicated it kind of blurs the line between app and component compared to other small NPM modules.

carolinebridge commented 2 years ago

https://github.com/GMOD/jbrowse-components/issues/1634

cmdcolin commented 2 years ago

we got this added to the features page :)