saveHTML: Insert animations into an HTML page

Description

This function first records all the plots in the R expression as bitmap images, then inserts them into an HTML page and finally creates the animation using the SciAnimator library.

Usage

saveHTML(expr, img.name = "Rplot", global.opts = "", single.opts = "", 
    navigator = ani.options("nmax") <= 100="" &&="" ani.options("interval")="">= 
        0.05, htmlfile = "index.html", ...)

Arguments

expr

an R expression to be evaluated to create a sequence of images

img.name

the filename of the images (the real output will be like img.name1.png, img.name2.png, ...); this name has to be different for different animations, since it will be used as the identifiers for each animation; make it as un

global.opts

a string: the global options of the animation; e.g. we can specify the default theme to be blue using $.fn.scianimator.defaults.theme = 'blue'; note these options must be legal JavaScript expressions (ended by ';')

single.opts

the options for each single animation (if there are multiple ones in one HTML page), e.g. to use the dark theme and text labels for buttons:

'utf8': false, 'theme': 'dark'

or to remove the navigator panel (the navigator can affect t

navigator

whether to show the navigator (like a progress bar); by default, the navigator is not shown for performance reasons when the number of images is greater than 100 or the time interval is smaller than 0.05

htmlfile

the filename of the HTML file

...

other arguments to be passed to ani.options to animation options such as the time interval between image frames

Value

The path of the HTML output.

Details

It mainly uses the SciAnimator library, which is based on jQuery. It has a neat interface (both technically and visually) and is much easier to use or extend. Moreover, this function allows multiple animations in a single HTML page -- just use the same HTML filename.

Optionally the source code and some session information can be added below the animations for the sake of reproducibility (specified by the option ani.options('verbose') -- if TRUE, the description, loaded packages, the code to produce the animation, as well as a part of sessionInfo() will be written in the bottom of the animation; the R code will be highlighted using the SyntaxHighlighter library for better reading experience).