recipes (version 0.1.0)

step_logit: Logit Transformation

Description

step_logit creates a specification of a recipe step that will logit transform the data.

Usage

step_logit(recipe, ..., role = NA, trained = FALSE, columns = NULL)

Arguments

recipe

A recipe object. The step will be added to the sequence of operations for this recipe.

...

One or more selector functions to choose which variables are affected by the step. See selections for more details.

role

Not used by this step since no new variables are created.

trained

A logical to indicate if the quantities for preprocessing have been estimated.

columns

A character string of variable names that will be (eventually) populated by the terms argument.

Value

An updated version of recipe with the new step added to the sequence of existing steps (if any).

Details

The inverse logit transformation takes values between zero and one and translates them to be on the real line using the function f(p) = log(p/(1-p)).

See Also

step_invlogit step_log step_sqrt step_hyperbolic recipe prep.recipe bake.recipe

Examples

# NOT RUN {
set.seed(313)
examples <- matrix(runif(40), ncol = 2)
examples <- data.frame(examples)

rec <- recipe(~ X1 + X2, data = examples)

logit_trans <- rec  %>%
  step_logit(all_predictors())

logit_obj <- prep(logit_trans, training = examples)

transformed_te <- bake(logit_obj, examples)
plot(examples$X1, transformed_te$X1)
# }