Merge 8fbf5f4 into 2290a30

insightsengineering · Sep 27, 2024 · ff5dd25 · ff5dd25
2 parents 2290a30 + 8fbf5f4
commit ff5dd25
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/R/replace_null_statistic.R b/R/replace_null_statistic.R
@@ -1,6 +1,6 @@
 #' Replace NULL Statistics with Specified Value
 #'
-#' When a statistical summary function errors, the `"statistic"` column will be
+#' When a statistical summary function errors, the `"stat"` column will be
 #' `NULL`. It is, however, sometimes useful to replace these values with a
 #' non-`NULL` value, e.g. `NA`.
 #'

diff --git a/R/shift_ard_columns.R b/R/shift_ard_columns.R
@@ -52,7 +52,8 @@ rename_ard_columns <- function(x, columns = c(all_ard_groups(), all_ard_variable
       if (length(unlisted) != length(x[[unlist_var]])) {
         cli::cli_abort(
           c("Cannot unlist column {.val {unlist_var}}. The unlisted result is not the same length as the original.",
-            "i" = "This often occurs when the column contains {.code NULL} values."
+            "i" = "This often occurs when the column contains {.code NULL} values.",
+            if (unlist_var == "stat") c("*" = "Run {.fun cards::replace_null_statistic} to replace {.code NULL} values with {.val {NA}}.") # styler: off
           ),
           call = get_cli_abort_call()
         )

diff --git a/man/replace_null_statistic.Rd b/man/replace_null_statistic.Rd
diff --git a/tests/testthat/_snaps/rename_ard_columns.md b/tests/testthat/_snaps/rename_ard_columns.md
@@ -44,4 +44,5 @@
       Error in `rename_ard_columns()`:
       ! Cannot unlist column "stat". The unlisted result is not the same length as the original.
       i This often occurs when the column contains `NULL` values.
+      * Run `cards::replace_null_statistic()` to replace `NULL` values with NA.