mlr: impute – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

impute

Impute and re-impute data

Description

Allows imputation of missing feature values through various techniques. Note that you have the possibility to re-impute a data set in the same way as the imputation was performed during training. This especially comes in handy during resampling when one wants to perform the same imputation on the test set as on the training set.

The function impute performs the imputation on a data set and returns, alongside with the imputed data set, an “ImputationDesc” object which can contain “learned” coefficients and helpful data. It can then be passed together with a new data set to reimpute.

The imputation techniques can be specified for certain features or for feature classes, see function arguments.

You can either provide an arbitrary object, use a built-in imputation method listed under imputations or create one yourself using makeImputeMethod.

Usage

impute(
  obj,
  target = character(0L),
  classes = list(),
  cols = list(),
  dummy.classes = character(0L),
  dummy.cols = character(0L),
  dummy.type = "factor",
  force.dummies = FALSE,
  impute.new.levels = TRUE,
  recode.factor.levels = TRUE
)

Arguments

`obj`	(data.frame \| Task) Input data.
`target`	(character) Name of the column(s) specifying the response. Default is `character(0)`.
`classes`	(named list) Named list containing imputation techniques for classes of columns. E.g. `list(numeric = imputeMedian())`.
`cols`	(named list) Named list containing names of imputation methods to impute missing values in the data column referenced by the list element's name. Overrules imputation set via `classes`.
`dummy.classes`	(character) Classes of columns to create dummy columns for. Default is `character(0)`.
`dummy.cols`	(character) Column names to create dummy columns (containing binary missing indicator) for. Default is `character(0)`.
`dummy.type`	(`character(1)`) How dummy columns are encoded. Either as 0/1 with type “numeric” or as “factor”. Default is “factor”.
`force.dummies`	(`logical(1)`) Force dummy creation even if the respective data column does not contain any NAs. Note that (a) most learners will complain about constant columns created this way but (b) your feature set might be stochastic if you turn this off. Default is `FALSE`.
`impute.new.levels`	(`logical(1)`) If new, unencountered factor level occur during reimputation, should these be handled as NAs and then be imputed the same way? Default is `TRUE`.
`recode.factor.levels`	(`logical(1)`) Recode factor levels after reimputation, so they match the respective element of `lvls` (in the description object) and therefore match the levels of the feature factor in the training data after imputation?. Default is `TRUE`.

Details

The description object contains these slots

target (character): See argument.
features (character): Feature names (column names of data).

classes (character): Feature classes (storage type of data).
lvls (named list): Mapping of column names of factor features to their levels, including newly created ones during imputation.
impute (named list): Mapping of column names to imputation functions.
dummies (named list): Mapping of column names to imputation functions.
impute.new.levels (logical(1)): See argument.
recode.factor.levels (logical(1)): See argument.

Value

(list)

`data (data.frame)`	Imputed data.
`desc (ImputationDesc)`	Description object.

Examples

df = data.frame(x = c(1, 1, NA), y = factor(c("a", "a", "b")), z = 1:3)
imputed = impute(df, target = character(0), cols = list(x = 99, y = imputeMode()))
print(imputed$data)
reimpute(data.frame(x = NA_real_), imputed$desc)

mlr

Machine Learning in R

v2.19.0

BSD_2_clause + file LICENSE

Authors

Bernd Bischl [aut] (<https://orcid.org/0000-0001-6002-6980>), Michel Lang [aut] (<https://orcid.org/0000-0001-9754-0393>), Lars Kotthoff [aut], Patrick Schratz [aut, cre] (<https://orcid.org/0000-0003-0748-6624>), Julia Schiffner [aut], Jakob Richter [aut], Zachary Jones [aut], Giuseppe Casalicchio [aut] (<https://orcid.org/0000-0001-5324-5966>), Mason Gallo [aut], Jakob Bossek [ctb] (<https://orcid.org/0000-0002-4121-4668>), Erich Studerus [ctb] (<https://orcid.org/0000-0003-4233-0182>), Leonard Judt [ctb], Tobias Kuehn [ctb], Pascal Kerschke [ctb] (<https://orcid.org/0000-0003-2862-1418>), Florian Fendt [ctb], Philipp Probst [ctb] (<https://orcid.org/0000-0001-8402-6790>), Xudong Sun [ctb] (<https://orcid.org/0000-0003-3269-2307>), Janek Thomas [ctb] (<https://orcid.org/0000-0003-4511-6245>), Bruno Vieira [ctb], Laura Beggel [ctb] (<https://orcid.org/0000-0002-8872-8535>), Quay Au [ctb] (<https://orcid.org/0000-0002-5252-8902>), Martin Binder [ctb], Florian Pfisterer [ctb], Stefan Coors [ctb], Steve Bronder [ctb], Alexander Engelhardt [ctb], Christoph Molnar [ctb], Annette Spooner [ctb]

Initial release