Deprecate na.rm

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: insight
 Title: Easy Access to Model Information for Various Model Objects
-Version: 0.20.4.2
+Version: 0.20.4.3
 Authors@R:
     c(person(given = "Daniel",
              family = "Lüdecke",

NEWS.md

@@ -2,9 +2,12 @@
 
 ## General
 
-* `get_datagrid()` can now be used to extract the "grid" information from 
+* `get_datagrid()` can now be used to extract the "grid" information from
   `{emmeans}` and `{marginaleffects}` outputs.
 
+* Argument `na.rm` is deprecated throughout the package's functions. Instead,
+  use `remove_na`.
+
 # insight 0.20.4
 
 ## New supported models

R/get_parameters_bayesian.R

@@ -81,14 +81,14 @@ get_parameters.MCMCglmm <- function(x,
   nF <- x$Fixed$nfl
   fixed <- as.data.frame(x$Sol[, 1:nF, drop = FALSE])
   random <- as.data.frame(x$VCV[, find_random(x, split_nested = TRUE, flatten = TRUE), drop = FALSE])
-  all <- cbind(fixed, random)
+  all_params <- cbind(fixed, random)
 
   out <- if (effects == "fixed") {
     fixed
   } else if (effects == "random") {
     random
   } else {
-    all
+    all_params
   }
 
   if (isTRUE(summary)) {
@@ -152,9 +152,9 @@ get_parameters.BFBayesFactor <- function(x,
     colnames(posteriors) <- "p"
     out <- posteriors
   } else if (bf_type == "xtable") {
-    data <- get_data(x, verbose = verbose)
-    N <- sum(data)
-    cells <- prod(dim(data))
+    model_data <- get_data(x, verbose = verbose)
+    N <- sum(model_data)
+    cells <- prod(dim(model_data))
     posts <- as.data.frame(as.matrix(suppressMessages(
       BayesFactor::posterior(x, iterations = iterations, progress = progress)
     )))

R/utilities.R

@@ -12,10 +12,11 @@
 #' valid object name.
 #'
 #' @param x A (character) vector, or for some functions may also be a data frame.
-#' @param na.rm Logical, if missing values should be removed from the input.
+#' @param remove_na Logical, if missing values should be removed from the input.
 #' @param character_only Logical, if `TRUE` and `x` is a data frame or list,
 #' only processes character vectors.
 #' @param ... Currently not used.
+#' @param na.rm Deprecated. Use `remove_na` instead.
 #'
 #' @return
 #' - `n_unique()`: For a vector, `n_unique` always returns an integer value,
@@ -88,22 +89,37 @@ n_unique <- function(x, ...) {
 
 #' @rdname trim_ws
 #' @export
-n_unique.default <- function(x, na.rm = TRUE, ...) {
+n_unique.default <- function(x, remove_na = TRUE, na.rm = remove_na, ...) {
   if (is.null(x)) {
     return(0)
   }
-  if (isTRUE(na.rm)) x <- x[!is.na(x)]
+  ## TODO:: remove deprecation warning later
+  if (!missin(na.rm)) {
+    format_warning("The `na.rm` argument is deprecated. Use `remove_na` instead.")
+    remove_na <- na.rm
+  }
+  if (isTRUE(remove_na)) x <- x[!is.na(x)]
   length(unique(x))
 }
 
 #' @export
-n_unique.data.frame <- function(x, na.rm = TRUE, ...) {
-  vapply(x, n_unique, na.rm = na.rm, FUN.VALUE = numeric(1L))
+n_unique.data.frame <- function(x, remove_na = TRUE, na.rm = remove_na, ...) {
+  ## TODO:: remove deprecation warning later
+  if (!missin(na.rm)) {
+    format_warning("The `na.rm` argument is deprecated. Use `remove_na` instead.")
+    remove_na <- na.rm
+  }
+  vapply(x, n_unique, na.rm = remove_na, FUN.VALUE = numeric(1L))
 }
 
 #' @export
-n_unique.list <- function(x, na.rm = TRUE, ...) {
-  lapply(x, n_unique, na.rm = na.rm)
+n_unique.list <- function(x, remove_na = TRUE, na.rm = remove_na, ...) {
+  ## TODO:: remove deprecation warning later
+  if (!missin(na.rm)) {
+    format_warning("The `na.rm` argument is deprecated. Use `remove_na` instead.")
+    remove_na <- na.rm
+  }
+  lapply(x, n_unique, na.rm = remove_na)
 }
 
 
@@ -139,7 +155,12 @@ safe_deparse_symbol <- function(x) {
 
 #' @rdname trim_ws
 #' @export
-has_single_value <- function(x, na.rm = FALSE) {
-  if (na.rm) x <- x[!is.na(x)]
+has_single_value <- function(x, remove_na = FALSE, na.rm = remove_na, ...) {
+  ## TODO:: remove deprecation warning later
+  if (!missin(na.rm)) {
+    format_warning("The `na.rm` argument is deprecated. Use `remove_na` instead.")
+    remove_na <- na.rm
+  }
+  if (remove_na) x <- x[!is.na(x)]
   !is.null(x) && length(x) > 0L && isTRUE(all(x == x[1]))
 }

tests/testthat/test-utilities.R

@@ -55,7 +55,7 @@ test_that("has_single_value() works", {
 
   x <- c(NA, 1)
   expect_false(has_single_value(x))
-  expect_true(has_single_value(x, na.rm = TRUE))
+  expect_true(has_single_value(x, remove_na = TRUE))
 
   x <- c(2, 1)
   expect_false(has_single_value(x))
@@ -65,7 +65,7 @@ test_that("has_single_value() works", {
 
   x <- c(NA, NA)
   expect_false(has_single_value(x))
-  expect_false(has_single_value(x, na.rm = TRUE))
+  expect_false(has_single_value(x, remove_na = TRUE))
 })
 
 test_that("safe_deparse_symbol() works", {