-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Welcome to the BBOP JS wiki!
To keep ourselves from repeating, probably the best overview at this point is in the README.org file found on the main code site here. This wiki covers the big picture and details that are not covered in the source code docs, demos, tests, and API docs; for those, see Other Resources at the bottom.
Another major portion of the code deals with interacting with specially loaded Solr servers. We’re going to take for granted that people who have come this far have at least a passing knowledge of Solr.
The BBOP JS manager code (bbop.golr.manager and its subclasses) can interact in a very primitive way with any Solr server, but to get full power of the manager, the Solr schema must be laid out and loaded a certain way. Any Solr server that meets these criteria is then called a GOlr server, a portmanteau of Gene Ontology (where this development started) and Solr. A more complete discussion of GOlr schema can be found here.
A large chunk of BBOP JS is devoted to handling graphs–a natural development due to the developers’ desire to work with and visualize ontologies and phylogenic trees.
The current JS API for graphs can be found here. As far as the API is concerned, there is a single type of graph (not counting sub-classes). However, to prevent re-implementing complicated and fiddly reasoning in the client, GOlr supplies two types of graphs with different purposes in mind: the topology graph and the transitivity graph.
BBOP JS also incorporates a wide selection of utility functions (bbop.core) and utility classes (bbop.html, bbop.logging, bbop.template, etc.).
TODO
Finally, BBOP JS includes scripts found in the bin/ directory and widgets found in the lib/bbop/widgets/ directory–code directly consumable by end users who don’t want to muck around with the library.
In all likelihood, the scripts are probably not that useful as they stand, but are good jumping of points for learning about the libraries and interacting with Solr/GOlr servers.
The widgets should hopefully be quite useful to end users as they stand and a decent jumping off point for developing their own extensions.
TODO