statgen / locuszoom

A Javascript/d3 embeddable plugin for interactively visualizing statistical genetic data from customizable sources.
https://statgen.github.io/locuszoom/
MIT License
156 stars 29 forks source link

Guide: Mechanisms for interactivity #218

Closed abought closed 3 years ago

abought commented 3 years ago

Purpose

Our existing documentation focuses on the names of functions and how to call them, but provides little sense of architecture or how to connect different pieces.

As other developers become interested in using mechanisms for interactivity, the lack of solid tutorials has increasingly been a source of pain that is only partly alleviated by our example gallery.

In particular, some of the APIs (such as match and filter syntax) are quasi-private, so that they could see further development and breaking changes before widespread adoption. As these APIs have matured, there has been a need to expose this information somewhere.

TODO