1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
#' Inverse Transformation
#'
#' `step_inverse` creates a *specification* of a recipe
#' step that will inverse transform the data.
#'
#' @inheritParams step_center
#' @param ... One or more selector functions to choose which
#' variables are affected by the step. See [selections()]
#' for more details. For the `tidy` method, these are not
#' currently used.
#' @param role Not used by this step since no new variables are
#' created.
#' @param offset An optional value to add to the data prior to
#' logging (to avoid `1/0`).
#' @param columns A character string of variable names that will
#' be populated (eventually) by the `terms` argument.
#' @return An updated version of `recipe` with the new step
#' added to the sequence of existing steps (if any). For the
#' `tidy` method, a tibble with columns `terms` which
#' is the columns that will be affected.
#' @keywords datagen
#' @concept preprocessing
#' @concept transformation_methods
#' @export
#' @examples
#' set.seed(313)
#' examples <- matrix(runif(40), ncol = 2)
#' examples <- data.frame(examples)
#'
#' rec <- recipe(~ X1 + X2, data = examples)
#'
#' inverse_trans <- rec %>%
#' step_inverse(all_predictors())
#'
#' inverse_obj <- prep(inverse_trans, training = examples)
#'
#' transformed_te <- bake(inverse_obj, examples)
#' plot(examples$X1, transformed_te$X1)
#'
#' tidy(inverse_trans, number = 1)
#' tidy(inverse_obj, number = 1)
#' @seealso [step_log()]
#' [step_sqrt()] [step_hyperbolic()] [recipe()]
#' [prep.recipe()] [bake.recipe()]
step_inverse <-
function(recipe,
...,
role = NA,
offset = 0,
trained = FALSE,
columns = NULL,
skip = FALSE,
id = rand_id("inverse")) {
add_step(recipe,
step_inverse_new(
terms = ellipse_check(...),
role = role,
offset = offset,
trained = trained,
columns = columns,
skip = skip,
id = id
))
}
step_inverse_new <-
function(terms, role, offset, trained, columns, skip, id) {
step(
subclass = "inverse",
terms = terms,
role = role,
offset = offset,
trained = trained,
columns = columns,
skip = skip,
id = id
)
}
#' @export
prep.step_inverse <- function(x, training, info = NULL, ...) {
col_names <- eval_select_recipes(x$terms, training, info)
check_type(training[, col_names])
step_inverse_new(
terms = x$terms,
role = x$role,
offset = x$offset,
trained = TRUE,
columns = col_names,
skip = x$skip,
id = x$id
)
}
#' @export
bake.step_inverse <- function(object, new_data, ...) {
for (i in seq_along(object$columns))
new_data[, object$columns[i]] <-
1 / (new_data [[ object$columns[i] ]] + object$offset)
as_tibble(new_data)
}
print.step_inverse <-
function(x, width = max(20, options()$width - 33), ...) {
cat("Inverse transformation on ", sep = "")
printer(x$columns, x$terms, x$trained, width = width)
invisible(x)
}
#' @rdname step_inverse
#' @param x A `step_inverse` object.
#' @export
tidy.step_inverse <- function(x, ...) {
res <-simple_terms(x, ...)
res$id <- x$id
res
}
|