Use examplesIf, r-lib/roxygen2#993

Author: krlmlr

R/dm-from-src.R

@@ -26,25 +26,19 @@
 #' @return A `dm` object.
 #'
 #' @export
-#' @examples
-#' dm_from_src_demo <- function() {
-#'   if (!rlang::is_installed("DBI")) {
-#'     message("Install the DBI package to run this example.")
-#'   }
+#' @examplesIf rlang::is_installed("RMariaDB")
+#' \dontrun{
+#' con <- DBI::dbConnect(
+#'   RMariaDB::MariaDB(),
+#'   username = "guest",
+#'   password = "relational",
+#'   dbname = "Financial_ijs",
+#'   host = "relational.fit.cvut.cz"
+#' )
 #'
-#'   con <- DBI::dbConnect(
-#'     RMariaDB::MariaDB(),
-#'     username = "guest",
-#'     password = "relational",
-#'     dbname = "Financial_ijs",
-#'     host = "relational.fit.cvut.cz"
-#'   )
-#'   on.exit(DBI::dbDisconnect(con))
+#' dm_from_src(con)
 #'
-#'   dm_from_src(con)
-#' }
-#' \dontrun{
-#' dm_from_src_demo()
+#' DBI::dbDisconnect(con)
 #' }
 dm_from_src <- function(src = NULL, table_names = NULL, learn_keys = NULL,
                         ...) {

R/financial.R

@@ -11,12 +11,10 @@
 #' @return A `dm` object.
 #'
 #' @export
-#' @examples
+#' @examplesIf rlang::is_installed("RMariaDB")
 #' \dontrun{
-#' if (rlang::is_installed("RMariaDB")) {
-#'   dm_financial() %>%
-#'     dm_draw()
-#' }
+#' dm_financial() %>%
+#'   dm_draw()
 #' }
 dm_financial <- function() {
   stopifnot(rlang::is_installed("RMariaDB"))

R/foreign-keys.R

@@ -32,19 +32,11 @@
 #' @return For `dm_add_fk()`: An updated `dm` with an additional foreign key relation.
 #'
 #' @export
-#' @examples
-#' if (rlang::is_installed("nycflights13")) {
-#'   nycflights_dm <- dm(
-#'     planes = nycflights13::planes,
-#'     flights = nycflights13::flights
-#'   )
-#' } else {
-#'   message("Using mock-up data, install the nycflights13 package to fix.")
-#'   nycflights_dm <- dm(
-#'     planes = tibble(tailnum = character()),
-#'     flights = tibble(tailnum = character())
-#'   )
-#' }
+#' @examplesIf rlang::is_installed("nycflights13")
+#' nycflights_dm <- dm(
+#'   planes = nycflights13::planes,
+#'   flights = nycflights13::flights
+#' )
 #'
 #' nycflights_dm %>%
 #'   dm_draw()

R/nycflights13.R

@@ -20,11 +20,9 @@
 #' @return A `dm` object consisting of {nycflights13} tables, complete with primary and foreign keys and optionally colored.
 #'
 #' @export
-#' @examples
-#' if (rlang::is_installed("nycflights13")) {
-#'   dm_nycflights13() %>%
-#'     dm_draw()
-#' }
+#' @examplesIf rlang::is_installed("nycflights13") && rlang::is_installed("DiagrammeR")
+#' dm_nycflights13() %>%
+#'   dm_draw()
 dm_nycflights13 <- function(cycle = FALSE, color = TRUE, subset = TRUE) {
   airlines <- nycflights13::airlines
   airports <- nycflights13::airports

R/primary-keys.R

@@ -29,19 +29,11 @@
 #' @return For `dm_add_pk()`: An updated `dm` with an additional primary key.
 #'
 #' @export
-#' @examples
-#' if (rlang::is_installed("nycflights13")) {
-#'   nycflights_dm <- dm(
-#'     planes = nycflights13::planes,
-#'     airports = nycflights13::airports
-#'   )
-#' } else {
-#'   message("Using mock-up data, install the nycflights13 package to fix.")
-#'   nycflights_dm <- dm(
-#'     planes = tibble(tailnum = letters[1:2], manufacturer = "Acme"),
-#'     airports = tibble(faa = character())
-#'   )
-#' }
+#' @examplesIf rlang::is_installed("nycflights13")
+#' nycflights_dm <- dm(
+#'   planes = nycflights13::planes,
+#'   airports = nycflights13::airports
+#' )
 #'
 #' nycflights_dm %>%
 #'   dm_draw()
@@ -52,7 +44,7 @@
 #'   dm_add_pk(airports, faa, check = TRUE) %>%
 #'   dm_draw()
 #'
-#' # the following does not work (throws an error)
+#' # the following throws an error:
 #' try(
 #'   nycflights_dm %>%
 #'     dm_add_pk(planes, manufacturer, check = TRUE)