orbital_mutate -> orbital_predict()

NAMESPACE

@@ -15,6 +15,6 @@ export(orbital_dt)
 export(orbital_inline)
 export(orbital_json_read)
 export(orbital_json_write)
-export(orbital_mutate)
+export(orbital_predict)
 export(orbital_sql)
 export(to_r_fun)

R/mutate.R

@@ -1,41 +1,34 @@
 #' Use orbital in a mutate way
-#' 
+#'
 #' @param .data A data frame that can be used with mutate.
 #' @param x A orbital object.
-#' @param only_pred A logical value to determine if whole data set should be 
-#'   returned or just predictions.
-#' 
+#'
 #' @returns A modified data frame.
-#' 
+#'
 #' @examples
 #' library(workflows)
 #' library(recipes)
 #' library(parsnip)
-#' 
+#'
 #' rec_spec <- recipe(mpg ~ ., data = mtcars) %>%
 #'   step_normalize(all_numeric_predictors())
-#' 
+#'
 #' lm_spec <- linear_reg()
-#' 
+#'
 #' wf_spec <- workflow(rec_spec, lm_spec)
-#' 
+#'
 #' wf_fit <- fit(wf_spec, mtcars)
-#' 
+#'
 #' orbital_obj <- orbital(wf_fit)
-#' 
+#'
 #' mtcars %>%
-#'   orbital_mutate(orbital_obj)
-#' 
-#' mtcars %>%
-#'   orbital_mutate(orbital_obj, only_pred = TRUE)
+#'   orbital_predict(orbital_obj)
 #' @export
-orbital_mutate <- function(.data, x, only_pred = FALSE) {
-  res <- dplyr::mutate(.data, !!!orbital_inline(x))
+orbital_predict <- function(.data, x) {
+  pred_name <- names(x)[length(x)]
 
-  if (only_pred) {
-    pred_name <- names(x)[length(x)]
-    res <- dplyr::select(res, dplyr::any_of(pred_name))
-  }
+  res <- dplyr::mutate(.data, !!!orbital_inline(x))
+  res <- dplyr::select(res, dplyr::any_of(pred_name))
 
   res
 }

R/predict.R

@@ -0,0 +1,34 @@
+#' Use orbital in a mutate way
+#'
+#' @param .data A data frame that can be used with mutate.
+#' @param x A orbital object.
+#'
+#' @returns A modified data frame.
+#'
+#' @examples
+#' library(workflows)
+#' library(recipes)
+#' library(parsnip)
+#'
+#' rec_spec <- recipe(mpg ~ ., data = mtcars) %>%
+#'   step_normalize(all_numeric_predictors())
+#'
+#' lm_spec <- linear_reg()
+#'
+#' wf_spec <- workflow(rec_spec, lm_spec)
+#'
+#' wf_fit <- fit(wf_spec, mtcars)
+#'
+#' orbital_obj <- orbital(wf_fit)
+#'
+#' mtcars %>%
+#'   orbital_predict(orbital_obj)
+#' @export
+orbital_predict <- function(.data, x) {
+  res <- dplyr::mutate(.data, !!!orbital_inline(x))
+
+  pred_name <- names(x)[length(x)]
+  res <- dplyr::select(res, dplyr::any_of(pred_name))
+
+  res
+}

tests/testthat/test-mutate.R → tests/testthat/test-predict.R

@@ -13,12 +13,7 @@ test_that("orbital works with workflows - recipe", {
   obj <- orbital(wf_fit)
 
   expect_identical(
-    mtcars %>% orbital_mutate(obj),
-    mtcars %>% dplyr::mutate(!!!orbital_inline(obj))
-  )
-
-  expect_identical(
-    mtcars %>% orbital_mutate(obj, only_pred = TRUE),
+    mtcars %>% orbital_predict(obj),
     mtcars %>% dplyr::mutate(!!!orbital_inline(obj)) %>% dplyr::select(.pred)
   )
 })