1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/saveHTML.R
\name{saveHTML}
\alias{saveHTML}
\title{Insert animations into an HTML page}
\usage{
saveHTML(
expr,
img.name = "Rplot",
global.opts = "",
single.opts = "",
navigator = ani.options("nmax") <= 100 && ani.options("interval") >= 0.05,
htmlfile = "index.html",
...
)
}
\arguments{
\item{expr}{an R expression to be evaluated to create a sequence of images}
\item{img.name}{the filename of the images (the real output will be like
\file{img.name1.png}, \file{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 unique as possible; meanwhile,
the following characters in \code{img.name} will be replaced by \code{_} to
make it a legal jQuery string:
\verb{!"#$\%&'()*+,./:;?@[\]^`{|}~}}
\item{global.opts}{a string: the global options of the animation; e.g. we can
specify the default theme to be blue using
\verb{$.fn.scianimator.defaults.theme = 'blue';} note these options must be
legal JavaScript expressions (ended by \code{';'})}
\item{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:
\verb{'utf8': false, 'theme': 'dark'}
or to remove the navigator panel (the navigator can affect the smoothness
of the animation when the playing speed is extremely fast (e.g.
\code{interval} less than 0.05 seconds)):
\verb{'controls': ['first', 'previous', 'play', 'next', 'last', 'loop',
'speed']}
see the reference for a complete list of available options}
\item{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}
\item{htmlfile}{the filename of the HTML file}
\item{...}{other arguments to be passed to \code{\link{ani.options}} to
animation options such as the time interval between image frames}
}
\value{
The path of the HTML output.
}
\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.
}
\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
\code{ani.options('verbose')} -- if \code{TRUE}, the description, loaded
packages, the code to produce the animation, as well as a part of
\code{\link{sessionInfo}()} will be written in the bottom of the animation;
the R code will be highlighted using the SyntaxHighlighter library for better
reading experience).
}
\note{
Microsoft IE might restrict the HTML page from running JavaScript and
try to ``protect your security'' when you view the animation page, but this
is not really a security problem.
When you want to publish the HTML page on the web, you have to upload the
associated \file{css} and \file{js} folders with the HTML file as well as
the images.
For \code{\link{saveHTML}}, \code{ani.options('description')} can be a
character vector, in which case this vector will be pasted into a scalar;
use \code{'\n\n'} in the string to separate paragraphs (see the first
example below).
For the users who do not have R at hand, there is a demo in
\code{system.file('misc', 'Rweb', 'demo.html', package = 'animation')} to
show how to create animations online without R being installed locally. It
depends, however, on whether the Rweb service can be provided for public
use in a long period (currently we are using the Rweb at Tama University).
See the last example below.
}
\references{
Examples at \url{https://yihui.org/animation/example/savehtml/}
scianimator official website \url{https://github.com/brentertz/scianimator}
}
\seealso{
Other utilities:
\code{\link{im.convert}()},
\code{\link{saveGIF}()},
\code{\link{saveLatex}()},
\code{\link{saveSWF}()},
\code{\link{saveVideo}()}
}
\author{
Yihui Xie
}
\concept{utilities}
|
