Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Re-roxygenize

  • Loading branch information...
commit cfdc26a2d2cd32a394c39e237c4908b0ab2e6bf5 1 parent c181c8c
@wch wch authored
View
1  DESCRIPTION
@@ -207,4 +207,3 @@ Collate:
'translate-qplot-lattice.r'
'annotation-logticks.r'
'utilities-help.r'
-
View
12 NAMESPACE
@@ -2,7 +2,6 @@ S3method("+",gg)
S3method("[",uneval)
S3method(as.character,uneval)
S3method(autoplot,default)
-S3method(cbind,gtable)
S3method(coord_aspect,default)
S3method(coord_aspect,fixed)
S3method(coord_aspect,map)
@@ -42,7 +41,6 @@ S3method(coord_transform,polar)
S3method(coord_transform,trans)
S3method(cweave,list)
S3method(cweave,matrix)
-S3method(dim,gtable)
S3method(drawDetails,dotstackGrob)
S3method(drawDetails,zeroGrob)
S3method(element_grob,element_blank)
@@ -88,7 +86,6 @@ S3method(fortify,summary.glht)
S3method(ggplot,data.frame)
S3method(ggplot,default)
S3method(grid.draw,absoluteGrob)
-S3method(grid.draw,gtable)
S3method(grobHeight,absoluteGrob)
S3method(grobHeight,zeroGrob)
S3method(grobWidth,absoluteGrob)
@@ -124,13 +121,11 @@ S3method(predictdf,loess)
S3method(print,element)
S3method(print,facet)
S3method(print,ggplot)
-S3method(print,gtable)
S3method(print,proto)
S3method(print,rel)
S3method(print,scale)
S3method(print,theme)
S3method(print,uneval)
-S3method(rbind,gtable)
S3method(rweave,list)
S3method(rweave,matrix)
S3method(scale_break_info,continuous)
@@ -169,6 +164,13 @@ S3method(scale_train,identity)
S3method(scale_train,position_d)
S3method(scale_transform,continuous)
S3method(scale_transform,discrete)
+S3method(scale_type,Date)
+S3method(scale_type,POSIXt)
+S3method(scale_type,character)
+S3method(scale_type,default)
+S3method(scale_type,factor)
+S3method(scale_type,logical)
+S3method(scale_type,numeric)
S3method(str,uneval)
S3method(summary,ggplot)
S3method(widthDetails,zeroGrob)
View
7 man/aes.Rd
@@ -24,6 +24,11 @@ aes(x = mpg, y = wt)
aes(x = mpg ^ 2, y = wt / cyl)
}
\seealso{
- \code{\link{aes_string}}
+ \code{\link{aes_string}} for passing quoted variable
+ names. \code{\link{aes_colour_fill_alpha}},
+ \code{\link{aes_group_order}},
+ \code{\link{aes_linetype_size_shape}} and
+ \code{\link{aes_position}} for more specific examples
+ with different aesthetics.
}
View
62 man/continuous_scale.Rd
@@ -10,12 +10,64 @@
trans = "identity", guide = "legend")
}
\arguments{
- \item{aesthetics}{character}
+ \item{minor_breaks}{Used with date or datetime scales.
+ Either \code{NULL} for no minor breaks, \code{waiver()}
+ for the default breaks (one minor break between each
+ major break), a numeric vector of positions, or a
+ function that given the limits returns a vector of minor
+ breaks.}
- \item{trans}{A transformation object, as created by
- \code{\link[scales]{trans_new}}. You can also give the
- name of the transformer: e.g. instead of
- \code{log2_trans()} you can use \code{"log2"}.}
+ \item{limits}{A numeric vector of length two describing
+ the scale limits.}
+
+ \item{rescaler}{Used by diverging and n colour gradients
+ (i.e. \code{\link{scale_colour_gradient2}},
+ \code{\link{scale_colour_gradientn}}).}
+
+ \item{oob}{What to do with values outside scale limits
+ (out of bounds)?}
+
+ \item{aesthetics}{the names of the aesthetics that this
+ scale works with}
+
+ \item{scale_name}{the name of the scale}
+
+ \item{palette}{a palette function that when called with a
+ single integer argument (the number of levels in the
+ scale) returns the values that they should take}
+
+ \item{name}{the name of the scale - used as the axis
+ label or the legend title}
+
+ \item{breaks}{control the breaks in the guide. There are
+ four possible types of input: \itemize{ \item
+ \code{NULL}: don't display any breaks \item a character
+ vector giving the breaks as they should appear on the
+ axis or in the legend. \item \code{waiver()} to use the
+ default break computation. \item a function, that when
+ called with a single argument, a character vector giving
+ the limits of the scale, returns a character vector
+ specifying which breaks to display. } This parameter
+ does not affect in any way how the data is scaled - it
+ only affects the appearance of the legend.}
+
+ \item{labels}{\code{NULL} for no labels, \code{waiver()}
+ for default labels (labels the same as breaks), a
+ character vector the same length as breaks, or a named
+ character vector whose names are used to match
+ replacement the labels for matching breaks.}
+
+ \item{legend}{deprecated. Use \code{guide} instead.}
+
+ \item{expand}{a numeric vector of length two, giving a
+ multiplicative and additive constant used to expand the
+ range of the scales so that there is a small gap between
+ the data and the axes.}
+
+ \item{na.value}{how should missing values be displayed?}
+
+ \item{guide}{the name of, or actual function, used to
+ create the guide.}
}
\description{
Continuous scale constructor.
View
2  man/coord_trans.Rd
@@ -20,7 +20,7 @@
}
\details{
All current transformations only work with continuous
- values - see \code{scale}{trans_new} for list of
+ values - see \code{\link[scales]{trans_new}} for list of
transformations, and instructions on how to create your
own.
}
View
2  man/discrete_scale.Rd
@@ -13,7 +13,7 @@
\item{scale_name}{the name of the scale}
- \item{palette}{a palette function that when call with a
+ \item{palette}{a palette function that when called with a
single integer argument (the number of levels in the
scale) returns the values that they should take}
View
2  man/fortify.sp.Rd
@@ -3,10 +3,10 @@
\alias{fortify.Lines}
\alias{fortify.Polygon}
\alias{fortify.Polygons}
-\alias{fortify.sp}
\alias{fortify.SpatialLinesDataFrame}
\alias{fortify.SpatialPolygons}
\alias{fortify.SpatialPolygonsDataFrame}
+\alias{fortify.sp}
\title{Fortify method for classes from the sp package.}
\usage{
\method{fortify}{SpatialPolygonsDataFrame} (model, data,
View
3  man/geom_density.Rd
@@ -42,6 +42,7 @@
# See stat_density for examples
}
\seealso{
- \code{\link{geom_histogram}} for the histogram
+ \code{\link{geom_histogram}} for the histogram and
+ \code{\link{stat_density}} for examples.
}
View
3  man/geom_quantile.Rd
@@ -49,4 +49,7 @@
\examples{
# See stat_quantile for examples
}
+\seealso{
+ See \code{\link{stat_quantile}} for examples.
+}
View
48 man/gtable.Rd
@@ -1,48 +0,0 @@
-\name{gtable}
-\alias{gtable}
-\title{Create a new table grid.}
-\usage{
- gtable(grobs = list(), layout = NULL, widths = list(),
- heights = list(), respect = FALSE, name = "layout")
-}
-\arguments{
- \item{grobs}{a list of grobs}
-
- \item{layout}{a data frame with one row for each grob,
- and columns \code{t}, \code{r}, \code{b}, \code{l} giving
- top, right, bottom and left positions respectively,
- \code{clip} a string, either \code{"on"}, \code{"off"} or
- \code{"inherit"}, and \code{name}, a character vector
- used to name each grob as it is plotted.}
-
- \item{widths}{a unit vector giving the width of each
- column}
-
- \item{height}{a unit vector giving the height of each
- row}
-
- \item{respect}{a logical vector of length 1: should the
- aspect ratio of height and width specified in null units
- be respected. See \code{\link{grid.layout}} for more
- details}
-
- \item{name}{a string giving the name of the table. This
- is used to name the layout viewport}
-}
-\description{
- A table grid captures all the information needed to
- layout grobs in a table structure. It supports row and
- column spanning, and offers some tools to automatically
- figure out correct dimensions.
-}
-\details{
- Each grob is put in its own viewport - grobs in the same
- location are not combined into one cell. Each grob takes
- up the entire cell viewport so justification control is
- not available.
-
- It constructs both the viewports and the gTree needed to
- display the table.
-}
-\keyword{internal}
-
View
3  man/position_fill.Rd
@@ -31,6 +31,9 @@ ggplot(diamonds, aes(x=price, fill=color)) + cde
}
}
\seealso{
+ See \code{\link{geom_bar}} and \code{\link{geom_area}}
+ for more examples.
+
Other position adjustments: \code{\link{position_dodge}},
\code{\link{position_identity}},
\code{\link{position_jitter}},
View
8 man/scale_date.Rd
@@ -3,11 +3,11 @@
\alias{scale_y_date}
\title{Position scale, date}
\usage{
- scale_x_date(..., expand = waiver(), breaks = waiver(),
- minor_breaks = waiver())
+ scale_x_date(..., expand = waiver(),
+ breaks = pretty_breaks(), minor_breaks = waiver())
- scale_y_date(..., expand = waiver(), breaks = waiver(),
- minor_breaks = waiver())
+ scale_y_date(..., expand = waiver(),
+ breaks = pretty_breaks(), minor_breaks = waiver())
}
\arguments{
\item{breaks}{A vector of breaks, a function that given
View
4 man/scale_datetime.Rd
@@ -4,10 +4,10 @@
\title{Position scale, date}
\usage{
scale_x_datetime(..., expand = waiver(),
- breaks = waiver(), minor_breaks = waiver())
+ breaks = pretty_breaks(), minor_breaks = waiver())
scale_y_datetime(..., expand = waiver(),
- breaks = waiver(), minor_breaks = waiver())
+ breaks = pretty_breaks(), minor_breaks = waiver())
}
\arguments{
\item{breaks}{A vector of breaks, a function that given
View
3  man/stat_abline.Rd
@@ -30,5 +30,8 @@
\examples{
# see geom_abline
}
+\seealso{
+ \code{\link{geom_abline}} for code examples.
+}
\keyword{internal}
View
3  man/stat_bindot.Rd
@@ -84,4 +84,7 @@
\examples{
# See geom_dotplot for examples
}
+\seealso{
+ See \code{\link{geom_dotplot}} for examples.
+}
View
3  man/stat_boxplot.Rd
@@ -54,4 +54,7 @@
\examples{
# See geom_boxplot for examples
}
+\seealso{
+ See \code{\link{geom_boxplot}} for examples.
+}
View
14 man/stat_ecdf.Rd
@@ -3,10 +3,11 @@
\title{Empirical Cumulative Density Function}
\usage{
stat_ecdf(mapping = NULL, data = NULL, geom = "step",
- position = "identity", n = 101, ...)
+ position = "identity", n = NULL, ...)
}
\arguments{
- \item{n}{number of points to interpolate along}
+ \item{n}{if NULL, do not interpolate. If not NULL, this
+ is the number of points to interpolate with.}
\item{mapping}{The aesthetic mapping, usually constructed
with \code{\link{aes}} or \code{\link{aes_string}}. Only
@@ -27,18 +28,15 @@
for more details.}
}
\value{
- a data.frame with additional columns: \item{x}{x's along
- a grid} \item{y}{cumulative density corresponding x}
+ a data.frame with additional columns: \item{x}{x in data}
+ \item{y}{cumulative density corresponding x}
}
\description{
Empirical Cumulative Density Function
}
\examples{
\donttest{
-l(ggplot2, T)
-set.seed(42)
-x <- c(rnorm(1000))
-qplot(x, stat = "ecdf", geom = "step")
+qplot(rnorm(1000), stat = "ecdf", geom = "step")
df <- data.frame(x = c(rnorm(100, 0, 3), rnorm(100, 0, 10)),
g = gl(2, 100))
View
3  man/stat_hline.Rd
@@ -30,5 +30,8 @@
\examples{
# see geom_hline
}
+\seealso{
+ \code{\link{geom_hline}} for code examples.
+}
\keyword{internal}
View
3  man/stat_vline.Rd
@@ -30,5 +30,8 @@
\examples{
# see geom_vline
}
+\seealso{
+ \code{\link{geom_vline}} for code examples.
+}
\keyword{internal}
View
7 man/stat_ydensity.Rd
@@ -56,10 +56,15 @@
}
\section{Aesthetics}{
\Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("stat",
- "unique")}
+ "ydensity")}
}
\examples{
# See geom_violin for examples
# Also see stat_density for similar examples with data along x axis
}
+\seealso{
+ \code{\link{geom_violin}} for examples, and
+ \code{\link{stat_density}} for examples with data along
+ the x axis.
+}
View
21 man/xlim.Rd
@@ -1,21 +0,0 @@
-\name{xlim}
-\alias{xlim}
-\title{Convenience function to set the limits of the x axis.}
-\usage{
- xlim(...)
-}
-\arguments{
- \item{...}{if numeric, will create a continuous scale, if
- factor or character, will create a discrete scale.}
-}
-\description{
- Convenience function to set the limits of the x axis.
-}
-\examples{
-xlim(15, 20)
-xlim(20, 15)
-xlim(c(10, 20))
-xlim("a", "b", "c")
-qplot(mpg, wt, data=mtcars) + xlim(15, 20)
-}
-
View
36 man/xylim.Rd
@@ -0,0 +1,36 @@
+\name{xlim}
+\alias{xlim}
+\alias{ylim}
+\title{Convenience functions to set the limits of the x and y axis.}
+\usage{
+ xlim(...)
+
+ ylim(...)
+}
+\arguments{
+ \item{...}{if numeric, will create a continuous scale, if
+ factor or character, will create a discrete scale.}
+}
+\description{
+ Observations not in this range will be dropped completely
+ and not passed to any other layers.
+}
+\examples{
+# xlim
+xlim(15, 20)
+xlim(20, 15)
+xlim(c(10, 20))
+xlim("a", "b", "c")
+qplot(mpg, wt, data=mtcars) + xlim(15, 20)
+
+# ylim
+ylim(15, 20)
+ylim(c(10, 20))
+ylim("a", "b", "c")
+qplot(mpg, wt, data=mtcars) + ylim(15, 20)
+}
+\seealso{
+ For changing x or y axis limits \strong{without} dropping
+ data observations, see \code{\link{coord_cartesian}}.
+}
+
View
20 man/ylim.Rd
@@ -1,20 +0,0 @@
-\name{ylim}
-\alias{ylim}
-\title{Convenience function to set the limits of the y axis.}
-\usage{
- ylim(...)
-}
-\arguments{
- \item{...}{if numeric, will create a continuous scale, if
- factor or character, will create a discrete scale.}
-}
-\description{
- Convenience function to set the limits of the y axis.
-}
-\examples{
-ylim(15, 20)
-ylim(c(10, 20))
-ylim("a", "b", "c")
-qplot(mpg, wt, data=mtcars) + ylim(15, 20)
-}
-
Please sign in to comment.
Something went wrong with that request. Please try again.