updates for no-suggests checks (#949)

* no suggests changes * more no-suggest changes * various no suggests updates * move to examplesIf * kernlab * skip skip skip * regen snapshots * skip skip * one more example adjustment * a few more minor changes
tidymodels · Oct 18, 2024 · bc5422a · bc5422a
1 parent 51db99e
commit bc5422a
Show file tree

Hide file tree

Showing 45 changed files with 442 additions and 140 deletions.
diff --git a/.github/workflows/R-CMD-check-hard.yaml b/.github/workflows/R-CMD-check-hard.yaml
@@ -0,0 +1,59 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+#
+# NOTE: This workflow only directly installs "hard" dependencies, i.e. Depends,
+# Imports, and LinkingTo dependencies. Notably, Suggests dependencies are never
+# installed, with the exception of testthat, knitr, and rmarkdown. The cache is
+# never used to avoid accidentally restoring a cache containing a suggested
+# dependency.
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+name: R-CMD-check-hard.yaml
+
+permissions: read-all
+
+jobs:
+  check-no-suggests:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: ubuntu-latest,   r: 'release'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          dependencies: '"hard"'
+          cache: false
+          extra-packages: |
+            any::rcmdcheck
+            any::testthat
+            any::knitr
+            any::rmarkdown
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -34,6 +34,7 @@ Imports:
     recipes (>= 1.0.4),
     rlang (>= 1.1.0),
     rsample (>= 1.2.1.9000),
+    tailor,
     tibble (>= 3.1.0),
     tidyr (>= 1.2.0),
     tidyselect (>= 1.1.2),
@@ -52,7 +53,6 @@ Suggests:
     scales,
     spelling,
     splines2,
-    tailor,
     testthat (>= 3.0.0),
     xgboost,
     xml2

diff --git a/R/conf_mat_resampled.R b/R/conf_mat_resampled.R
@@ -11,7 +11,9 @@
 #' @param tidy Should the results come back in a tibble (`TRUE`) or a `conf_mat`
 #' object like `yardstick::conf_mat()` (`FALSE`)?
 #' @return A tibble or `conf_mat` with the average cell count across resamples.
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
+#' # example code
+#'
 #' library(parsnip)
 #' library(rsample)
 #' library(dplyr)

diff --git a/R/coord_obs_pred.R b/R/coord_obs_pred.R
@@ -36,7 +36,8 @@ CoordObsPred <-
 #' may show up in places such as the axes, the legend, the plot title, or the
 #' plot margins.
 #' @return A `ggproto` object.
-#' @examples
+#' @examplesIf rlang::is_installed("modeldata")
+#' # example code
 #' data(solubility_test, package = "modeldata")
 #'
 #' library(ggplot2)

diff --git a/R/extract.R b/R/extract.R
@@ -45,7 +45,9 @@
 #' description section.
 #'
 #' @name extract-tune
-#' @examples
+#' @examplesIf rlang::is_installed("splines2")
+#' # example code
+#'
 #' library(recipes)
 #' library(rsample)
 #' library(parsnip)

diff --git a/R/fit_best.R b/R/fit_best.R
@@ -13,8 +13,8 @@
 #' a column for each tuning parameter. This tibble should have columns for each
 #' tuning parameter identifier (e.g. `"my_param"` if `tune("my_param")` was used).
 #' If `NULL`, this argument will be set to
-#' [`select_best(metric, eval_time)`][tune::select_best.tune_results]. 
-#' If not `NULL`, `parameters` overwrites the specification via `metric`, and 
+#' [`select_best(metric, eval_time)`][tune::select_best.tune_results].
+#' If not `NULL`, `parameters` overwrites the specification via `metric`, and
 #' `eval_time`.
 #' @param verbose A logical for printing logging.
 #' @param add_validation_set When the resamples embedded in `x` are a split into
@@ -37,7 +37,7 @@
 #'
 #' @inheritSection last_fit See also
 #'
-#' @examplesIf tune:::should_run_examples()
+#' @examplesIf tune:::should_run_examples() & rlang::is_installed("modeldata")
 #' library(recipes)
 #' library(rsample)
 #' library(parsnip)

diff --git a/R/int_pctl.R b/R/int_pctl.R
@@ -46,24 +46,26 @@
 #' @references Davison, A., & Hinkley, D. (1997). _Bootstrap Methods and their
 #'  Application_. Cambridge: Cambridge University Press.
 #'  doi:10.1017/CBO9780511802843
-#' @examplesIf !tune:::is_cran_check() & tune:::should_run_examples("modeldata")
-#' data(Sacramento, package = "modeldata")
-#' library(rsample)
-#' library(parsnip)
+#' @examplesIf !tune:::is_cran_check()
+#' if (rlang::is_installed("modeldata")) {
+#'   data(Sacramento, package = "modeldata")
+#'   library(rsample)
+#'   library(parsnip)
 #'
-#' set.seed(13)
-#' sac_rs <- vfold_cv(Sacramento)
+#'   set.seed(13)
+#'   sac_rs <- vfold_cv(Sacramento)
 #'
-#' lm_res <-
-#'   linear_reg() %>%
-#'   fit_resamples(
-#'     log10(price) ~ beds + baths + sqft + type + latitude + longitude,
-#'     resamples = sac_rs,
-#'     control = control_resamples(save_pred = TRUE)
-#'   )
+#'   lm_res <-
+#'     linear_reg() %>%
+#'     fit_resamples(
+#'       log10(price) ~ beds + baths + sqft + type + latitude + longitude,
+#'       resamples = sac_rs,
+#'       control = control_resamples(save_pred = TRUE)
+#'     )
 #'
-#' set.seed(31)
-#' int_pctl(lm_res)
+#'   set.seed(31)
+#'   int_pctl(lm_res)
+#' }
 #' @export
 int_pctl.tune_results <- function(.data, metrics = NULL, eval_time = NULL,
                                   times = 1001, parameters = NULL,

diff --git a/R/last_fit.R b/R/last_fit.R
@@ -59,7 +59,7 @@
 #' model (and recipe, if any) that used the training set. Helper functions
 #' for formatting tuning results like [collect_metrics()] and
 #' [collect_predictions()] can be used with `last_fit()` output.
-#' @examplesIf tune:::should_run_examples()
+#' @examplesIf tune:::should_run_examples() & rlang::is_installed("splines2")
 #' library(recipes)
 #' library(rsample)
 #' library(parsnip)

diff --git a/R/merge.R b/R/merge.R
@@ -13,7 +13,7 @@
 #'
 #' @return A tibble with a column `x` that has as many rows as were in `y`.
 #' @keywords internal
-#' @examplesIf tune:::should_run_examples(suggests = c("xgboost", "modeldata"))
+#' @examplesIf tune:::should_run_examples(suggests = c("xgboost", "modeldata", "splines2"))
 #' library(tibble)
 #' library(recipes)
 #' library(parsnip)

diff --git a/R/resample.R b/R/resample.R
@@ -20,7 +20,7 @@
 #' @template case-weights
 #' @template censored-regression
 #' @seealso [control_resamples()], [collect_predictions()], [collect_metrics()]
-#' @examplesIf tune:::should_run_examples()
+#' @examplesIf tune:::should_run_examples() & rlang::is_installed("splines2")
 #' library(recipes)
 #' library(rsample)
 #' library(parsnip)

diff --git a/R/tune_grid.R b/R/tune_grid.R
@@ -163,7 +163,7 @@
 #' @template case-weights
 #' @template censored-regression
 #'
-#' @examplesIf tune:::should_run_examples(suggests = "kernlab")
+#' @examplesIf tune:::should_run_examples(suggests = "kernlab") & rlang::is_installed("splines2")
 #' library(recipes)
 #' library(rsample)
 #' library(parsnip)

diff --git a/man/conf_mat_resampled.Rd b/man/conf_mat_resampled.Rd
diff --git a/man/coord_obs_pred.Rd b/man/coord_obs_pred.Rd
diff --git a/man/extract-tune.Rd b/man/extract-tune.Rd
diff --git a/man/fit_best.Rd b/man/fit_best.Rd
diff --git a/man/fit_resamples.Rd b/man/fit_resamples.Rd
diff --git a/man/int_pctl.tune_results.Rd b/man/int_pctl.tune_results.Rd
diff --git a/man/last_fit.Rd b/man/last_fit.Rd
diff --git a/man/merge.recipe.Rd b/man/merge.recipe.Rd
diff --git a/man/tune_grid.Rd b/man/tune_grid.Rd
diff --git a/tests/testthat/_snaps/bayes.md b/tests/testthat/_snaps/bayes.md
@@ -392,13 +392,13 @@
       cars_res <- tune_bayes(svm_mod, preprocessor = rec, resamples = data_folds)
     Message
       x Fold1: preprocessor 1/1:
-        Error in `step_bs()`:
-        Caused by error in `if (...) NULL`:
-        ! missing value where TRUE/FALSE needed
+        Error in `step_spline_b()`:
+        Caused by error in `glue()`:
+        ! Expecting '}'
       x Fold2: preprocessor 1/1:
-        Error in `step_bs()`:
-        Caused by error in `if (...) NULL`:
-        ! missing value where TRUE/FALSE needed
+        Error in `step_spline_b()`:
+        Caused by error in `glue()`:
+        ! Expecting '}'
     Condition
       Warning:
       All models failed. Run `show_notes(.Last.tune.result)` for more information.

diff --git a/tests/testthat/_snaps/checks.md b/tests/testthat/_snaps/checks.md
@@ -92,6 +92,22 @@
       Error in `tune:::check_workflow()`:
       ! A parsnip model is required.
 
+# errors informatively when needed package isn't installed
+
+    Code
+      check_workflow(stan_wflow)
+    Condition
+      Error:
+      ! Package install is required for rstanarm.
+
+---
+
+    Code
+      fit_resamples(stan_wflow, rsample::bootstraps(mtcars))
+    Condition
+      Error in `fit_resamples()`:
+      ! Package install is required for rstanarm.
+
 # workflow objects (will not tune, tidymodels/tune#548)
 
     Code