Add utils for coercing to dataframe (#272)

* add utils for coercing to dataframe

* fix failing test

R/data_arrange.R

@@ -28,14 +28,8 @@ data_arrange <- function(data, select = NULL, safe = TRUE) {
     return(data)
   }
 
-  # coerce to data frame?
-  if (!is.data.frame(data)) {
-    data <- tryCatch(as.data.frame(data, stringsAsFactors = FALSE),
-      error = function(e) {
-        stop("Could not coerce `data` into a data frame.", call. = FALSE)
-      }
-    )
-  }
+  # Input validation check
+  data <- .coerce_to_dataframe(data)
 
   # find which vars should be decreasing
   desc <- select[grepl("^-", select)]
@@ -44,6 +38,7 @@ data_arrange <- function(data, select = NULL, safe = TRUE) {
 
   # check for variables that are not in data
   dont_exist <- select[which(!select %in% names(data))]
+
   if (length(dont_exist) > 0) {
     if (!safe) {
       insight::format_error(
@@ -52,6 +47,13 @@ data_arrange <- function(data, select = NULL, safe = TRUE) {
           text_concatenate(dont_exist), "."
         )
       )
+    } else {
+      insight::format_warning(
+        paste0(
+          "The following column(s) don't exist in the dataset: ",
+          text_concatenate(dont_exist), "."
+        )
+      )
     }
     select <- select[-which(select %in% dont_exist)]
   }

R/data_partition.R

@@ -53,14 +53,7 @@ data_partition <- function(data,
                            training_proportion = proportion,
                            ...) {
   # Sanity checks
-  if (!is.data.frame(data)) {
-    data <- tryCatch(as.data.frame(data), error = function(e) NULL)
-    if (is.null(data)) {
-      insight::format_error(
-        "`data` needs to be a data frame, or an object that can be coerced to a data frame."
-      )
-    }
-  }
+  data <- .coerce_to_dataframe(data)
 
   if (sum(proportion) > 1) {
     stop("`proportion` cannot be higher than 1.", call. = FALSE)

R/select_helpers.R

@@ -386,11 +386,8 @@
     insight::format_error("The `data` argument must be provided.")
   }
   # check data frame input
-  if (!is.null(data) && !is.data.frame(data)) {
-    data <- try(as.data.frame(data), silent = TRUE)
-    if (inherits(data, c("try-error", "simpleError"))) {
-      insight::format_error("The `data` argument must be a data frame, or an object that can be coerced to a data frame.")
-    }
+  if (!is.null(data)) {
+    data <- .coerce_to_dataframe(data)
   }
 }
 

R/utils.R

@@ -24,3 +24,22 @@
 `%||%` <- function(x, y) {
   if (is.null(x)) y else x
 }
+
+
+#' Try to convert object to a dataframe
+#'
+#' @keywords internal
+#' @noRd
+.coerce_to_dataframe <- function(data) {
+  if (!is.data.frame(data)) {
+    data <- tryCatch(
+      as.data.frame(data, stringsAsFactors = FALSE),
+      error = function(e) {
+        insight::format_error(
+          "`data` must be a data frame, or an object that can be coerced to a data frame."
+        )
+      }
+    )
+  }
+  data
+}

tests/testthat/test-data_partition.R

@@ -3,7 +3,7 @@ test_that("data_partition works as expected", {
 
   expect_error(
     data_partition(new.env()),
-    "`data` needs to be a data frame"
+    "`data` must be a data frame"
   )
 
   # to be coerced to data frames

tests/testthat/test-utils.R

@@ -0,0 +1,36 @@
+test_that(".coerce_to_dataframe works for matrices", {
+  mat <- matrix(c(1, 2, 3, 11, 12, 13), nrow = 2, ncol = 3, byrow = TRUE)
+
+  expect_equal(
+    .coerce_to_dataframe(mat),
+    data.frame(
+      V1 = c(1, 11),
+      V2 = c(2, 12),
+      V3 = c(3, 13)
+    )
+  )
+})
+
+test_that(".coerce_to_dataframe works for vectors and list", {
+  expect_equal(
+    .coerce_to_dataframe(1:3),
+    data.frame(data = 1:3)
+  )
+
+  expect_equal(
+    .coerce_to_dataframe(c("a", "b", "c")),
+    data.frame(data = c("a", "b", "c"), stringsAsFactors = FALSE)
+  )
+
+  expect_equal(
+    .coerce_to_dataframe(list(var1 = 1:3, var2 = 4:6)),
+    data.frame(var1 = 1:3, var2 = 4:6)
+  )
+})
+
+test_that(".coerce_to_dataframe errors correctly if can't coerce", {
+  expect_error(
+    .coerce_to_dataframe(list(var1 = 1:3, var2 = 4:5)),
+    regexp = "object that can be coerced"
+  )
+})