add show_query() method (#106)

Author: EmilHvitfeldt

NAMESPACE

@@ -63,6 +63,7 @@ S3method(orbital,workflow)
 S3method(orbital,xgb.Booster)
 S3method(predict,orbital_class)
 S3method(print,orbital_class)
+S3method(show_query,orbital_class)
 export(augment)
 export(orbital)
 export(orbital_dt)
@@ -71,4 +72,5 @@ export(orbital_json_read)
 export(orbital_json_write)
 export(orbital_r_fun)
 export(orbital_sql)
+importFrom(dplyr,show_query)
 importFrom(generics,augment)

NEWS.md

@@ -6,6 +6,8 @@
     - `adjust_predictions_custom()`
     - `adjust_probability_threshold()`
 
+* Added `show_query()` method for orbital objects. (#106)
+
 # orbital 0.3.1
 
 * Fixed bug where PCA steps didn't work if they were trained with more than 99 predictors. (#82)

R/show_query.R

@@ -0,0 +1,16 @@
+#' @importFrom dplyr show_query
+#' @export
+show_query.orbital_class <- function(x, con, ...) {
+  x <- unclass(orbital_sql(x, con))
+
+  if (length(x) == 0) {
+    x <- paste0("[empty]")
+  } else {
+    x <- paste0(
+      x,
+      ifelse(rlang::names2(x) == "", "", paste0(" AS ", rlang::names2(x)))
+    )
+  }
+
+  cat(x, sep = "\n")
+}

tests/testthat/_snaps/show_query.md

@@ -0,0 +1,9 @@
+# show_query works
+
+    Code
+      show_query(orbital_obj, con = con)
+    Output
+      CASE WHEN ((`disp` IS NULL)) THEN 230.721875 WHEN NOT ((`disp` IS NULL)) THEN `disp` END AS disp
+      (`disp` - 230.721875) / 123.938693831382 AS disp
+      20.090625 + (`disp` * -5.10814813429143) AS .pred
+

tests/testthat/test-show_query.R

@@ -0,0 +1,27 @@
+test_that("show_query works", {
+  skip_if_not_installed("recipes")
+  skip_if_not_installed("parsnip")
+  skip_if_not_installed("workflows")
+  skip_if_not_installed("DBI")
+  skip_if_not_installed("RSQLite")
+  skip_on_cran()
+
+  rec_spec <- recipes::recipe(mpg ~ disp, data = mtcars) |>
+    recipes::step_impute_mean(recipes::all_numeric_predictors()) |>
+    recipes::step_normalize(recipes::all_numeric_predictors())
+
+  lm_spec <- parsnip::linear_reg()
+
+  wf_spec <- workflows::workflow(rec_spec, lm_spec)
+  wf_fit <- parsnip::fit(wf_spec, data = mtcars)
+
+  orbital_obj <- orbital(wf_fit)
+
+  con <- DBI::dbConnect(RSQLite::SQLite(), path = ":memory:")
+
+  expect_snapshot(
+    show_query(orbital_obj, con = con)
+  )
+
+  DBI::dbDisconnect(con)
+})