step_lencode_bayes: Supervised Factor Conversions into Linear Functions using...

View source: R/lencode_bayes.R

step_lencode_bayesR Documentation

Supervised Factor Conversions into Linear Functions using Bayesian Likelihood Encodings


step_lencode_bayes() creates a specification of a recipe step that will convert a nominal (i.e. factor) predictor into a single set of scores derived from a generalized linear model estimated using Bayesian analysis.


  role = NA,
  trained = FALSE,
  outcome = NULL,
  options = list(seed =^5, 1)),
  verbose = FALSE,
  mapping = NULL,
  skip = FALSE,
  id = rand_id("lencode_bayes")



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


One or more selector functions to choose variables. For step_lencode_bayes, this indicates the variables to be encoded into a numeric format. See recipes::selections() for more details. For the tidy method, these are not currently used.


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


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


A call to vars to specify which variable is used as the outcome in the generalized linear model. Only numeric and two-level factors are currently supported.


A list of options to pass to rstanarm::stan_glmer().


A logical to control the default printing by rstanarm::stan_glmer().


A list of tibble results that define the encoding. This is NULL until the step is trained by recipes::prep().


A logical. Should the step be skipped when the recipe is baked by recipes::bake()? While all operations are baked when recipes::prep() is run, some operations may not be able to be conducted on new data (e.g. processing the outcome variable(s)). Care should be taken when using skip = TRUE as it may affect the computations for subsequent operations


A character string that is unique to this step to identify it.


For each factor predictor, a generalized linear model is fit to the outcome and the coefficients are returned as the encoding. These coefficients are on the linear predictor scale so, for factor outcomes, they are in log-odds units. The coefficients are created using a no intercept model and, when two factor outcomes are used, the log-odds reflect the event of interest being the first level of the factor.

For novel levels, a slightly timmed average of the coefficients is returned.

A hierarchical generalized linear model is fit using rstanarm::stan_glmer() and no intercept via

  stan_glmer(outcome ~ (1 | predictor), data = data, ...)

where the ... include the family argument (automatically set by the step, unless passed in by options) as well as any arguments given to the options argument to the step. Relevant options include chains, iter, cores, and arguments for the priors (see the links in the References below). prior_intercept is the argument that has the most effect on the amount of shrinkage.


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 (the selectors or variables for encoding), level (the factor levels), and value (the encodings).


When you tidy() this step, a tibble with columns terms (the selectors or variables selected), value and component is returned.

Case weights

This step performs an supervised operation that can utilize case weights. To use them, see the documentation in recipes::case_weights and the examples on


Micci-Barreca D (2001) "A preprocessing scheme for high-cardinality categorical attributes in classification and prediction problems," ACM SIGKDD Explorations Newsletter, 3(1), 27-32.

Zumel N and Mount J (2017) "vtreat: a data.frame Processor for Predictive Modeling," arXiv:1611.09477

"Hierarchical Partial Pooling for Repeated Binary Trials"

"Prior Distributions for 'rstanarm“ Models"

"Estimating Generalized (Non-)Linear Models with Group-Specific Terms with rstanarm"




grants_other <- sample_n(grants_other, 500)

reencoded <- recipe(class ~ sponsor_code, data = grants_other) %>%
  step_lencode_bayes(sponsor_code, outcome = vars(class))

embed documentation built on Nov. 2, 2023, 6:20 p.m.