conversion of warnings and errors to cli #954

topepo · 2024-10-23T22:03:10Z

pal was a godsend here 💯

topepo · 2024-10-23T22:06:48Z

R/checks.R

@@ -372,37 +364,37 @@ check_metrics <- function(x, object) {
  is_surv_metric_set <- inherits(x, c("survival_metric_set"))

  if (!is_numeric_metric_set && !is_class_prob_metric_set && !is_surv_metric_set) {
-    rlang::abort("The `metrics` argument should be the results of [yardstick::metric_set()].")
+    cli::cli_abort("The {.arg metrics} argument should be the results of
+                   {.fn yardstick::metric_set}.")


Previous messages has [pkg:fun()] format. Do we want to move to that? I don't think that they were clickable.

topepo · 2024-10-23T22:08:21Z

R/conf_mat_resampled.R

-      "The first argument needs to be an object with class 'tune_results'."
-    )
+    cli::cli_abort("The first argument needs to be {.cls tune_results} object,
+                   not {.obj_type_friendly {mtcars}}.")


I'm using obj_type_friendly a lot in these messages.

topepo · 2024-10-23T22:09:56Z

R/fit_best.R

  cli::cli_abort(
-    "There is no `fit_best()` method for an object with \\
-     {cli::qty(cls)} class{?es} {.var {cls}}."
+    "No {.fn fit_best} exists for {.obj_type_friendly {x}}."


I standardized on this message for all of the main default methods.

topepo · 2024-10-23T22:10:45Z

R/last_fit.R

@@ -117,16 +116,17 @@ last_fit.model_fit <- function(object, ...) {
  ))
 }

+tune_pp_msg <- "To tune a model specification, you must preprocess with a


More standardization

Nicely done!

topepo · 2024-10-23T22:11:25Z

R/plots.R

@@ -322,7 +320,8 @@ plot_param_vs_iter <- function(x, call = rlang::caller_env()) {
  param_cols <- get_param_columns(x)
  pset <- get_param_object(x)
  if (is.null(pset)) {
-    rlang::abort("`autoplot()` requires objects made with tune version 0.1.0 or later.")
+    cli::cli_abort("{.fn autoplot} requires objects made with {.pkg tune}


Maybe time to retire this?

topepo · 2024-10-23T22:13:06Z

R/pull.R

@@ -107,11 +107,10 @@ reduce_all_outcome_names <- function(resamples) {
  }

  if (n_unique > 1L) {
-    rlang::warn(paste0(
-      "More than one set of outcomes were used when tuning. ",
-      "This should never happen. ",


This was weirdly aggro. Ahh, me in July 2021. I blame the 'rona.

hahahaha i feel like this is the most likely error i see when i introduce bugs in the grid code paths

simonpcouch

I feel like this PR is going to make tidymodels feel much more modern/slick for many users. Heck yeah!

simonpcouch · 2024-10-29T21:00:59Z

R/acquisition.R

  }
  lab <- "the confidence bound"
  if (rlang::is_function(kappa)) {
    farg <- names(formals(kappa))
    if (length(farg) == 0) {
-      rlang::abort("The `trade_off` function should have at least one argument.")
+      cli::cli_abort("The {.fn trade_off} function should have at least one argument.")


Suggested change

cli::cli_abort("The {.fn trade_off} function should have at least one argument.")

cli::cli_abort("The {.fn kappa} function should have at least one argument.")

I think this error should have referenced this argument all along?

Seeing that it's maybe ambiguous whether to use .fn or .arg in these—fine with me to go the route you've chosen.

simonpcouch · 2024-10-29T21:03:04Z

R/case_weights.R

+    cli::format_inline("Unknown case weights object contains
+                       {.obj_type_friendly {x}} instead of an object with a
+                       case weight class."),


Suggested change

cli::format_inline("Unknown case weights object contains

{.obj_type_friendly {x}} instead of an object with a

case weight class."),

"Unknown case weights object contains {.obj_type_friendly {x}} instead

of an object with a case weight class.",

simonpcouch · 2024-10-29T21:03:33Z

R/case_weights.R

-    paste0("Unknown case weights object with class <", class(x)[[1]], ">. "),
+    cli::format_inline("Unknown case weights object contains
+                       {.obj_type_friendly {x}} instead of an object with a
+                       case weight class."),
    i = paste0(


This paste0() can be removed and made a string with a(n implicit) newline

simonpcouch · 2024-10-29T21:03:46Z

R/case_weights.R

    i = paste0(
-      "Define a `.use_case_weights_with_yardstick()` method for this type to ",
+      "Define a {.fn .use_case_weights_with_yardstick} method for this type to ",
      "declare whether or not these case weights should be passed on to yardstick."
    ),
    i = "See `?.use_case_weights_with_yardstick` for more information."


Suggested change

i = "See `?.use_case_weights_with_yardstick` for more information."

i = "See {.help .use_case_weights_with_yardstick} for more information."

simonpcouch · 2024-10-29T21:04:34Z

R/collect.R

-      "The `.predictions` column does not exist. ",
-      "Refit with the control argument `save_pred = TRUE` to save predictions."
+    cli::cli_abort(
+      "The {.code .predictions} column does not exist. Please refit with the


Suggested change

"The {.code .predictions} column does not exist. Please refit with the

"The {.field .predictions} column does not exist. Please refit with the

following Emil's lead here

simonpcouch · 2024-10-29T21:20:57Z

R/tune_results.R

  }

  out <- attr(x, "outcomes", exact = TRUE)

  if (is.null(out)) {
-    rlang::abort("'tune_results' object doesn't have an 'outcomes' attribute.")
+    cli::cli_abort("The object of type {.cls tune_results} object doesn't have an


Suggested change

cli::cli_abort("The object of type {.cls tune_results} object doesn't have an

cli::cli_abort("The object of type {.cls tune_results} doesn't have an

simonpcouch · 2024-10-29T21:21:55Z

R/utils.R

+    cli::cli_warn(
+      "The {.code ...} are not used in this function but {length(dots)}
+       object{?s} {?was/were} passed: {.val {names(dots)}}"
+    )


simonpcouch · 2024-10-29T21:22:20Z

tests/testthat/_snaps/bayes.md

      ! There are 5 tuning parameters and 1 grid point was requested.
-      * The GP model requires 2+ initial points. For best performance, supply more initial points than there are tuning parameters.
+      i The GP model requires 2+ initial points. For best performance, supply more initial points than there are tuning parameters.
+      i 


Empty i = "", it seems

simonpcouch · 2024-10-29T21:23:14Z

tests/testthat/_snaps/case-weights.md

@@ -4,7 +4,7 @@
      .use_case_weights_with_yardstick(1)
    Condition
      Error in `.use_case_weights_with_yardstick()`:
-      ! Unknown case weights object with class <numeric>. 
+      ! Unknown case weights object contains a number instead of an object with a case weight class.


Wondering if this can be more succinct / plainly written

simonpcouch · 2024-10-29T21:28:01Z

R/checks.R

+    num_unk <- length(unk_names)
+    msg <- cli::format_inline(
+      "Creating pre-processing data to finalize {num_unk} unknown parameter{?s}: {.val {unk_names}}"
+    )


Suggested change

num_unk <- length(unk_names)

msg <- cli::format_inline(

"Creating pre-processing data to finalize {num_unk} unknown parameter{?s}: {.val {unk_names}}"

)

msg <-

"Creating pre-processing data to finalize unknown parameter{?s} {.val {unk_names}}."

Since this is a very common message I am going to be fussy about my enum-after-parens pet peeve--feel free to ignore that part of this suggestion if you please🤪

topepo added 6 commits October 23, 2024 13:30

acquisition changes

9061282

augment and case weights

94d98ac

changes for the checks.R file

c02fc9e

Merge branch 'main' into cli-conversion

f5ce8b1

remaining cli updates

b43c9f8

convert warnings

5393cb3

topepo commented Oct 23, 2024

View reviewed changes

simonpcouch marked this pull request as ready for review October 29, 2024 20:58

simonpcouch approved these changes Oct 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

conversion of warnings and errors to cli #954

conversion of warnings and errors to cli #954

topepo commented Oct 23, 2024 •

edited

Loading

topepo Oct 23, 2024

topepo Oct 23, 2024

topepo Oct 23, 2024

topepo Oct 23, 2024

simonpcouch Oct 29, 2024

topepo Oct 23, 2024

simonpcouch Oct 29, 2024

topepo Oct 23, 2024

simonpcouch Oct 29, 2024

simonpcouch left a comment

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

simonpcouch Oct 29, 2024

	cli::cli_abort("The {.fn trade_off} function should have at least one argument.")
	cli::cli_abort("The {.fn kappa} function should have at least one argument.")

	i = "See `?.use_case_weights_with_yardstick` for more information."
	i = "See {.help .use_case_weights_with_yardstick} for more information."

	"The {.code .predictions} column does not exist. Please refit with the
	"The {.field .predictions} column does not exist. Please refit with the

	cli::cli_abort("The object of type {.cls tune_results} object doesn't have an
	cli::cli_abort("The object of type {.cls tune_results} doesn't have an

conversion of warnings and errors to cli #954

Are you sure you want to change the base?

conversion of warnings and errors to cli #954

Conversation

topepo commented Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

simonpcouch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

topepo commented Oct 23, 2024 •

edited

Loading