Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
animated and interactive web graphics
R JavaScript HTML Shell

Merge pull request #94 from tdhock/bump-version

Update DESCRIPTION and NEWS
latest commit d323aecb92
@kferris10 kferris10 authored

README.md

animint - an R package for animated interactive web graphics

Build Status Coverage Status

Interactive animations using ggplot2's grammar of graphics implementation combined with clickSelects and showSelected aesthetics.

Installation

if (!require(devtools)) install.packages("devtools")
devtools::install_github(c("tdhock/ggplot2", "tdhock/animint"), build_vignettes=FALSE)
library(animint)
example(animint)

NOTE: tdhock/ggplot2 is required in order to use theme_animint -- there is a pull request to merge tdhock/ggplot2 with the main ggplot2 repo.

Learning animint through examples

The best way to learn animint is through examples. A couple of good introductions are Carson Sievert's Interactive animations of PITCHf/x and Susan VanderPlas' animint tutorial. In addition, there is an examples web site, examples distributed with animint, as well as more complex 'big data' examples in the tdhock/animint-examples repo.

Frequently asked questions (FAQ)

Animint paper

Carson Sievert, Susan VanderPlas and Toby Dylan Hocking wrote an academic paper describing Animint. If you would like to contribute code to animint, please read the paper first to get an overview of the package. It explains:

  • the purpose of animint: make it easy to design data visualizations which can be both animated and interactive.

  • the clickSelects and showSelected keywords which permit interactive linked plots.

  • the advantages and disadvantages of animint compared to other interactive data viz libraries.

Related work

We have compiled short and long tables of related work.

Contribute to animint!

Get acquainted

Before contributing to animint, you should first read about its design. There are two main components, which have separate wiki pages that explain their details:

  • The compiler is written in R code.
  • The renderer is written in JavaScript code.

TODO items

We keep a TODO list at top of the NEWS file. They are categorized as follows:

  • BUG: things which used to work but have stopped working. Tests should be added to prevent these. For example at one point in 2013, animint rendered the correct number of legend entries for the WorldBank viz, but in the beginning of 2014 animint rendered too many legend entries.
  • GGPLOT: things which ggplot2 supports but animint does not yet support. For example facets, coord_equal.
  • DSL: changes to the animint domain-specific language (DSL) which would allow interactive/animated features. These involve changes to how we define the ggplots, and how the compiler works. For example custom alpha/color/etc for selected geoms, using selected.alpha/selected.color/etc aesthetics.
  • EXAMPLE: examples to show off animint features, which should affect neither the compiler nor renderer.
  • RENDER: changes to the JavaScript rendering code which would result in better interactive plots, without having to change the definition of the ggplots. For example rendering a selection widget for every selection variable.
  • OUTPUT: different output formats for viewing/sharing an interactive animation.
  • OPTIMIZATION: things which are currently supported, but with an implementation that could be improved in terms of render/compile speed, disk usage, memory, etc. Typically these optimizations are not really noticed for small data sets, but make it easier to visualize large data sets. For example, can we gzip the TSV plot data files to reduce disk space and download times?

Submitting contributions

We are open to pull requests. If your changes pass our tests, then we are happy to merge them.

Something went wrong with that request. Please try again.