Stateful object for designing and applying binomial outcome treatments.

Source: R/ft.R

Hold settings and results for binomial classification data preparation.

BinomialOutcomeTreatment(
  ...,
  var_list,
  outcome_name,
  outcome_target = TRUE,
  cols_to_copy = NULL,
  params = NULL,
  imputation_map = NULL
)

Arguments

...

not used, force arguments to be specified by name.
var_list

Names of columns to treat (effective variables).
outcome_name

Name of column holding outcome variable. dframe[[outcomename]] must be only finite and non-missing values.
outcome_target

Value/level of outcome to be considered "success", and there must be a cut such that dframe[[outcomename]]==outcometarget at least twice and dframe[[outcomename]]!=outcometarget at least twice.
cols_to_copy

list of extra columns to copy.
params

parameters list from classification_parameters
imputation_map

map from column names to functions of signature f(values: numeric, weights: numeric), simple missing value imputers.

Details

Please see https://github.com/WinVector/vtreat/blob/main/Examples/fit_transform/fit_transform_api.md, mkCrossFrameCExperiment, designTreatmentsC, and prepare.treatmentplan for details.