Permalink
Browse files

Update for/with latest version of roxygen

  • Loading branch information...
1 parent 06666e0 commit 4be99703a85035522c494d6e7b359e98797820c8 @hadley hadley committed Jul 14, 2011
Showing with 207 additions and 259 deletions.
  1. +1 −0 R/aes.r
  2. +1 −0 R/ggplot2.r
  3. +1 −0 R/grob-absolute.r
  4. +2 −0 R/utilities-matrix.r
  5. +2 −2 man/absoluteGrob.Rd
  6. +2 −6 man/aes.Rd
  7. +1 −1 man/aes_all.Rd
  8. +1 −4 man/aes_colour_fill_alpha.Rd
  9. +1 −4 man/aes_linetype_size_shape.Rd
  10. +5 −6 man/aes_string.Rd
  11. +1 −1 man/annotate.Rd
  12. +2 −1 man/benchplot.Rd
  13. +17 −0 man/continuous_scale.Rd
  14. +0 −3 man/coord.Rd
  15. +0 −3 man/coord_cartesian.Rd
  16. +0 −4 man/coord_fixed.Rd
  17. +0 −3 man/coord_flip.Rd
  18. +2 −4 man/coord_map.Rd
  19. +0 −3 man/coord_polar.Rd
  20. +2 −2 man/cweave.Rd
  21. +4 −5 man/diamonds.Rd
  22. +13 −0 man/discrete_scale.Rd
  23. +3 −4 man/economics.Rd
  24. +0 −3 man/expand_limits.Rd
  25. +0 −3 man/facet.Rd
  26. +0 −3 man/fortify.Rd
  27. +2 −5 man/fortify.lm.Rd
  28. +0 −3 man/fortify.map.Rd
  29. +0 −3 man/fortify.sp.Rd
  30. +2 −4 man/geom_abline.Rd
  31. +2 −4 man/geom_area.Rd
  32. +3 −5 man/geom_bar.Rd
  33. +0 −3 man/geom_blank.Rd
  34. +0 −3 man/geom_density.Rd
  35. +2 −4 man/geom_density2d.Rd
  36. +1 −1 man/geom_errorbarh.Rd
  37. +3 −5 man/geom_histogram.Rd
  38. +2 −4 man/geom_hline.Rd
  39. +0 −3 man/geom_jitter.Rd
  40. +1 −1 man/geom_path.Rd
  41. +2 −4 man/geom_point.Rd
  42. +0 −3 man/geom_quantile.Rd
  43. +0 −3 man/geom_tile.Rd
  44. +2 −4 man/geom_vline.Rd
  45. +2 −4 man/ggfluctuation.Rd
  46. +0 −3 man/ggmissing.Rd
  47. +2 −4 man/ggpcp.Rd
  48. +1 −3 man/ggplot-add.Rd
  49. +1 −1 man/ggplot.Rd
  50. +1 −1 man/ggplot.data.frame.Rd
  51. +0 −3 man/ggplot_build.Rd
  52. +0 −3 man/ggplot_gtable.Rd
  53. +3 −5 man/ggsave.Rd
  54. +2 −4 man/ggscale.Rd
  55. +2 −4 man/gtable.Rd
  56. +1 −4 man/label_bquote.Rd
  57. +2 −1 man/label_value.Rd
  58. +1 −1 man/labs.Rd
  59. +1 −1 man/limits.Rd
  60. +2 −2 man/midwest.Rd
  61. +4 −5 man/movies.Rd
  62. +4 −6 man/mpg.Rd
  63. +3 −5 man/msleep.Rd
  64. +1 −4 man/opts.Rd
  65. +1 −1 man/plotmatrix.Rd
  66. +2 −1 man/position_fill.Rd
  67. +1 −1 man/position_identity.Rd
  68. +1 −3 man/presidential.Rd
  69. +0 −4 man/qplot.Rd
  70. +1 −1 man/rweave.Rd
  71. +1 −5 man/scale_brewer.Rd
  72. +68 −0 man/scale_continuouss.Rd
  73. +1 −1 man/scale_date.Rd
  74. +1 −1 man/scale_datetime.Rd
  75. +0 −3 man/scale_discrete.Rd
  76. +1 −1 man/scale_gradient.Rd
  77. +1 −1 man/scale_gradient2.Rd
  78. +0 −3 man/scale_grey.Rd
  79. +0 −3 man/scale_linetype.Rd
  80. +0 −3 man/scale_shape.Rd
  81. +1 −3 man/seals.Rd
  82. +0 −3 man/stat_bin.Rd
  83. +1 −1 man/stat_hline.Rd
  84. +0 −3 man/stat_smooth.Rd
  85. +1 −1 man/stat_sum.Rd
  86. +2 −4 man/stat_summary.Rd
  87. +1 −1 man/stat_vline.Rd
  88. +1 −1 man/summary.ggplot.Rd
  89. +2 −1 man/theme_blank.Rd
  90. +0 −3 man/theme_line.Rd
  91. +0 −3 man/theme_rect.Rd
  92. +0 −3 man/theme_segment.Rd
  93. +0 −3 man/theme_update.Rd
  94. +1 −1 man/update_labels.Rd
  95. +2 −5 man/wrap_hmisc.Rd
View
@@ -78,6 +78,7 @@ is_position_aes <- function(vars) {
}
#' 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.
View
@@ -55,6 +55,7 @@ NULL
NULL
#' Midwest demographics.
+#'
#' Demographic information of midwest counties
#'
#' The variables are as follows:
View
@@ -1,4 +1,5 @@
#' Absolute grob
+#'
#' This grob has fixed dimesions and position.
#'
#' It's still experimental
View
@@ -1,4 +1,5 @@
#' Row weave.
+#'
#' Weave together two (or more) matrices by row.
#'
#' Matrices must have same dimensions.
@@ -37,6 +38,7 @@ cunion <- function(a, b) {
}
#' Col weave
+#'
#' Weave together two (or more) matrices by column
#'
#' Matrices must have same dimensions
View
@@ -1,12 +1,12 @@
\name{absoluteGrob}
\alias{absoluteGrob}
-\title{Absolute grob...}
+\title{Absolute grob}
\usage{
absoluteGrob(grob, width = NULL, height = NULL, xmin =
NULL, ymin = NULL)
}
\description{
- Absolute grob This grob has fixed dimesions and position.
+ This grob has fixed dimesions and position.
}
\details{
It's still experimental
View
@@ -1,6 +1,7 @@
\name{aes}
\alias{aes}
-\title{Generate aesthetic mappings that describe how variables in the data are...}
+\title{Generate aesthetic mappings that describe how variables in the data are
+mapped to visual properties (aesthetics) of geoms.}
\usage{
aes(x, y, ...)
}
@@ -12,11 +13,6 @@
\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
View
@@ -1,6 +1,6 @@
\name{aes_all}
\alias{aes_all}
-\title{Given a character vector, create a set of identity mappings...}
+\title{Given a character vector, create a set of identity mappings}
\usage{
aes_all(vars)
}
@@ -4,11 +4,8 @@
\alias{color}
\alias{colour}
\alias{fill}
-\title{Colour related aesthetics: colour, fill and alpha...}
+\title{Colour related aesthetics: colour, fill and alpha}
\description{
- Colour related aesthetics: colour, fill and alpha
-}
-\details{
This page demonstrates the usage of a sub-group of
aesthetics; colour, fill and alpha.
}
@@ -3,11 +3,8 @@
\alias{linetype}
\alias{shape}
\alias{size}
-\title{Differentiation related aesthetics: linetype, size, shape...}
+\title{Differentiation related aesthetics: linetype, size, shape}
\description{
- Differentiation related aesthetics: linetype, size, shape
-}
-\details{
This page demonstrates the usage of a sub-group of
aesthetics; linetype, size and shape.
}
View
@@ -1,18 +1,17 @@
\name{aes_string}
\alias{aes_string}
-\title{Generate aesthetic mappings from a string...}
+\title{Generate aesthetic mappings from a 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.
+ 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
View
@@ -1,6 +1,6 @@
\name{annotate}
\alias{annotate}
-\title{Annotate a plot...}
+\title{Annotate a plot}
\usage{
annotate(geom, x = NULL, y = NULL, xmin = NULL, xmax =
NULL, ymin = NULL, ymax = NULL, ...)
View
@@ -1,6 +1,7 @@
\name{benchplot}
\alias{benchplot}
-\title{Benchmark plot creation time.}
+\title{Benchmark plot creation time.
+Broken down into construct, build, render and draw times.}
\usage{
benchplot(x)
}
View
@@ -0,0 +1,17 @@
+\name{continuous_scale}
+\alias{continuous_scale}
+\title{Continuous scale constructor.}
+\usage{
+ continuous_scale(aesthetics, scale_name, palette, name =
+ NULL, breaks = NULL, labels = NULL, legend = TRUE, limits
+ = NULL, rescaler = rescale, oob = censor, expand = c(0,
+ 0), na.value = NA, trans = "identity")
+}
+\arguments{
+ \item{aesthetics}{character}
+}
+\description{
+ Continuous scale constructor.
+}
+\keyword{internal}
+
View
@@ -8,9 +8,6 @@
\item{...}{object fields}
}
\description{
- New coordinate system.
-}
-\details{
Internal use only.
}
\keyword{internal}
View
@@ -14,9 +14,6 @@
limits on the scales does}
}
\description{
- Cartesian coordinates.
-}
-\details{
The Cartesian coordinate system is the most familiar, and
common, type of coordinate system. Setting limits on the
coordinate system will zoom the plot (like you're looking
View
@@ -6,10 +6,6 @@
coord_fixed(ratio = 1)
}
\description{
- Cartesian coordinates with fixed relationship between x
- and y scales.
-}
-\details{
A fixed scale coordinate system forces a specified ratio
between the physical representation of data units on the
axes. The ratio represents the number of units on the
View
@@ -5,9 +5,6 @@
coord_flip(...)
}
\description{
- Flipped cartesian coordinates.
-}
-\details{
Flipped cartesian coordinates so that horizontal becomes
vertical, and vertical, horizontal. This is primarily
useful for converting geoms and statistics which display
View
@@ -24,12 +24,10 @@
latitude)}
}
\description{
- Map projections.
-}
-\details{
This coordinate system provides the full range of map
projections available in the mapproj package.
-
+}
+\details{
This is still experimental, and if you have any advice to
offer regarding a better (or more correct) way to do
this, please let me know
View
@@ -18,9 +18,6 @@
range of the data? (default: FALSE)}
}
\description{
- Polar coordinates.
-}
-\details{
The polar coordinate system is most commonly used for pie
charts, which are a stacked bar chart in polar
coordinates.
View
@@ -1,14 +1,14 @@
\name{cweave}
\alias{cweave}
-\title{Col weave...}
+\title{Col weave}
\usage{
cweave(...)
}
\arguments{
\item{...}{matrices to weave together}
}
\description{
- Col weave Weave together two (or more) matrices by column
+ Weave together two (or more) matrices by column
}
\details{
Matrices must have same dimensions
View
@@ -1,17 +1,16 @@
\docType{data}
\name{diamonds}
\alias{diamonds}
-\title{Prices of 50,000 round cut diamonds...}
+\title{Prices of 50,000 round cut diamonds}
+\format{A data frame with 53940 rows and 10 variables}
\usage{
data(diamonds)
}
\description{
- Prices of 50,000 round cut diamonds
-}
-\details{
A dataset containing the prices and other attributes of
almost 54,000 diamonds. The variables are as follows:
-
+}
+\details{
\itemize{ \item price. price in US dollars
(\$326--\$18,823) \item carat. weight of the diamond
(0.2--5.01) \item cut. quality of the cut (Fair, Good,
View
@@ -0,0 +1,13 @@
+\name{discrete_scale}
+\alias{discrete_scale}
+\title{Discrete scale constructor.}
+\usage{
+ discrete_scale(aesthetics, scale_name, palette, name =
+ NULL, breaks = NULL, labels = NULL, legend = TRUE, limits
+ = NULL, expand = c(0, 0), na.value = NA, drop = TRUE)
+}
+\description{
+ Discrete scale constructor.
+}
+\keyword{internal}
+
View
@@ -2,17 +2,16 @@
\name{economics}
\alias{economics}
\title{US economic time series.}
+\format{A data frame with 478 rows and 6 variables}
\usage{
data(economics)
}
\description{
- US economic time series.
-}
-\details{
This dataset was produced from US economic time series
data available from
\url{http://research.stlouisfed.org/fred2}.
-
+}
+\details{
\itemize{ \item date. Month of data collection
\item psavert, personal savings rate,
View
@@ -9,9 +9,6 @@
values) that should be included.}
}
\description{
- Expand the plot limits with data.
-}
-\details{
panels or all plots. This function is a thin wrapper
around \code{\link{geom_blank}} that makes it easy to add
such values.
View
@@ -11,9 +11,6 @@
not raw data}
}
\description{
- Facet specification.
-}
-\details{
Create new facetting specification. For internal use
only.
}
View
@@ -13,9 +13,6 @@
\item{...}{other arguments passed to methods}
}
\description{
- Fortify a model with data.
-}
-\details{
Method to convert a generic R object into a data frame
useful for plotting. Takes its name from the idea of
fortifying the original data with model fit statistics,
View
@@ -22,14 +22,11 @@
\item{.stdresid}{Standardised residuals}
}
\description{
- Supplement the data fitted to a linear model with model
- fit statistics.
-}
-\details{
If you have missing values in your model data, you may
need to refit the model with \code{na.action =
na.exclude}.
-
+}
+\details{
The following statistics will be added to the data frame:
}
\examples{
View
@@ -12,9 +12,6 @@
\item{...}{not used by this method}
}
\description{
- Fortify method for map objects.
-}
-\details{
This function turns a map into a data frame than can more
easily be plotted with ggplot2.
}
View
@@ -12,9 +12,6 @@
\item{...}{not used by this method}
}
\description{
- Fortify method for classes from the sp package.
-}
-\details{
To figure out the correct variable name for region,
inspect \code{as.data.frame(model)}.
}
View
@@ -6,12 +6,10 @@
position = "identity", ...)
}
\description{
- Line specified by slope and intercept.
-}
-\details{
The abline geom adds a line with specified slope and
intercept to the plot.
-
+}
+\details{
With its siblings \code{geom_hline} and
\code{geom_vline}, it's useful for annotating plots. You
can supply the parameters for geom_abline, intercept and
Oops, something went wrong.

0 comments on commit 4be9970

Please sign in to comment.