update documents

JoellenKitz · Jul 12, 2015 · a27fe26 · a27fe26
1 parent d327518
commit a27fe26
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 30 deletions.
diff --git a/man/convert.Rd b/man/convert.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/im.convert.R
 \name{im.convert}
 \alias{gm.convert}
 \alias{im.convert}
@@ -124,7 +125,7 @@ ImageMagick: \url{https://www.imagemagick.org/script/convert.php}
 }
 \seealso{
 Other utilities: \code{\link{saveGIF}},
- \code{\link{saveMovie}}; \code{\link{saveHTML2}};
- \code{\link{saveHTML}}; \code{\link{saveLatex}};
- \code{\link{saveSWF}}; \code{\link{saveVideo}}
+ \code{\link{saveMovie}}; \code{\link{saveHTML}};
+ \code{\link{saveLatex}}; \code{\link{saveSWF}};
+ \code{\link{saveVideo}}
 }
diff --git a/man/saveGIF.Rd b/man/saveGIF.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/saveGIF.R
 \name{saveGIF}
 \alias{saveGIF}
 \alias{saveMovie}
@@ -106,7 +107,7 @@ ImageMagick: \url{https://www.imagemagick.org/script/convert.php};
 }
 \seealso{
 Other utilities: \code{\link{gm.convert}},
- \code{\link{im.convert}}; \code{\link{saveHTML2}};
- \code{\link{saveHTML}}; \code{\link{saveLatex}};
- \code{\link{saveSWF}}; \code{\link{saveVideo}}
+ \code{\link{im.convert}}; \code{\link{saveHTML}};
+ \code{\link{saveLatex}}; \code{\link{saveSWF}};
+ \code{\link{saveVideo}}
 }
diff --git a/man/saveHTML.Rd b/man/saveHTML.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/saveHTML.R
 \name{saveHTML}
 \alias{saveHTML}
 \title{Insert animations into an HTML page}
@@ -165,7 +166,6 @@ Yihui Xie
 \seealso{
 Other utilities: \code{\link{gm.convert}},
  \code{\link{im.convert}}; \code{\link{saveGIF}},
- \code{\link{saveMovie}}; \code{\link{saveHTML2}};
- \code{\link{saveLatex}}; \code{\link{saveSWF}};
- \code{\link{saveVideo}}
+ \code{\link{saveMovie}}; \code{\link{saveLatex}};
+ \code{\link{saveSWF}}; \code{\link{saveVideo}}
 }
diff --git a/man/saveLatex.Rd b/man/saveLatex.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/saveLatex.R
 \name{saveLatex}
 \alias{saveLatex}
 \title{Insert animations into a LaTeX document and compile it}
@@ -26,7 +27,7 @@ the LaTeX macro \code{'\\animategraphics'}; default to be
 \item{centering}{logical: whether to center the graph using the LaTeX
 environment \verb{\begin{center}} and \verb{\end{center}}}
 
-\item{caption,label}{caption and label for the graphics in the figure
+\item{caption, label}{caption and label for the graphics in the figure
 environment}
 
 \item{pkg.opts}{global options for the \code{animate} package}
@@ -133,7 +134,6 @@ To know more about the \code{animate} package, please refer to
 \seealso{
 Other utilities: \code{\link{gm.convert}},
  \code{\link{im.convert}}; \code{\link{saveGIF}},
- \code{\link{saveMovie}}; \code{\link{saveHTML2}};
- \code{\link{saveHTML}}; \code{\link{saveSWF}};
- \code{\link{saveVideo}}
+ \code{\link{saveMovie}}; \code{\link{saveHTML}};
+ \code{\link{saveSWF}}; \code{\link{saveVideo}}
 }
diff --git a/man/saveSWF.Rd b/man/saveSWF.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/saveSWF.R
 \name{saveSWF}
 \alias{saveSWF}
 \title{Convert images to Flash animations}
@@ -71,7 +72,6 @@ Yihui Xie
 \seealso{
 Other utilities: \code{\link{gm.convert}},
  \code{\link{im.convert}}; \code{\link{saveGIF}},
- \code{\link{saveMovie}}; \code{\link{saveHTML2}};
- \code{\link{saveHTML}}; \code{\link{saveLatex}};
- \code{\link{saveVideo}}
+ \code{\link{saveMovie}}; \code{\link{saveHTML}};
+ \code{\link{saveLatex}}; \code{\link{saveVideo}}
 }
diff --git a/man/saveVideo.Rd b/man/saveVideo.Rd
@@ -76,7 +76,6 @@ Yihui Xie, based on an inital version by Thomas Julou
 \seealso{
 Other utilities: \code{\link{gm.convert}},
  \code{\link{im.convert}}; \code{\link{saveGIF}},
- \code{\link{saveMovie}}; \code{\link{saveHTML2}};
- \code{\link{saveHTML}}; \code{\link{saveLatex}};
- \code{\link{saveSWF}}
+ \code{\link{saveMovie}}; \code{\link{saveHTML}};
+ \code{\link{saveLatex}}; \code{\link{saveSWF}}
 }
diff --git a/man/vanke1127.Rd b/man/vanke1127.Rd
@@ -1,3 +1,4 @@
+% Please edit documentation in R/animation-package.R
 \docType{data}
 \name{vanke1127}
 \alias{vanke1127}
@@ -13,27 +14,27 @@ This is a sample of stock prices of the Vanke Co., Ltd on 2009/11/27.
 }
 \examples{
 tab.price = table(vanke1127$price)
-plot(as.numeric(names(tab.price)), as.numeric(tab.price), type = "h", xlab = "price", 
- ylab = "frequency")
+plot(as.numeric(names(tab.price)), as.numeric(tab.price), type = 'h',
+  xlab = 'price', ylab = 'frequency')
 
-oopt = ani.options(interval = 0.5, loop = FALSE, title = "Stock price of Vanke")
+oopt = ani.options(interval = 0.5, loop = FALSE, title='Stock price of Vanke')
 
 ## a series of HTML animations with different time spans
 saveHTML({
-  price.ani(vanke1127$price, vanke1127$time, lwd = 2)
-}, img.name = "vanke_a", description = "Prices changing along with time interval 15 min")
+ price.ani(vanke1127$price, vanke1127$time, lwd = 2)
+}, img.name = 'vanke_a', description = 'Prices changing along with time interval 15 min',htmlfile = "vanke1127_1.html")
 
 saveHTML({
-  price.ani(vanke1127$price, vanke1127$time, span = 30 * 60, lwd = 3)
-}, img.name = "vanke_b", description = "Prices changing along with time interval 30 min")
+ price.ani(vanke1127$price, vanke1127$time, span = 30 * 60, lwd = 3)
+}, img.name='vanke_b', description = 'Prices changing along with time interval 30 min',htmlfile = "vanke1127_2.html")
 
 saveHTML({
-  price.ani(vanke1127$price, vanke1127$time, span = 5 * 60, lwd = 2)
-}, img.name = "vanke_c", description = "Prices changing along with time interval 5 min")
+ price.ani(vanke1127$price, vanke1127$time, span = 5 * 60, lwd = 2)
+}, img.name='vanke_c', description = 'Prices changing along with time interval 5 min',htmlfile = "vanke1127_3.html")
 
 ## GIF animation
-saveGIF(price.ani(vanke1127$price, vanke1127$time, lwd = 2), movie.name = "price.gif", 
- loop = 1)
+saveGIF(price.ani(vanke1127$price, vanke1127$time, lwd = 2),
+  movie.name = 'price.gif', loop = 1)
 
 ani.options(oopt)
 }