Merge pull request #1504 from olivroy/error-msg

Improve error message for gt functions

NEWS.md

@@ -4,6 +4,8 @@
 
 * `gtsave()` now returns the file path invisibly instead of `TRUE` (@olivroy, #1478).
 
+* Most functions in gt receive a better error message if they don't provide a `gt_tbl` as an input (@olivroy, #1504).
+
 # gt 0.10.0
 
 ## Nanoplots

R/utils.R

@@ -86,10 +86,12 @@ is_nonempty_string <- function(x) {
 #' @param data The input `data` object that is to be validated.
 #'
 #' @noRd
-stop_if_not_gt_tbl <- function(data) {
+# Use rlang::caller_env() to inform user of the precise location of failure.
+stop_if_not_gt_tbl <- function(data, call = caller_env()) {
   if (!is_gt_tbl(data = data)) {
     cli::cli_abort(
-      "The `data` provided is not a `gt_tbl` object."
+      "`data` must be a `gt_tbl` object, not {.obj_type_friendly {data}}.",
+      call = call
     )
   }
 }
@@ -99,10 +101,11 @@ stop_if_not_gt_tbl <- function(data) {
 #' @param data The input `data` object that is to be validated.
 #'
 #' @noRd
-stop_if_not_gt_group <- function(data) {
+stop_if_not_gt_group <- function(data, call = caller_env()) {
   if (!is_gt_group(data = data)) {
     cli::cli_abort(
-      "The `data` provided is not a `gt_group` object."
+      "`data` must be a `gt_group` object, not {.obj_type_friendly {data}}.",
+      call = call
     )
   }
 }
@@ -112,10 +115,11 @@ stop_if_not_gt_group <- function(data) {
 #' @param data The input `data` object that is to be validated.
 #'
 #' @noRd
-stop_if_not_gt_tbl_or_group <- function(data) {
+stop_if_not_gt_tbl_or_group <- function(data, call = caller_env()) {
   if (!is_gt_tbl(data = data) && !is_gt_group(data = data)) {
     cli::cli_abort(
-      "The `data` provided is neither a `gt_tbl` nor a `gt_group` object."
+      "`data` must either be a `gt_tbl` or a `gt_group`, not {.obj_type_friendly {data}}.",
+      call = error_call
     )
   }
 }

tests/testthat/helper-render_formats.R

@@ -1,8 +1,5 @@
 # Testable version of the `render_formats()` function
 render_formats_test <- function(data,
                                 context) {
-
-  data %>%
-    build_data(context = context) %>%
-    .$`_body`
+  build_data(data, context = context)$`_body`
 }

tests/testthat/test-input_data_validation.R

@@ -1,6 +1,6 @@
 test_that("All exported functions validate the incoming `data` object", {
 
-  regexp_stop <- "The `data` provided is not a `gt_tbl` object"
+  regexp_stop <- "`data` must be a `gt_tbl` object"
 
   # Test the `exibble` tibble with all exported functions;
   # don't provide values for any arguments and ensure that