reducing time of examples

larmarange · Jul 5, 2022 · f751ee9 · f751ee9
1 parent 5409a74
commit f751ee9
Show file tree

Hide file tree

Showing 14 changed files with 81 additions and 71 deletions.
diff --git a/R/model_compute_terms_contributions.R b/R/model_compute_terms_contributions.R
@@ -12,7 +12,7 @@
 #' @param model a model object
 #' @export
 #' @family model_helpers
-#' @examples
+#' @examplesIf interactive()
 #' mod <- lm(Sepal.Length ~ Sepal.Width, iris)
 #' mod %>% model_compute_terms_contributions()
 #'

diff --git a/R/select_helpers.R b/R/select_helpers.R
@@ -21,7 +21,7 @@
 #' `c("treatment", "sum", "poly", "helmert", "other")`
 #'
 #' @return A character vector of column names selected
-#' @examples
+#' @examplesIf interactive()
 #' glm(response ~ age * trt + grade, gtsummary::trial, family = binomial) %>%
 #'   tidy_plus_plus(exponentiate = TRUE, include = all_categorical())
 #'

diff --git a/R/tidy_add_header_rows.R b/R/tidy_add_header_rows.R
@@ -27,7 +27,7 @@
 #' @inheritParams tidy_plus_plus
 #' @export
 #' @family tidy_helpers
-#' @examplesIf .assert_package("gtsummary", boolean = TRUE)
+#' @examplesIf .assert_package("gtsummary", boolean = TRUE) & interactive()
 #' df <- Titanic %>%
 #'   dplyr::as_tibble() %>%
 #'   dplyr::mutate(Survived = factor(Survived, c("No", "Yes")))

diff --git a/R/tidy_add_n.R b/R/tidy_add_n.R
@@ -60,7 +60,7 @@
 #' @param model the corresponding model, if not attached to `x`
 #' @export
 #' @family tidy_helpers
-#' @examples
+#' @examplesIf interactive()
 #' lm(Petal.Length ~ ., data = iris) %>%
 #'   tidy_and_attach() %>%
 #'   tidy_add_n()

diff --git a/R/tidy_add_reference_rows.R b/R/tidy_add_reference_rows.R
@@ -27,7 +27,7 @@
 #' @inheritParams tidy_plus_plus
 #' @export
 #' @family tidy_helpers
-#' @examplesIf .assert_package("gtsummary", boolean = TRUE)
+#' @examplesIf .assert_package("gtsummary", boolean = TRUE) & interactive()
 #' df <- Titanic %>%
 #'   dplyr::as_tibble() %>%
 #'   dplyr::mutate(Survived = factor(Survived, c("No", "Yes")))

diff --git a/R/tidy_add_term_labels.R b/R/tidy_add_term_labels.R
@@ -27,7 +27,7 @@
 #' @inheritParams tidy_plus_plus
 #' @export
 #' @family tidy_helpers
-#' @examples
+#' @examplesIf interactive()
 #' df <- Titanic %>%
 #'   dplyr::as_tibble() %>%
 #'   dplyr::mutate(Survived = factor(Survived, c("No", "Yes"))) %>%

diff --git a/R/tidy_plus_plus.R b/R/tidy_plus_plus.R
@@ -63,39 +63,40 @@
 #'     Class = "Passenger's class",
 #'     Sex = "Gender"
 #'   )
+#' if (interactive()) {
+#'   ex2 <- glm(
+#'     Survived ~ Class + Age * Sex,
+#'     data = df, weights = df$n,
+#'     family = binomial
+#'   ) %>%
+#'     tidy_plus_plus(
+#'       exponentiate = TRUE,
+#'       add_reference_rows = FALSE,
+#'       categorical_terms_pattern = "{level} / {reference_level}",
+#'       add_n = TRUE
+#'     )
+#'   ex2
 #'
-#' ex2 <- glm(
-#'   Survived ~ Class + Age * Sex,
-#'   data = df, weights = df$n,
-#'   family = binomial
-#' ) %>%
-#'   tidy_plus_plus(
-#'     exponentiate = TRUE,
-#'     add_reference_rows = FALSE,
-#'     categorical_terms_pattern = "{level} / {reference_level}",
-#'     add_n = TRUE
-#'   )
-#' ex2
-#'
-#' ex3 <-
-#'   glm(
-#'     response ~ poly(age, 3) + stage + grade * trt,
-#'     na.omit(gtsummary::trial),
-#'     family = binomial,
-#'     contrasts = list(
-#'       stage = contr.treatment(4, base = 3),
-#'       grade = contr.sum
+#'   ex3 <-
+#'     glm(
+#'       response ~ poly(age, 3) + stage + grade * trt,
+#'       na.omit(gtsummary::trial),
+#'       family = binomial,
+#'       contrasts = list(
+#'         stage = contr.treatment(4, base = 3),
+#'         grade = contr.sum
+#'       )
+#'     ) %>%
+#'     tidy_plus_plus(
+#'       exponentiate = TRUE,
+#'       variable_labels = c(age = "Age (in years)"),
+#'       add_header_rows = TRUE,
+#'       show_single_row = all_dichotomous(),
+#'       term_labels = c("poly(age, 3)3" = "Cubic age"),
+#'       keep_model = TRUE
 #'     )
-#'   ) %>%
-#'   tidy_plus_plus(
-#'     exponentiate = TRUE,
-#'     variable_labels = c(age = "Age (in years)"),
-#'     add_header_rows = TRUE,
-#'     show_single_row = all_dichotomous(),
-#'     term_labels = c("poly(age, 3)3" = "Cubic age"),
-#'     keep_model = TRUE
-#'   )
-#' ex3
+#'   ex3
+#' }
 #' @export
 tidy_plus_plus <- function(
                            model,

diff --git a/man/model_compute_terms_contributions.Rd b/man/model_compute_terms_contributions.Rd
diff --git a/man/select_helpers.Rd b/man/select_helpers.Rd
diff --git a/man/tidy_add_header_rows.Rd b/man/tidy_add_header_rows.Rd
diff --git a/man/tidy_add_n.Rd b/man/tidy_add_n.Rd
diff --git a/man/tidy_add_reference_rows.Rd b/man/tidy_add_reference_rows.Rd
diff --git a/man/tidy_add_term_labels.Rd b/man/tidy_add_term_labels.Rd
diff --git a/man/tidy_plus_plus.Rd b/man/tidy_plus_plus.Rd