Apply minimum Redundancy Maximum Relevance Feature Selection (mRMR)

`step_select_mrmr` creates a *specification* of a recipe step that will apply minimum Redundancy Maximum Relevance Feature Selection (mRMR) to numeric data. The top `top_p` scoring features, or features whose scores occur in the top percentile `threshold` will be retained as new predictors.

Usage

step_select_mrmr(
  recipe,
  ...,
  outcome = NULL,
  role = NA,
  trained = FALSE,
  top_p = NA,
  threshold = NA,
  cutoff = NA,
  threads = 0,
  exclude = NULL,
  scores = NULL,
  skip = FALSE,
  id = recipes::rand_id("select_mrmr")
)

# S3 method for step_select_mrmr
tidy(x, type = "terms", ...)

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. For the tidy method, these are not currently used
outcome: A character string specifying the name of response variable used to evaluate mRMR.
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
top_p: An integer that will be used to select the number of best scoring features.
threshold: A numeric value between 0 and 1 representing the percentile of best scoring features to select. For example `threshold = 0.9` will retain only predictors with scores in the top 90th percentile and a smaller threshold will select more features. Note that `top_p` and `threshold` are mutually exclusive but either can be used in conjunction with `cutoff` to select the top-ranked features and those that have filter scores that are larger than the cutoff value.
cutoff: A numeric value where predictors with _larger_ absolute filter scores than the cutoff will be retained. A value of `NA` implies that this criterion will be ignored.
threads: An integer specifying the number of threads to use for processing. The default = 0 uses all available threads.
exclude: A character vector of predictor names that will be removed from the data. This will be set when `prep()` is used on the recipe and should not be set by the user.
scores: A tibble with 'variable' and 'scores' columns containing the names of the variables and their mRMR scores. This parameter is only produced after the recipe has been trained.
skip: A logical. Should the step be skipped when the recipe is baked by bake.recipe()? While all operations are baked when prep.recipe() 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.
id: A character string that is unique to this step to identify it.
x: A `step_select_mrmr` object.
type: A character with either 'terms' (the default) to return a tibble containing the variables that have been removed by the filter step, or 'scores' to return the scores for each variable.

Value

A step_select_mrmr object.

Details

The recipe will stop if all of `top_p`, `threshold` and `cutoff` are left unspecified.

Examples

library(recipes)

data(cells, package = "modeldata")

rec <-
 recipe(class ~ ., data = cells[, -1]) %>%
 step_select_mrmr(
   all_predictors(),
   outcome = "class",
   top_p = 10
 )

prepped <- prep(rec)

new_data <- bake(prepped, new_data = NULL)
prepped
#> 
#> ── Recipe ──────────────────────────────────────────────────────────────────────
#> 
#> ── Inputs 
#> Number of variables by role
#> outcome:    1
#> predictor: 56
#> 
#> ── Training information 
#> Training data contained 2019 data points and no incomplete rows.
#> 
#> ── Operations 
#> mRMR feature selection (46 excluded)