light_recode: Recode Factor Columns

View source: R/light_recode.R

light_recodeR Documentation

Recode Factor Columns

Description

Recodes factor levels of columns in data slots of an object of class "light".

Usage

light_recode(x, ...)

## Default S3 method:
light_recode(x, ...)

## S3 method for class 'light'
light_recode(x, what, levels, labels, ...)

Arguments

x

An object of class "light".

...

Further arguments passed to factor.

what

Column identifier to be recoded, e.g., "type". For backward compatibility, also the option identifier (e.g. "type_name") can be passed.

levels

Current levels/values of type_name column (in desired order).

labels

New levels of type_name column in same order as levels.

Value

x with new factor levels of type_name column.

Methods (by class)

  • light_recode(default): Default method not implemented yet.

  • light_recode(light): Recoding factors in data slots of "light" object.

See Also

plot.light_effects().

Examples

fit_full <- lm(Sepal.Length ~ ., data = iris)
fit_part <- lm(Sepal.Length ~ Petal.Length, data = iris)
mod_full <- flashlight(
  model = fit_full, label = "full", data = iris, y = "Sepal.Length"
)
mod_part <- flashlight(
  model = fit_part, label = "part", data = iris, y = "Sepal.Length"
)
mods <- multiflashlight(list(mod_full, mod_part))
eff <- light_effects(mods, v = "Species")
eff <- light_recode(
  eff,
  what = "type_name",
  levels = c("response", "predicted", "partial dependence", "ale"),
  labels = c("Observed", "Fitted", "PD", "ALE")
)
plot(eff, use = "all")

flashlight documentation built on May 31, 2023, 6:19 p.m.