Skip to content

Commit

Permalink
roxygenize
Browse files Browse the repository at this point in the history
  • Loading branch information
daroczig committed Sep 12, 2013
1 parent e21c4be commit f201be8
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 9 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export(pandoc.title.return)
export(pandoc.verbatim)
export(pandoc.verbatim.return)
export(redraw.recordedplot)
export(redrawPlot)
export(remove.extra.newlines)
export(repChar)
export(set.alignment)
Expand Down
17 changes: 8 additions & 9 deletions man/redraw.recordedplot.Rd
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
\name{redraw.recordedplot}
\alias{redraw.recordedplot}
\title{Redraws saved plot}
\title{Redraws plot saved in file}
\usage{
redraw.recordedplot(file)
}
\arguments{
\item{file}{path and name of file to read saved
\code{recordPlot} object}
\item{file}{path and name of an rds file containing a
plot object to be redrawn}
}
\description{
This function is a wrapper around \code{replayPlot} with
some added tweaks (fixing memory address nullpointer
issue) for compatibility.
This function is a wrapper around \code{redrawPlot}.
}
\references{
Thanks to Jeroen Ooms
\url{http://permalink.gmane.org/gmane.comp.lang.r.devel/29897}
and JJ Allaire
\url{https://github.com/rstudio/rstudio/commit/eb5f6f1db4717132c2ff111f068ffa6e8b2a5f0b}.
\url{http://permalink.gmane.org/gmane.comp.lang.r.devel/29897},
JJ Allaire
\url{https://github.com/rstudio/rstudio/commit/eb5f6f1db4717132c2ff111f068ffa6e8b2a5f0b},
and Gabriel Becker.
}
\seealso{
\code{\link{evals}}
Expand Down
29 changes: 29 additions & 0 deletions man/redrawPlot.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
\name{redrawPlot}
\alias{redrawPlot}
\title{Redraw a recordedplot, grid, trellis, or ggplot2 plot.}
\usage{
redrawPlot(recPlot)
}
\arguments{
\item{the}{plot object to redraw}
}
\description{
This function redraws the plot represented by
\code{recPlot}. It can redraw grid/trellis/ggplot2/etc
plots, as well as \code{recordedplot} objects. For
\code{recordedplot} objects it acts as a wrapper around
\code{replayPlot} with memory tweaks to fix native symbol
address errors when the recordedplot was loaded from an
rda/rds file.
}
\references{
Thanks to Jeroen Ooms
\url{http://permalink.gmane.org/gmane.comp.lang.r.devel/29897},
JJ Allaire
\url{https://github.com/rstudio/rstudio/commit/eb5f6f1db4717132c2ff111f068ffa6e8b2a5f0b},
and Gabriel Becker.
}
\seealso{
\code{\link{redraw.recordedplot}}
}

0 comments on commit f201be8

Please sign in to comment.