name changes for data conversion utilities

Author: topepo

NAMESPACE

@@ -103,7 +103,6 @@ export(.x)
 export(.y)
 export(C5.0_train)
 export(add_rowindex)
-export(as_matrix)
 export(boost_tree)
 export(check_empty_ellipse)
 export(check_final_param)
@@ -131,6 +130,8 @@ export(linear_reg)
 export(logistic_reg)
 export(make_classes)
 export(mars)
+export(maybe_data_frame)
+export(maybe_matrix)
 export(mlp)
 export(model_printer)
 export(multi_predict)

R/arguments.R

@@ -191,8 +191,8 @@ make_xy_call <- function(object, target) {
     switch(
       target,
       none = rlang::expr(x),
-      data.frame = rlang::expr(as.data.frame(x)),
-      matrix = rlang::expr(as_matrix(x)),
+      data.frame = rlang::expr(maybe_data_frame(x)),
+      matrix = rlang::expr(maybe_matrix(x)),
       rlang::abort(glue::glue("Invalid data type target: {target}."))
     )
 

R/convert_data.R

@@ -326,18 +326,28 @@ check_dup_names <- function(x, y) {
 
 ## -----------------------------------------------------------------------------
 
-#' Convert data frame to matrix
+#' Fuzzy conversions
 #'
-#' This is a substitute for `as.matrix()` that will convert a data frame to a
-#' ordinary matrix but leave other formats (such as a sparse matrix) alone.
+#' These are substitutes for `as.matrix()` and `as.data.frame()` that leave
+#'  a sparse matrix as-is.
 #' @param x A data frame, matrix, or sparse matrix.
-#' @return A matrix or sparse matrix.
+#' @return A data frame, matrix, or sparse matrix.
 #' @export
-as_matrix <- function(x) {
+maybe_matrix <- function(x) {
   inher(x, c("data.frame", "matrix", "dgCMatrix"), cl = match.call())
   if (is.data.frame(x)) {
     x <- as.matrix(x)
   }
   # leave alone if matrix or sparse matrix
   x
 }
+
+#' @rdname maybe_matrix
+#' @export
+maybe_data_frame <- function(x) {
+  if (!inherits(x, "dgCMatrix")) {
+    x <- as.data.frame(x)
+  }
+  x
+}
+

man/maybe_matrix.Rd

@@ -623,11 +623,11 @@ test_that("bad args", {
 ## -----------------------------------------------------------------------------
 
 test_that("convert to matrix", {
-  expect_true(inherits(parsnip::as_matrix(mtcars), "matrix"))
-  expect_true(inherits(parsnip::as_matrix(tibble::as_tibble(mtcars)), "matrix"))
-  expect_true(inherits(parsnip::as_matrix(as.matrix(mtcars)), "matrix"))
+  expect_true(inherits(parsnip::maybe_matrix(mtcars), "matrix"))
+  expect_true(inherits(parsnip::maybe_matrix(tibble::as_tibble(mtcars)), "matrix"))
+  expect_true(inherits(parsnip::maybe_matrix(as.matrix(mtcars)), "matrix"))
   expect_true(
-    inherits(parsnip::as_matrix(Matrix::Matrix(as.matrix(mtcars), sparse = TRUE)),
+    inherits(parsnip::maybe_matrix(Matrix::Matrix(as.matrix(mtcars), sparse = TRUE)),
              "dgCMatrix")
   )
 })