Improve dontrun usage

Author: hadley

DESCRIPTION

@@ -29,6 +29,7 @@ Suggests:
     ggplot2movies,
     hexbin,
     Hmisc,
+    lattice,
     mapproj,
     maps,
     maptools,
@@ -38,6 +39,7 @@ Suggests:
     testthat (>= 0.11.0),
     quantreg,
     knitr,
+    rpart,
     rmarkdown,
     svglite
 Enhances: sp

R/annotation-custom.r

@@ -26,16 +26,13 @@ NULL
 #' base <- ggplot(df, aes(x, y)) +
 #'   geom_blank() +
 #'   theme_bw()
-#' # Adding a table
-#' \dontrun{
-#'  if (require(gridExtra)) {
-#' base + annotation_custom(grob = tableGrob(head(iris[ ,1:3])),
-#'         xmin = 3, xmax = 6, ymin = 2, ymax = 8)
-#' # full panel
-#' base + annotation_custom(grob = roundrectGrob(),
-#'           xmin = -Inf, xmax = Inf, ymin = -Inf, ymax = Inf)
-#' }
-#' }
+#'
+#' # Full panel annotation
+#' base + annotation_custom(
+#'   grob = grid::roundrectGrob(),
+#'   xmin = -Inf, xmax = Inf, ymin = -Inf, ymax = Inf
+#' )
+#'
 #' # Inset plot
 #' df2 <- data.frame(x = 1 , y = 1)
 #' g <- ggplotGrob(ggplot(df2, aes(x, y)) +

R/facet-grid-.r

@@ -107,7 +107,7 @@
 #'   theme(strip.background = element_blank())
 #'
 #' # Margins ----------------------------------------------------------
-#' \dontrun{
+#' \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()

R/facet-wrap.r

@@ -425,7 +425,7 @@ facet_vars.wrap <- function(facet) {
 #' # Valid input just gets returns unchanged
 #' sanitise_dim(1)
 #' sanitise_dim(NULL)
-#' \dontrun{
+#'
 #' # Only the first element of vectors get returned
 #' sanitise_dim(10:1)
 #' # Non-integer values are coerced to integer
@@ -435,7 +435,6 @@ facet_vars.wrap <- function(facet) {
 #' sanitise_dim(NA_integer_)
 #' sanitise_dim(0)
 #' sanitise_dim("foo")
-#' }
 #' @noRd
 sanitise_dim <- function(n) {
   xname <- paste0("`", deparse(substitute(n)), "`")

R/geom-blank.r

@@ -7,21 +7,8 @@
 #' @inheritParams layer
 #' @inheritParams geom_point
 #' @examples
-#' ggplot(mtcars, aes(wt, mpg)) + geom_blank()
+#' ggplot(mtcars, aes(wt, mpg))
 #' # Nothing to see here!
-#'
-#' # Take the following scatter plot
-#' a <- ggplot(mtcars, aes(x = wt, y = mpg), . ~ cyl) + geom_point()
-#' # Add to that some lines with geom_abline()
-#' df <- data.frame(a = rnorm(10, 25), b = rnorm(10, 0))
-#' a + geom_abline(aes(intercept = a, slope = b), data = df)
-#' # Suppose you then wanted to remove the geom_point layer
-#' # If you just remove geom_point, you will get an error
-#' b <- ggplot(mtcars, aes(x = wt, y = mpg))
-#' \dontrun{b + geom_abline(aes(intercept = a, slope = b), data = df)}
-#' # Switching to geom_blank() gets the desired plot
-#' c <- ggplot(mtcars, aes(x = wt, y = mpg)) + geom_blank()
-#' c + geom_abline(aes(intercept = a, slope = b), data = df)
 geom_blank <- function(mapping = NULL, data = NULL,
                        stat = "identity", position = "identity",
                        ...,

R/geom-smooth.r

@@ -56,13 +56,12 @@
 #'   geom_smooth(span = 0.8) +
 #'   facet_wrap(~drv)
 #'
-#' \dontrun{
-#' # To fit a logistic regression, you need to coerce the values to
-#' # a numeric vector lying between 0 and 1.
+#' \donttest{
 #' binomial_smooth <- function(...) {
 #'   geom_smooth(method = "glm", method.args = list(family = "binomial"), ...)
 #' }
-#'
+#' # To fit a logistic regression, you need to coerce the values to
+#' # a numeric vector lying between 0 and 1.
 #' ggplot(rpart::kyphosis, aes(Age, Kyphosis)) +
 #'   geom_jitter(height = 0.05) +
 #'   binomial_smooth()

R/geom-text.r

@@ -51,6 +51,7 @@
 #' p + geom_point() + geom_text(vjust = 0, nudge_y = 0.5)
 #' p + geom_point() + geom_text(angle = 45)
 #' \dontrun{
+#' # Doesn't work on all systems
 #' p + geom_text(family = "Times New Roman")
 #' }
 #'

R/theme.r

@@ -340,35 +340,6 @@ print.theme <- function(x, ...) utils::str(x)
 #' p + mytheme
 #'
 #' }
-#'
-#' \dontrun{
-#' ## Run this to generate a graph of the element inheritance tree
-#' build_element_graph <- function(tree) {
-#'   require(igraph)
-#'   require(plyr)
-#'
-#'   inheritdf <- function(name, item) {
-#'     if (length(item$inherit) == 0)
-#'       data.frame()
-#'     else
-#'       data.frame(child = name, parent = item$inherit)
-#'   }
-#'
-#'   edges <- plyr::rbind.fill(mapply(inheritdf, names(tree), tree))
-#'
-#'   # Explicitly add vertices (since not all are in edge list)
-#'   vertices <- data.frame(name = names(tree))
-#'   graph.data.frame(edges, vertices = vertices)
-#' }
-#'
-#' g <- build_element_graph(ggplot2:::.element_tree)
-#' V(g)$label <- V(g)$name
-#'
-#' set.seed(324)
-#' par(mar=c(0,0,0,0)) # Remove unnecessary margins
-#' plot(g, layout=layout.fruchterman.reingold, vertex.size=4, vertex.label.dist=.25)
-#'
-#' }
 theme <- function(..., complete = FALSE, validate = TRUE) {
   elements <- list(...)
 

R/translate-qplot-lattice.r

@@ -1,12 +1,12 @@
 #' Translating between qplot and lattice
 #'
-#' The major difference between lattice and ggplot2 is that lattice uses a formula based
-#' interface. ggplot2 does not because the formula does not generalise well
-#' to more complicated situations.
+#' The major difference between lattice and ggplot2 is that lattice uses a
+#' formula based interface. ggplot2 does not because the formula does not
+#' generalise well to more complicated situations.
 #'
 #' @name translate_qplot_lattice
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' library(lattice)
 #'
 #' if (require("ggplot2movies")) {
@@ -29,13 +29,10 @@
 #' qplot(rating, data = movies, geom = "histogram")
 #'
 #' bwplot(Comedy ~ rating ,data = movies)
-#' qplot(factor(Comedy), rating, data = movies, type = "boxplot")
+#' qplot(factor(Comedy), rating, data = movies, geom = "boxplot")
 #'
 #' xyplot(wt ~ mpg, mtcars, type = c("p","smooth"))
 #' qplot(mpg, wt, data = mtcars, geom = c("point","smooth"))
-#'
-#' xyplot(wt ~ mpg, mtcars, type = c("p","r"))
-#' qplot(mpg, wt, data = mtcars, geom = c("point","smooth"), method = "lm")
 #' }
 #'
 #' # The capabilities for scale manipulations are similar in both ggplot2 and

cran-comments.md

@@ -1,3 +1,7 @@
+This is a resubmission, post-review of \dontrun{} usage. Now \dontrun{} is only used in two places: an example that fails on some platforms, and an ggsave() examples which save files on disk.
+
+---------------------------------
+
 ## Test environments
 * OS X, R 3.2.3
 * Ubuntu 14.04, R 3.2.3