ready to fill out the predict method, finally

Author: dajmcdon

NAMESPACE

@@ -13,14 +13,18 @@ S3method(prep,step_epi_lag)
 S3method(print,step_epi_ahead)
 S3method(print,step_epi_lag)
 export("%>%")
+export(add_epi_recipe)
 export(arx_args_list)
 export(arx_forecaster)
 export(create_lags_and_leads)
+export(default_epi_recipe_blueprint)
 export(df_mat_mul)
 export(epi_keys)
 export(epi_recipe)
+export(epi_workflow)
 export(get_precision)
 export(grab_names)
+export(is_epi_recipe)
 export(knn_iteraive_ar_args_list)
 export(knn_iteraive_ar_forecaster)
 export(knnarx_args_list)

R/epi_recipe.R

@@ -210,15 +210,78 @@ epi_form2args <- function(formula, data, ...) {
   list(x = data, vars = vars, roles = roles)
 }
 
+
+
+#' Test for `epi_df` format
+#'
+#' @param x An object.
+#' @return `TRUE` if the object inherits from `epi_recipe`.
+#'
+#' @export
 is_epi_recipe <- function(x) {
   inherits(x, "epi_recipe")
 }
 
+
+
+#' Add an epi_recipe to a workflow
+#'
+#' @seealso [workflows::add_recipe()]
+#' - `add_recipe()` specifies the terms of the model and any preprocessing that
+#'   is required through the usage of a recipe.
+#'
+#' - `remove_recipe()` removes the recipe as well as any downstream objects
+#'
+#' @details
+#' Has the same behaviour as [workflows::add_recipe()] but sets a different
+#' default blueprint to automatically handle [epiprocess::epi_df] data.
+#'
+#' @param x A workflow or epi_workflow
+#'
+#' @param recipe A recipe created using [recipes::recipe()]
+#'
+#' @param ... Not used.
+#'
+#' @param blueprint A hardhat blueprint used for fine tuning the preprocessing.
+#'
+#'   [default_epi_recipe_blueprint()] is used.
+#'
+#'   Note that preprocessing done here is separate from preprocessing that
+#'   might be done automatically by the underlying model.
+#'
+#' @return
+#' `x`, updated with a new recipe preprocessor.
+#'
+#' @export
+#' @examples
+#' library(recipes)
+#' library(magrittr)
+#'
+#' recipe <- epi_recipe(mpg ~ cyl, mtcars) %>%
+#'   step_log(cyl)
+#'
+#' workflow <- workflow() %>%
+#'   add_epi_recipe(recipe)
+#'
+#' workflow
+#'
 add_epi_recipe <- function(
     x, recipe, ..., blueprint = default_epi_recipe_blueprint()) {
   add_recipe(x, recipe, ..., blueprint = blueprint)
 }
 
+
+
+#' Recipe blueprint that accounts for `epi_df` panel data
+#'
+#' Used for simplicity. See [hardhat::default_recipe_blueprint()] for more
+#' details.
+#'
+#' @inheritParams hardhat::default_recipe_blueprint
+#'
+#' @details The `bake_dependent_roles` are automatically set to `epi_df` defaults.
+#' @return A recipe blueprint.
+#' @export
 default_epi_recipe_blueprint <-
   function(intercept = FALSE, allow_novel_levels = FALSE, fresh = TRUE,
            bake_dependent_roles = c("time_value", "geo_value", "key", "raw"),

R/epi_workflow.R

@@ -16,3 +16,38 @@ predict.epi_workflow <-
 is_epi_workflow <- function(x) {
   inherits(x, "epi_workflow")
 }
+
+workflow <- function(preprocessor = NULL, spec = NULL) {
+  out <- new_workflow()
+
+  if (!is_null(preprocessor)) {
+    out <- add_preprocessor(out, preprocessor)
+  }
+
+  if (!is_null(spec)) {
+    out <- add_model(out, spec)
+  }
+
+  out
+}
+
+add_preprocessor <- function(x, preprocessor, ..., call = caller_env()) {
+  check_dots_empty()
+
+  if (is_formula(preprocessor)) {
+    return(add_formula(x, preprocessor))
+  }
+
+  if (is_recipe(preprocessor)) {
+    return(add_recipe(x, preprocessor))
+  }
+
+  if (is_workflow_variables(preprocessor)) {
+    return(add_variables(x, variables = preprocessor))
+  }
+
+  abort(
+    "`preprocessor` must be a formula, recipe, or a set of workflow variables.",
+    call = call
+  )
+}