There are various parameters that control the behaviour of the animation, such as time interval, maximum number of animation frames, height and width, etc.
ani.options() returns a list containing the options: when
parameters are set, their former values are returned in an invisible named
list. Such a list can be passed as an argument to
ani.options to restore the parameter values.
ani.options('tag') returns the value of the option
ani.options(c('tag1', 'tag2')) or
returns a list containing the corresponding options.
The supported animation parameters:
a positive number to set the time interval of the animation (unit in seconds); default to be 1.
maximum number of steps in a loop (e.g. iterations) to create animation frames. Note: the actual number of frames can be less than this number, depending on specific animations. Default to be 50.
width and height of image frames (unit in
px); see graphics devices like
default to be 480. NB: for different graphics devices, the units of these
values might be different, e.g. PDF devices usually use inches, whereas
bitmap devices often use pixels.
character: the name of the directory (a relative path) for
images when creating HTML animation pages; default to be
character: name of the target HTML main file (without path
name; basename only; default to be
a function or a function name: the graphics device; e.g.
character: image format for animation frames, e.g.
jpeg, ...; default to be
'png'; this will be used
as the file extension of images, so don't forget to change this option as
well when you changed the option
character: the title and description of the
animation in the HTML page created by
logical or character: if
TRUE, write a footer part
in the HTML page containing detailed technical information; if given a
character string, it will be used as the footer message; in other cases,
the footer of the page will be blank.
logical or numeric: Number of times the GIF animation is to cycle through the image sequence before stopping. By default, this is set to zero or boolean value TRUE (infinite loop).
logical: whether auto-browse the animation page
immediately after it is created? (default to be
logical: whether to autoplay the animation when the HTML
page is loaded (default to be
TRUE); only applicable to
whether to use the graphics device specified in
ani.options('ani.dev') (default to be
we need to generate image files by our own approaches in the expression
expr (see functions
saveSWF); this can be useful when
the output cannot be captured by standard R graphics devices – a typical
example is the rgl graphics (we can use
capture rgl graphics to png files, or
rgl.postscript to save
plots as postscript/pdf; see
demo('use_Cairo') for examples or the last example below). Note,
however, we do not really have to create the images using R graphics
devices – see
demo('flowers') on how to download images from the
Internet and create an HTML animation page!
There are a couple of “hidden” options which are designed to facilitate the usage of some functions but are not initialized like the above options when the package is loaded, including:
this option will be checked first when calling
saveGIF) to see if it contains
the path to ‘convert.exe’; we can specify it beforehand to save the
efforts in searching for ‘convert.exe’ in ImageMagick under Windows.
ani.options(convert = 'c:/program
files/imagemagick/convert.exe'); note this option also works for Mac and
this can help
saveSWF save the efforts of
searching for the software package “SWF Tools” under Windows; e.g. we can
ani.options(swftools = 'c:/program files/swftools') in
the value of this option can be used to determine the image
filename format when we want to use custom graphics devices to record
images, e.g. in
ani.options('img.fmt') will be a string like
'path/to/output/img.name%d.png', so we can use it to generate file
names in the argument
example or the last example below
the path of the program
ani.options(qpdf = 'C:/Software/qpdf/bin/qpdf.exe');
is mainly used to compress PDF files in this package, and it is a smaller
pdftk. It is recommended over
especially under Linux, because tests show that
pdftk does not
work well under Linux in compressing PDF files, while
the path of the program
ani.options(pdftk = 'C:/Software/pdftk.exe') or
ani.options(pdftk = '/home/john/bin/pdftk');
pdftk will be
used to compress the PDF graphics output in the function
pdftk; compression will not be tried if this options is
NULL. This option will only affect
the path of the progam
ani.options(ffmpeg = 'C:/Software/ffmpeg/bin/ffmpeg.exe'); FFmpeg is
used to convert a sequence of images to a video. See
Please note that
nmax is not always equal to the number of
animation frames. Sometimes there is more than one frame recorded in a
single step of a loop, for instance, there are 2 frames generated in each
kmeans.ani, and 4 frames in
etc; whereas for
newton.method, the number of animation
frames is not definite, because there are other criteria to break the loop.
This function can be used for almost all the animation functions such as
knn.ani, etc. Most of the options
here will affect the behaviour of animations of the formats HTML, GIF, SWF
and PDF; on-screen animations are only affected by
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.