Reduce run-time of long examples (#2575)

* Reduce run time of vars() examples

* Reduce run times of other long examples

To ensure they take less than 5s

Author: hadley

R/facet-.r

@@ -173,7 +173,6 @@ Facet <- ggproto("Facet", NULL,
 #' Quote faceting variables
 #'
 #' @description
-#'
 #' Just like [aes()], `vars()` is a [quoting function][rlang::quotation]
 #' that takes inputs to be evaluated in the context of a dataset.
 #' These inputs can be:
@@ -192,20 +191,19 @@ Facet <- ggproto("Facet", NULL,
 #' @seealso [aes()], [facet_wrap()], [facet_grid()]
 #' @export
 #' @examples
-#' p <- ggplot(diamonds) + geom_point(aes(carat, price))
-#' p + facet_wrap(vars(cut, clarity))
+#' p <- ggplot(mtcars, aes(wt, disp)) + geom_point()
+#' p + facet_wrap(vars(vs, am))
 #'
 #' # vars() makes it easy to pass variables from wrapper functions:
 #' wrap_by <- function(...) {
 #'   facet_wrap(vars(...), labeller = label_both)
 #' }
-#' p + wrap_by(cut)
-#' p + wrap_by(cut, clarity)
-#'
+#' p + wrap_by(vs)
+#' p + wrap_by(vs, am)
 #'
 #' # You can also supply expressions to vars(). In this case it's often a
 #' # good idea to supply a name as well:
-#' p + wrap_by(depth = cut_number(depth, 3))
+#' p + wrap_by(drat = cut_number(drat, 3))
 #'
 #' # Let's create another function for cutting and wrapping a
 #' # variable. This time it will take a named argument instead of dots,
@@ -225,7 +223,7 @@ Facet <- ggproto("Facet", NULL,
 #' }
 #'
 #' # Thanks to tidy eval idioms we now have another useful wrapper:
-#' p + wrap_cut(depth)
+#' p + wrap_cut(drat)
 vars <- function(...) {
   rlang::quos(...)
 }

R/facet-grid-.r

@@ -62,14 +62,16 @@ NULL
 #' p <- ggplot(mpg, aes(displ, cty)) + geom_point()
 #'
 #' # Use vars() to supply variables from the dataset:
-#' p + facet_grid(vars(drv))
+#' p + facet_grid(rows = vars(drv))
 #' p + facet_grid(cols = vars(cyl))
 #' p + facet_grid(vars(drv), vars(cyl))
 #'
 #' # The historical formula interface is also available:
+#' \donttest{
 #' p + facet_grid(. ~ cyl)
 #' p + facet_grid(drv ~ .)
 #' p + facet_grid(drv ~ cyl)
+#' }
 #'
 #' # To change plot order of facet grid,
 #' # change the order of variable levels with factor()
@@ -99,50 +101,17 @@ NULL
 #'   facet_grid(manufacturer ~ ., scales = "free", space = "free") +
 #'   theme(strip.text.y = element_text(angle = 0))
 #'
-#' # Facet labels ------------------------------------------------------
-#' p <- ggplot(mtcars, aes(wt, mpg)) + geom_point()
-#' p
-#'
-#' # label_both() displays both variable name and value
-#' p + facet_grid(vars(vs), vars(cyl), labeller = label_both)
-#'
-#' # With vars() it is easy to pass custom names for the faceting groups:
-#' p + facet_grid(vars(`V/S` = vs), vars(cylinder = cyl), labeller = label_both)
-#'
-#' # label_parsed() parses text into mathematical expressions, see ?plotmath
-#' mtcars$cyl2 <- factor(mtcars$cyl, labels = c("alpha", "beta", "sqrt(x, y)"))
-#' ggplot(mtcars, aes(wt, mpg)) +
-#'   geom_point() +
-#'   facet_grid(. ~ cyl2, labeller = label_parsed)
-#'
-#' # label_bquote() makes it easy to construct math expressions
-#' p + facet_grid(. ~ vs, labeller = label_bquote(cols = alpha ^ .(vs)))
-#'
-#' # The facet strips can be displayed near the axes with switch
-#' data <- transform(mtcars,
-#'   am = factor(am, levels = 0:1, c("Automatic", "Manual")),
-#'   gear = factor(gear, levels = 3:5, labels = c("Three", "Four", "Five"))
-#' )
-#' p <- ggplot(data, aes(mpg, disp)) + geom_point()
-#' p + facet_grid(am ~ gear, switch = "both")
-#' # It looks better without boxes around the strips
-#' p + facet_grid(am ~ gear, switch = "both") +
-#'   theme(strip.background = element_blank())
-#'
 #' # Margins ----------------------------------------------------------
 #' \donttest{
 #' # Margins can be specified by logically (all yes or all no) or by specific
 #' # variables as (character) variable names
 #' mg <- ggplot(mtcars, aes(x = mpg, y = wt)) + geom_point()
-#' mg + facet_grid(vs + am ~ gear)
 #' mg + facet_grid(vs + am ~ gear, margins = TRUE)
 #' mg + facet_grid(vs + am ~ gear, margins = "am")
 #' # when margins are made over "vs", since the facets for "am" vary
 #' # within the values of "vs", the marginal facet for "vs" is also
 #' # a margin over "am".
 #' mg + facet_grid(vs + am ~ gear, margins = "vs")
-#' mg + facet_grid(vs + am ~ gear, margins = "gear")
-#' mg + facet_grid(vs + am ~ gear, margins = c("gear", "am"))
 #' }
 facet_grid <- function(rows = NULL, cols = NULL, scales = "fixed",
                        space = "fixed", shrink = TRUE,

R/facet-wrap.r

@@ -42,11 +42,7 @@ NULL
 #' # You can facet by multiple variables
 #' ggplot(mpg, aes(displ, hwy)) +
 #'   geom_point() +
-#'   facet_wrap(~ cyl + drv)
-#' # Or use a character vector:
-#' ggplot(mpg, aes(displ, hwy)) +
-#'   geom_point() +
-#'   facet_wrap(c("cyl", "drv"))
+#'   facet_wrap(vars(cyl, drv))
 #'
 #' # Use the `labeller` option to control how labels are printed:
 #' ggplot(mpg, aes(displ, hwy)) +

R/geom-point.r

@@ -49,10 +49,6 @@
 #' p + geom_point(aes(shape = factor(cyl)))
 #' p + geom_point(aes(size = qsec))
 #'
-#' # Change scales
-#' p + geom_point(aes(colour = cyl)) + scale_colour_gradient(low = "blue")
-#' p + geom_point(aes(shape = factor(cyl))) + scale_shape(solid = FALSE)
-#'
 #' # Set aesthetics to fixed value
 #' ggplot(mtcars, aes(wt, mpg)) + geom_point(colour = "red", size = 3)
 #'

R/guide-legend.r

@@ -68,18 +68,10 @@
 #' p2 <- p1 + geom_point(aes(size = value))
 #'
 #' # Basic form
-#' p1 + scale_fill_continuous(guide = "legend")
 #' p1 + scale_fill_continuous(guide = guide_legend())
 #'
-#' # Guide title
-#' p1 + scale_fill_continuous(guide = guide_legend(title = "V")) # title text
-#' p1 + scale_fill_continuous(guide = guide_legend(title = NULL)) # no title
-#'
 #' # Control styles
 #'
-#' # key size
-#' p1 + guides(fill = guide_legend(keywidth = 3, keyheight = 1))
-#'
 #' # title position
 #' p1 + guides(fill = guide_legend(title = "LEFT", title.position = "left"))
 #'
@@ -112,12 +104,10 @@
 #' )
 #'
 #' # Set aesthetic of legend key
-#'
 #' # very low alpha value make it difficult to see legend key
-#' p3 <- ggplot(diamonds, aes(carat, price)) +
-#'   geom_point(aes(colour = color), alpha = 1/100)
+#' p3 <- ggplot(mtcars, aes(vs, am, colour = factor(cyl))) +
+#'   geom_jitter(alpha = 1/5, width = 0.01, height = 0.01)
 #' p3
-#'
 #' # override.aes overwrites the alpha
 #' p3 + guides(colour = guide_legend(override.aes = list(alpha = 1)))
 #'
@@ -128,17 +118,9 @@
 #' p + guides(col = guide_legend(nrow = 8))
 #' p + guides(col = guide_legend(ncol = 8))
 #' p + guides(col = guide_legend(nrow = 8, byrow = TRUE))
-#' p + guides(col = guide_legend(ncol = 8, byrow = TRUE))
 #'
 #' # reversed order legend
 #' p + guides(col = guide_legend(reverse = TRUE))
-#'
-#' # hide some aesthetics from the legend
-#' p4 <- ggplot(mtcars, aes(mpg, qsec, colour = factor(vs), shape = factor(am))) +
-#'   geom_point()
-#' p4 + geom_line()
-#' p4 + geom_line(show.legend = c(color = FALSE))
-#'
 #' }
 guide_legend <- function(# title
                          title = waiver(),

R/labeller.r

@@ -69,8 +69,7 @@
 #' mtcars$cyl2 <- factor(mtcars$cyl, labels = c("alpha", "beta", "gamma"))
 #' p <- ggplot(mtcars, aes(wt, mpg)) + geom_point()
 #'
-#' # Displaying only the values
-#' p + facet_grid(. ~ cyl)
+#' # The default is label_value
 #' p + facet_grid(. ~ cyl, labeller = label_value)
 #'
 #' \donttest{
@@ -84,7 +83,6 @@
 #' # Interpreting the labels as plotmath expressions
 #' p + facet_grid(. ~ cyl2)
 #' p + facet_grid(. ~ cyl2, labeller = label_parsed)
-#' p + facet_wrap(~vs + cyl2, labeller = label_parsed)
 #' }
 #' @name labellers
 NULL
@@ -364,12 +362,16 @@ as_labeller <- function(x, default = label_value, multi_line = TRUE) {
 #' p1 <- ggplot(mtcars, aes(x = mpg, y = wt)) + geom_point()
 #'
 #' # You can assign different labellers to variables:
-#' p1 + facet_grid(vs + am ~ gear,
-#'   labeller = labeller(vs = label_both, am = label_value))
+#' p1 + facet_grid(
+#'   vs + am ~ gear,
+#'   labeller = labeller(vs = label_both, am = label_value)
+#' )
 #'
 #' # Or whole margins:
-#' p1 + facet_grid(vs + am ~ gear,
-#'   labeller = labeller(.rows = label_both, .cols = label_value))
+#' p1 + facet_grid(
+#'   vs + am ~ gear,
+#'   labeller = labeller(.rows = label_both, .cols = label_value)
+#' )
 #'
 #' # You can supply functions operating on strings:
 #' capitalize <- function(string) {
@@ -399,9 +401,8 @@ as_labeller <- function(x, default = label_value, multi_line = TRUE) {
 #' # then apply a wrap labeller to the columns to prevent cropped text
 #' msleep$conservation2 <- plyr::revalue(msleep$conservation,
 #'   conservation_status)
-#'
-#' p2 %+% msleep + facet_grid(vore ~ conservation2)
-#' p2 %+% msleep +
+#' p3 <- ggplot(msleep, aes(x = sleep_total, y = awake)) + geom_point()
+#' p3 +
 #'   facet_grid(vore ~ conservation2,
 #'     labeller = labeller(conservation2 = label_wrap_gen(10))
 #'   )
@@ -418,8 +419,7 @@ as_labeller <- function(x, default = label_value, multi_line = TRUE) {
 #' )
 #'
 #' p2 + facet_grid(vore ~ conservation, labeller = global_labeller)
-#' p2 + facet_wrap(~vore, labeller = global_labeller)
-#' p2 %+% msleep + facet_wrap(~conservation2, labeller = global_labeller)
+#' p3 + facet_wrap(~conservation2, labeller = global_labeller)
 #' }
 labeller <- function(..., .rows = NULL, .cols = NULL,
                      keep.as.numeric = NULL, .multi_line = TRUE,