Permalink
Browse files

Rerun roxygen

  • Loading branch information...
1 parent d34d4ad commit 91d430a84ed21db24bf16ecea7d955ffc819cbfa @hadley hadley committed Jul 5, 2011
Showing with 2,131 additions and 1,454 deletions.
  1. +4 −4 man/absoluteGrob.Rd
  2. +15 −9 man/aes.Rd
  3. +9 −6 man/aes_all.Rd
  4. +15 −23 man/aes_colour_fill_alpha.Rd
  5. +16 −24 man/aes_linetype_size_shape.Rd
  6. +12 −8 man/aes_string.Rd
  7. +16 −6 man/annotate.Rd
  8. +10 −7 man/benchplot.Rd
  9. +6 −6 man/coord.Rd
  10. +18 −13 man/coord_cartesian.Rd
  11. +9 −7 man/coord_fixed.Rd
  12. +7 −5 man/coord_flip.Rd
  13. +25 −15 man/coord_map.Rd
  14. +25 −18 man/coord_polar.Rd
  15. +16 −12 man/coord_trans.Rd
  16. +17 −8 man/cut_interval.Rd
  17. +15 −7 man/cut_number.Rd
  18. +6 −6 man/cweave.Rd
  19. +4 −4 man/diamonds.Rd
  20. +4 −4 man/economics.Rd
  21. +13 −11 man/expand_limits.Rd
  22. +8 −6 man/facet.Rd
  23. +25 −19 man/facet_grid.Rd
  24. +7 −4 man/facet_null.Rd
  25. +21 −15 man/facet_wrap.Rd
  26. +13 −8 man/fortify.Rd
  27. +32 −26 man/fortify.lm.Rd
  28. +17 −11 man/fortify.map.Rd
  29. +9 −7 man/fortify.sp.Rd
  30. +16 −12 man/geom_abline.Rd
  31. +7 −5 man/geom_area.Rd
  32. +25 −20 man/geom_bar.Rd
  33. +8 −5 man/geom_bin2d.Rd
  34. +8 −6 man/geom_blank.Rd
  35. +22 −15 man/geom_boxplot.Rd
  36. +11 −6 man/geom_contour.Rd
  37. +18 −10 man/geom_crossbar.Rd
  38. +10 −6 man/geom_density.Rd
  39. +13 −8 man/geom_density2d.Rd
  40. +21 −14 man/geom_errorbar.Rd
  41. +16 −11 man/geom_errorbarh.Rd
  42. +13 −8 man/geom_freqpoly.Rd
  43. +7 −4 man/geom_hex.Rd
  44. +12 −10 man/geom_histogram.Rd
  45. +15 −10 man/geom_hline.Rd
  46. +15 −11 man/geom_jitter.Rd
  47. +16 −11 man/geom_line.Rd
  48. +19 −12 man/geom_linerange.Rd
  49. +26 −16 man/geom_path.Rd
  50. +24 −20 man/geom_point.Rd
  51. +15 −9 man/geom_pointrange.Rd
  52. +18 −12 man/geom_polygon.Rd
  53. +8 −6 man/geom_quantile.Rd
  54. +8 −5 man/geom_rect.Rd
  55. +14 −9 man/geom_ribbon.Rd
  56. +8 −5 man/geom_rug.Rd
  57. +18 −12 man/geom_segment.Rd
  58. +9 −6 man/geom_smooth.Rd
  59. +12 −9 man/geom_step.Rd
  60. +13 −10 man/geom_text.Rd
  61. +9 −7 man/geom_tile.Rd
  62. +17 −12 man/geom_vline.Rd
  63. +21 −13 man/ggfluctuation.Rd
  64. +22 −14 man/ggmissing.Rd
  65. +8 −6 man/ggorder.Rd
  66. +17 −10 man/ggpcp.Rd
  67. +9 −8 man/ggplot-add.Rd
  68. +10 −6 man/ggplot.Rd
  69. +17 −9 man/ggplot.data.frame.Rd
  70. +3 −4 man/ggplot2.Rd
  71. +11 −9 man/ggplot_build.Rd
  72. +16 −10 man/ggplot_gtable.Rd
  73. +31 −19 man/ggsave.Rd
  74. +0 −2 man/ggscale.Rd
  75. +10 −6 man/ggstructure.Rd
  76. +27 −18 man/gtable.Rd
  77. +6 −5 man/interleave.Rd
  78. +3 −2 man/is.coord.Rd
  79. +6 −5 man/is.facet.Rd
  80. +10 −6 man/label_both.Rd
  81. +13 −9 man/label_bquote.Rd
  82. +14 −8 man/label_parsed.Rd
  83. +11 −7 man/label_value.Rd
  84. +14 −10 man/labs.Rd
  85. +3 −2 man/last_plot.Rd
  86. +11 −7 man/limits.Rd
  87. +21 −14 man/map_data.Rd
  88. +9 −5 man/mean_se.Rd
  89. +6 −6 man/midwest.Rd
  90. +7 −5 man/movies.Rd
  91. +5 −5 man/mpg.Rd
  92. +7 −7 man/msleep.Rd
  93. +53 −18 man/opts.Rd
  94. +14 −8 man/plotmatrix.Rd
  95. +8 −5 man/position_dodge.Rd
  96. +7 −4 man/position_fill.Rd
  97. +3 −2 man/position_identity.Rd
  98. +15 −11 man/position_jitter.Rd
  99. +7 −4 man/position_stack.Rd
  100. +4 −4 man/presidential.Rd
  101. +12 −7 man/print.ggplot.Rd
  102. +58 −32 man/qplot.Rd
  103. +6 −6 man/rweave.Rd
  104. +16 −10 man/scale_alpha_continuous.Rd
  105. +8 −6 man/scale_alpha_discrete.Rd
  106. +10 −6 man/scale_area.Rd
  107. +10 −8 man/scale_colour_brewer.Rd
  108. +19 −12 man/scale_colour_gradient.Rd
  109. +12 −9 man/scale_colour_gradient2.Rd
  110. +14 −11 man/scale_colour_gradientn.Rd
  111. +12 −10 man/scale_colour_grey.Rd
  112. +11 −8 man/scale_colour_hue.Rd
  113. +14 −8 man/scale_colour_identity.Rd
  114. +7 −4 man/scale_colour_manual.Rd
  115. +22 −15 man/scale_continuous.Rd
  116. +8 −6 man/scale_linetype.Rd
  117. +8 −5 man/scale_shape.Rd
  118. +13 −9 man/scale_size_continuous.Rd
  119. +3 −2 man/scale_size_discrete.Rd
  120. +3 −2 man/scale_train.Rd
  121. +15 −12 man/scale_x_date.Rd
  122. +8 −5 man/scale_x_datetime.Rd
  123. +8 −6 man/scale_x_discrete.Rd
  124. +7 −5 man/seals.Rd
  125. +10 −7 man/should_stop.Rd
  126. +7 −4 man/stat_abline.Rd
  127. +32 −20 man/stat_bin.Rd
  128. +12 −7 man/stat_bin2d.Rd
  129. +11 −6 man/stat_binhex.Rd
  130. +16 −11 man/stat_boxplot.Rd
  131. +13 −8 man/stat_contour.Rd
  132. +29 −22 man/stat_density.Rd
  133. +21 −15 man/stat_density2d.Rd
  134. +19 −12 man/stat_function.Rd
  135. +7 −4 man/stat_hline.Rd
  136. +7 −4 man/stat_identity.Rd
  137. +23 −13 man/stat_qq.Rd
  138. +24 −14 man/stat_quantile.Rd
  139. +57 −42 man/stat_smooth.Rd
  140. +13 −8 man/stat_spoke.Rd
  141. +16 −9 man/stat_sum.Rd
  142. +30 −24 man/stat_summary.Rd
  143. +8 −5 man/stat_unique.Rd
  144. +7 −4 man/stat_vline.Rd
  145. +6 −3 man/summary.ggplot.Rd
  146. +0 −1 man/theme_blank.Rd
  147. +7 −5 man/theme_bw.Rd
  148. +9 −7 man/theme_grey.Rd
  149. +13 −9 man/theme_line.Rd
  150. +15 −10 man/theme_rect.Rd
  151. +13 −9 man/theme_segment.Rd
  152. +18 −8 man/theme_text.Rd
  153. +12 −10 man/theme_update.Rd
  154. +10 −6 man/update_labels.Rd
  155. +14 −10 man/wrap_hmisc.Rd
  156. +12 −9 man/xlim.Rd
  157. +12 −9 man/ylim.Rd
  158. +0 −1 man/zeroGrob.Rd
View
@@ -1,13 +1,13 @@
\name{absoluteGrob}
\alias{absoluteGrob}
\title{Absolute grob...}
-\usage{absoluteGrob(grob, width = NULL, height = NULL, xmin =
- NULL, ymin = NULL)}
-
+\usage{
+ absoluteGrob(grob, width = NULL, height = NULL, xmin =
+ NULL, ymin = NULL)
+}
\description{
Absolute grob This grob has fixed dimesions and position.
}
-
\details{
It's still experimental
}
View
@@ -1,26 +1,32 @@
\name{aes}
\alias{aes}
\title{Generate aesthetic mappings that describe how variables in the data are...}
-\usage{aes(x, y, ...)}
+\usage{
+ aes(x, y, ...)
+}
+\arguments{
+ \item{x}{x value}
+ \item{y}{y value}
+
+ \item{List}{of name value pairs}
+}
\description{
Generate aesthetic mappings that describe how variables
in the data are mapped to visual properties (aesthetics)
of geoms.
}
-
\details{
\code{aes} creates a list of unevaluated expressions.
This function also performs partial name matching,
converts color to colour, and old style R names to ggplot
names (eg. pch to shape, cex to size)
}
-\seealso{\code{\link{aes_string}}}
-\arguments{
- \item{x}{x value}
- \item{y}{y value}
- \item{List}{of name value pairs}
+\examples{
+aes(x = mpg, y = wt)
+aes(x = mpg ^ 2, y = wt / cyl)
+}
+\seealso{
+ \code{\link{aes_string}}
}
-\examples{aes(x = mpg, y = wt)
-aes(x = mpg ^ 2, y = wt / cyl)}
View
@@ -1,15 +1,18 @@
\name{aes_all}
\alias{aes_all}
\title{Given a character vector, create a set of identity mappings...}
-\usage{aes_all(vars)}
-
+\usage{
+ aes_all(vars)
+}
+\arguments{
+ \item{vars}{vector of variable names}
+}
\description{
Given a character vector, create a set of identity
mappings
}
-\arguments{
- \item{vars}{vector of variable names}
+\examples{
+aes_all(names(mtcars))
+aes_all(c("x", "y", "col", "pch"))
}
-\examples{aes_all(names(mtcars))
-aes_all(c("x", "y", "col", "pch"))}
@@ -1,28 +1,19 @@
\name{aes_colour_fill_alpha}
+\alias{aes_colour_fill_alpha}
+\alias{alpha}
+\alias{color}
+\alias{colour}
+\alias{fill}
\title{Colour related aesthetics: colour, fill and alpha...}
-
\description{
Colour related aesthetics: colour, fill and alpha
}
-\alias{colour}
-\alias{color}
-\alias{fill}
-\alias{alpha}
-\alias{This}
-\alias{page}
-\alias{demonstrates}
-\alias{the}
-\alias{usage}
-\alias{of}
-\alias{a}
-\alias{sub-group}
-\alias{of}
-\alias{aesthetics;}
-\alias{colour,}
-\alias{fill}
-\alias{and}
-\alias{alpha.}
-\examples{# Bar chart example
+\details{
+ This page demonstrates the usage of a sub-group of
+ aesthetics; colour, fill and alpha.
+}
+\examples{
+# Bar chart example
c <- ggplot(mtcars, aes(factor(cyl)))
# Default plotting
c + geom_bar()
@@ -58,16 +49,17 @@ h + geom_point()
h + geom_point(colour = alpha("black", .5))
h + geom_point(colour = alpha("black", 1/10))
-#If a geom uses both fill and colour, alpha will only modify the fill colour
+#If a geom uses both fill and colour, alpha will only modify the fill colour
c + geom_bar(fill = "dark grey", colour = "black")
c + geom_bar(fill = "dark grey", colour = "black", alpha = 1/3)
# Alpha can also be used to add shading
j <- b + geom_line()
j
yrng <- range(economics$unemploy)
-j <- j + geom_rect(aes(NULL, NULL, xmin = start, xmax = end, fill = party),
+j <- j + geom_rect(aes(NULL, NULL, xmin = start, xmax = end, fill = party),
ymin = yrng[1], ymax = yrng[2], data = presidential)
j
-j + scale_fill_manual(values = alpha(c("blue", "red"), .3))}
+j + scale_fill_manual(values = alpha(c("blue", "red"), .3))
+}
@@ -1,27 +1,18 @@
\name{aes_linetype_size_shape}
+\alias{aes_linetype_size_shape}
+\alias{linetype}
+\alias{shape}
+\alias{size}
\title{Differentiation related aesthetics: linetype, size, shape...}
-
\description{
Differentiation related aesthetics: linetype, size, shape
}
-\alias{linetype}
-\alias{size}
-\alias{shape}
-\alias{This}
-\alias{page}
-\alias{demonstrates}
-\alias{the}
-\alias{usage}
-\alias{of}
-\alias{a}
-\alias{sub-group}
-\alias{of}
-\alias{aesthetics;}
-\alias{linetype,}
-\alias{size}
-\alias{and}
-\alias{shape.}
-\examples{# Line types should be specified with either an integer, a name, or with a string of
+\details{
+ This page demonstrates the usage of a sub-group of
+ aesthetics; linetype, size and shape.
+}
+\examples{
+# Line types should be specified with either an integer, a name, or with a string of
# an even number (up to eight) of hexidecimal digits which give the lengths in
# consecutive positions in the string.
# 0 = blank, 1 = solid, 2 = dashed, 3 = dotted, 4 = dotdash, 5 = longdash, 6 = twodash
@@ -31,18 +22,18 @@ df <- data.frame(x = 1:10 , y = 1:10)
f <- ggplot(df, aes(x = x, y = y))
f + geom_line(linetype = 2)
f + geom_line(linetype = "dotdash")
-# An example with hex strings, the string "33" specifies three units on followed
-# by three off and "3313" specifies three units on followed by three off followed
+# An example with hex strings, the string "33" specifies three units on followed
+# by three off and "3313" specifies three units on followed by three off followed
# by one on and finally three off.
f + geom_line(linetype = "3313")
# Mapping line type from a variable
-ec_scaled <- data.frame(date = economics$date, rescaler(economics[, -(1:2)], "range"))
+ec_scaled <- data.frame(date = economics$date, rescaler(economics[, -(1:2)], "range"))
ecm <- melt(ec_scaled, id = "date")
qplot(date, value, data = ecm, geom = "line", linetype = variable)
# Size examples
-# Should be specified with a numerical value (in millimetres),
+# Should be specified with a numerical value (in millimetres),
# or from a variable source
p <- ggplot(mtcars, aes(wt, mpg))
p + geom_point(size = 4)
@@ -72,5 +63,6 @@ s + geom_point(aes(shape = z), size = 4)
# While all symbols have a foreground colour, symbols 19-25 also take a
# background colour (fill)
s + geom_point(aes(shape = z), size = 4, colour = "Red")
-s + geom_point(aes(shape = z), size = 4, colour = "Red", fill = "Black")}
+s + geom_point(aes(shape = z), size = 4, colour = "Red", fill = "Black")
+}
View
@@ -1,26 +1,30 @@
\name{aes_string}
\alias{aes_string}
\title{Generate aesthetic mappings from a string...}
-\usage{aes_string(...)}
-
+\usage{
+ aes_string(...)
+}
+\arguments{
+ \item{...}{List of name value pairs}
+}
\description{
Generate aesthetic mappings from a string Aesthetic
mappings describe how variables in the data are mapped to
visual properties (aesthetics) of geoms. Compared to aes
this function operates on strings rather than
expressions.
}
-
\details{
\code{aes_string} is particularly useful when writing
functions that create plots because you can use strings
to define the aesthetic mappings, rather than having to
mess around with expressions.
}
-\seealso{\code{\link{aes}}}
-\arguments{
- \item{...}{List of name value pairs}
+\examples{
+aes_string(x = "mpg", y = "wt")
+aes(x = mpg, y = wt)
+}
+\seealso{
+ \code{\link{aes}}
}
-\examples{aes_string(x = "mpg", y = "wt")
-aes(x = mpg, y = wt)}
View
@@ -1,21 +1,31 @@
\name{annotate}
\alias{annotate}
\title{Annotate a plot...}
-\usage{annotate(geom, x = NULL, y = NULL, xmin = NULL, xmax =
- NULL, ymin = NULL, ymax = NULL, ...)}
-
-\description{
- Annotate a plot
+\usage{
+ annotate(geom, x = NULL, y = NULL, xmin = NULL, xmax =
+ NULL, ymin = NULL, ymax = NULL, ...)
}
\arguments{
\item{name}{of geom to use for annotation}
+
\item{x}{x position}
+
\item{y}{y position}
+
\item{xmin}{xmin position}
+
\item{ymin}{ymin position}
+
\item{xmax}{xmax position}
+
\item{ymax}{ymax position}
+
\item{...}{other arguments passed to geom as parameters}
}
-\examples{annotate("text", x = 0, y = 0, label = "title")}
+\description{
+ Annotate a plot
+}
+\examples{
+annotate("text", x = 0, y = 0, label = "title")
+}
View
@@ -1,16 +1,19 @@
\name{benchplot}
\alias{benchplot}
\title{Benchmark plot creation time.}
-\usage{benchplot(x)}
-
+\usage{
+ benchplot(x)
+}
+\arguments{
+ \item{x}{code to create ggplot2 plot}
+}
\description{
Benchmark plot creation time. Broken down into construct,
build, render and draw times.
}
-\keyword{internal}
-\arguments{
- \item{x}{code to create ggplot2 plot}
+\examples{
+benchplot(qplot(mpg, wt, data = mtcars))
+benchplot(qplot(mpg, wt, data = mtcars) + facet_grid(.~ cyl))
}
-\examples{benchplot(qplot(mpg, wt, data = mtcars))
-benchplot(qplot(mpg, wt, data = mtcars) + facet_grid(.~ cyl))}
+\keyword{internal}
View
@@ -1,17 +1,17 @@
\name{coord}
\alias{coord}
\title{New coordinate system.}
-\usage{coord(..., subclass = c())}
-
+\usage{
+ coord(..., subclass = c())
+}
+\arguments{
+ \item{...}{object fields}
+}
\description{
New coordinate system.
}
-
\details{
Internal use only.
}
\keyword{internal}
-\arguments{
- \item{...}{object fields}
-}
Oops, something went wrong.

0 comments on commit 91d430a

Please sign in to comment.