Skip to content
Toby Dylan Hocking edited this page Mar 15, 2016 · 28 revisions

Background

Animint is an R package for making interactive animated data visualizations on the web, using ggplot syntax and 2 new aesthetics:

  • showSelected=variable means that only the subset of the data that corresponds to the selected value of variable will be shown.
  • clickSelects=variable means that clicking a plot element will change the currently selected value of variable.

Toby Dylan Hocking initiated the project in 2013, and Susan VanderPlas (2013), Carson Sievert (2014), Tony Tsai (2015), and Kevin Ferris (2015) have provided important contributions during previous GSOC projects.

Related work

Standard R graphics are based on the pen and paper model, which makes animations and interactivity difficult to accomplish. Some existing packages that provide interactivity and/or animation are

  • Non-interactive animations can be accomplished with the animation package (animint provides interactions other than moving forward/back in time).
  • Some interactions with non-animated linked plots can be done with the qtbase, qtpaint, and cranvas packages (animint provides animation and showSelected).
  • Linked plots in the web are possible using SVGAnnotation or gridSVG but using these to create such a visualization requires knowledge of Javascript (animint designers write only R/ggplot2 code).
  • The svgmaps package defines interactivity (hrefs, tooltips) in R code using igeoms, and exports SVG plots using gridSVG, but does not support showing/hiding data subsets (animint does).
  • The ggvis package defines a grammar of interactive graphics that relies on shiny’s reactivity model for most of its interactive capabilities (animint does not need a shiny server).
  • Vega can be used for describing plots in Javascript, but does not implement clickSelects/showSelected (animint does).
  • RIGHT and DC implement interactive plots for some specific plot types (animint uses the multi-layered grammar of graphics so is not limited to pre-defined plot types).

For even more related work see the Graphics and Web technologies task views on CRAN, and Visualization design resources from the UBC InfoVis Group.

Ideas for GSOC 2016 coding projects

An ideal student project will implement several new features to Animint, and also write some tests and documentation (vignette, web page, blog). Some important items from the TODO list:

Any other ideas for improving Animint are welcome as well!

Expected impact

Animint already provides useRs with some unique features for interactive data visualization. At the end of GSOC, the animint package will have even more features, more unit tests, more documentation, and perhaps be more portable (work with more recent versions of ggplot2).

Frequently Asked Questions

Does a student need to know both JavaScript and R?

YES. If you don’t know JavaScript then I suggest you read some tutorials, e.g. Mozilla JavaScript basics, W3Schools, mbostock’s blocks examples.

Mentors

Please get in touch with Toby Dylan Hocking <[email protected]> and Carson Sievert <[email protected]> after completing at least one of the tests below.

Tests

Do one or several — doing more hard tests makes you more likely to be selected.

  • Easy: use Animint to visualize some data from your domain of expertise, and upload your visualization to the web using animint2gist.
  • Medium: translate an examples of the animation package into an Animint. Do not do one of the examples that has already been ported. Post a link to your result on the Ports of animation examples page on the Animint wiki.
    • look at source code of one of the animation package functions e.g. grad.desc() for a demonstration of the gradient descent algorithm. Translate the for loops and plot() calls into code that generates data.frames. In the grad.desc() example, there should be one data.frame for the contour lines, one for the arrows, and one for the values of the objective/gradient at each iteration.
    • Use the data.frames to make some ggplots. In the grad.desc() example, there should be one ggplot with a geom_contour and a geom_path, and another ggplot with a geom_line that shows objective or gradient value versus iteration, and a geom_tallrect in the background for selecting the iteration number.
    • Make a list of ggplots and pass that to animint2dir. For the grad.desc() example the plot list should be something like list(contour=ggplot(), objective=ggplot(), time=list(variable=”iteration”, ms=2000)).
  • Medium-Hard: write a testthat unit test based on one of your Animint visualizations. Fork animint and add a renderer test (using animint2HTML) to tests/testthat/test-renderer3-YOUR-TEST.R, then send us a Pull Request.
  • Hard: show us your level of JavaScript coding skills. Fork the animint source code on github, then implement one of the RENDER items on the TODO list, then send us a pull request.

Solutions of tests

-Students, please post a link to your test results here.

Clone this wiki locally