Redocument with latest roxygen

Author: hadley

man/add_theme.Rd

@@ -6,13 +6,12 @@
 add_theme(t1, t2, t2name)
 }
 \arguments{
-  \item{t1}{A theme object}
+\item{t1}{A theme object}
 
-  \item{t2}{A theme object that is to be added to
-  \code{t1}}
+\item{t2}{A theme object that is to be added to \code{t1}}
 
-  \item{t2name}{A name of the t2 object. This is used for
-  printing informative error messages.}
+\item{t2name}{A name of the t2 object. This is used for printing
+  informative error messages.}
 }
 \description{
 Modify properties of an element in a theme object

man/aes.Rd

@@ -7,12 +7,11 @@ mapped to visual properties (aesthetics) of geoms.}
 aes(x, y, ...)
 }
 \arguments{
-  \item{x}{x value}
+\item{x}{x value}
 
-  \item{y}{y value}
+\item{y}{y value}
 
-  \item{...}{List of name value pairs giving aesthetics to
-  map.}
+\item{...}{List of name value pairs giving aesthetics to map.}
 }
 \description{
 \code{aes} creates a list of unevaluated expressions.  This function also

man/aes_all.Rd

@@ -6,7 +6,7 @@
 aes_all(vars)
 }
 \arguments{
-  \item{vars}{vector of variable names}
+\item{vars}{vector of variable names}
 }
 \description{
 Given a character vector, create a set of identity mappings

man/aes_auto.Rd

@@ -6,9 +6,9 @@
 aes_auto(data = NULL, ...)
 }
 \arguments{
-  \item{data}{data.frame or names of variables}
+\item{data}{data.frame or names of variables}
 
-  \item{...}{aesthetics that need to be explicitly mapped.}
+\item{...}{aesthetics that need to be explicitly mapped.}
 }
 \description{
 Automatic aesthetic mapping

man/aes_string.Rd

@@ -6,7 +6,7 @@
 aes_string(...)
 }
 \arguments{
-  \item{...}{List of name value pairs}
+\item{...}{List of name value pairs}
 }
 \description{
 Aesthetic mappings describe how variables in the data are mapped to visual

man/annotate.Rd

@@ -7,13 +7,13 @@ annotate(geom, x = NULL, y = NULL, xmin = NULL, xmax = NULL,
   ymin = NULL, ymax = NULL, ...)
 }
 \arguments{
-  \item{geom}{name of geom to use for annotation}
+\item{geom}{name of geom to use for annotation}
 
-  \item{x,y,xmin,ymin,xmax,ymax}{positionining aesthetics -
-  you must specify at least one of these.}
+\item{x,y,xmin,ymin,xmax,ymax}{positionining aesthetics - you must
+specify at least one of these.}
 
-  \item{...}{other aesthetics. These are not scaled so you
-  can do (e.g.)  \code{colour = "red"} to get a red point.}
+\item{...}{other aesthetics. These are not scaled so you can do (e.g.)
+\code{colour = "red"} to get a red point.}
 }
 \description{
 This function adds geoms to a plot. Unlike typical a geom function,

man/annotation_custom.Rd

@@ -7,13 +7,13 @@ annotation_custom(grob, xmin = -Inf, xmax = Inf, ymin = -Inf,
   ymax = Inf)
 }
 \arguments{
-  \item{grob}{grob to display}
+\item{grob}{grob to display}
 
-  \item{xmin,xmax}{x location (in data coordinates) giving
-  horizontal location of raster}
+\item{xmin,xmax}{x location (in data coordinates) giving horizontal
+location of raster}
 
-  \item{ymin,ymax}{y location (in data coordinates) giving
-  vertical location of raster}
+\item{ymin,ymax}{y location (in data coordinates) giving vertical
+location of raster}
 }
 \description{
 This is a special geom intended for use as static annnotations

man/annotation_logticks.Rd

@@ -9,42 +9,36 @@ annotation_logticks(base = 10, sides = "bl", scaled = TRUE,
   ...)
 }
 \arguments{
-  \item{base}{the base of the log (default 10)}
+\item{base}{the base of the log (default 10)}
 
-  \item{sides}{a string that controls which sides of the
-  plot the log ticks appear on.  It can be set to a string
-  containing any of \code{"trbl"}, for top, right, bottom,
-  and left.}
+\item{sides}{a string that controls which sides of the plot the log ticks appear on.
+It can be set to a string containing any of \code{"trbl"}, for top, right,
+bottom, and left.}
 
-  \item{short}{a \code{unit} object specifying the length
-  of the short tick marks}
+\item{short}{a \code{unit} object specifying the length of the short tick marks}
 
-  \item{mid}{a \code{unit} object specifying the length of
-  the middle tick marks.  In base 10, these are the "5"
-  ticks.}
+\item{mid}{a \code{unit} object specifying the length of the middle tick marks.
+In base 10, these are the "5" ticks.}
 
-  \item{long}{a \code{unit} object specifying the length of
-  the long tick marks.  In base 10, these are the "1" (or
-  "10") ticks.}
+\item{long}{a \code{unit} object specifying the length of the long tick marks.
+In base 10, these are the "1" (or "10") ticks.}
 
-  \item{scaled}{is the data already log-scaled? This should
-  be \code{TRUE} (default) when the data is already
-  transformed with \code{log10()} or when using
-  \code{scale_y_log10}. It should be \code{FALSE} when
-  using \code{coord_trans(y = "log10")}.}
+\item{scaled}{is the data already log-scaled? This should be \code{TRUE}
+(default) when the data is already transformed with \code{log10()} or when
+using \code{scale_y_log10}. It should be \code{FALSE} when using
+\code{coord_trans(y = "log10")}.}
 
-  \item{colour}{Colour of the tick marks.}
+\item{colour}{Colour of the tick marks.}
 
-  \item{size}{Thickness of tick marks, in mm.}
+\item{size}{Thickness of tick marks, in mm.}
 
-  \item{linetype}{Linetype of tick marks (\code{solid},
-  \code{dashed}, etc.)}
+\item{linetype}{Linetype of tick marks (\code{solid}, \code{dashed}, etc.)}
 
-  \item{alpha}{The transparency of the tick marks.}
+\item{alpha}{The transparency of the tick marks.}
 
-  \item{color}{An alias for \code{colour}.}
+\item{color}{An alias for \code{colour}.}
 
-  \item{...}{Other parameters passed on to the layer}
+\item{...}{Other parameters passed on to the layer}
 }
 \description{
 This annotation adds log tick marks with diminishing spacing.

man/annotation_map.Rd

@@ -6,11 +6,10 @@
 annotation_map(map, ...)
 }
 \arguments{
-  \item{map}{data frame representing a map.  Most map
-  objects can be converted into the right format by using
-  \code{\link{fortify}}}
+\item{map}{data frame representing a map.  Most map objects can be
+converted into the right format by using \code{\link{fortify}}}
 
-  \item{...}{other arguments used to modify aesthetics}
+\item{...}{other arguments used to modify aesthetics}
 }
 \description{
 Annotation: maps.

man/annotation_raster.Rd

@@ -6,16 +6,16 @@
 annotation_raster(raster, xmin, xmax, ymin, ymax, interpolate = FALSE)
 }
 \arguments{
-  \item{raster}{raster object to display}
+\item{raster}{raster object to display}
 
-  \item{xmin,xmax}{x location (in data coordinates) giving
-  horizontal location of raster}
+\item{xmin,xmax}{x location (in data coordinates) giving horizontal
+location of raster}
 
-  \item{ymin,ymax}{y location (in data coordinates) giving
-  vertical location of raster}
+\item{ymin,ymax}{y location (in data coordinates) giving vertical
+location of raster}
 
-  \item{interpolate}{If \code{TRUE} interpolate linearly,
-  if \code{FALSE} (the default) don't interpolate.}
+\item{interpolate}{If \code{TRUE} interpolate linearly, if \code{FALSE}
+(the default) don't interpolate.}
 }
 \description{
 This is a special version of \code{\link{geom_raster}} optimised for static