Welcome to the documentation and examples web site for the animint package, which allows an interactive animation to be defined as a list of ggplots with clickSelects and showSelected aesthetics. To get started, install the animint package by executing the following R code:

install.packages("devtools")
library(devtools)
install_github("animint", "tdhock")
library(animint)

Interactivity

The only kind of interactivity that can be defined using animint is showing and hiding subsets of data, based on the current selection. This is controlled by specifying the following two new aesthetics in your ggplot2 geoms:

• aes(showSelected=variable) means that only the subset of the data that corresponds to the selected value of variable will be shown. So the data that will be shown will be the same as in one panel of a normal ggplot with facet_wrap("variable").
• aes(clickSelects=variable) means that clicking this geom will change the currently selected value of variable. In the analogy with a normal facetted ggplot, clicking has the effect of changing which panel is shown.

If showSelected is not specified then all the data will be shown. Also, aes(showSelected=variable1, showSelected2=variable2) means show only the subset of the data that corresponds to both selected variables, like facet_grid(variable1 ~ variable2).

Animation

By default, animint will not make a plot animated. To enable animation, you can define the following option lists:

• duration=list(year=1000) means that the transition will be smooth over 1000 milliseconds for geoms with aes(showSelected=year).
• time=list(variable="year", ms=2000) means that the year variable will be animated, and each animation frame should advance after 2000 milliseconds. This has the same effect as if you clicked an aes(clickSelects=year) geom every 2 seconds.

Examples

Click the images in the table below to show the R code that generated them, alongside the interactive plot.

Generated from R and HTML sources using animint version VERSION.