catto_aggregate {cattonum}R Documentation

Aggregate function encoding

Description

Aggregate function encoding

Usage

catto_aggregate(
  train,
  ...,
  aggregate_fun,
  response = NULL,
  test = NULL,
  verbose = TRUE
)

Arguments

train

The training data, in a data.frame or tibble.

...

The columns to be encoded. If none are specified, then all character and factor columns are encoded.

aggregate_fun

The aggregate function to be applied to the response variable for the rows belonging to the relevant level of the categorical predictor. Takes a vector and returns a length one vector.

response

The response variable used to calculate aggregate summaries.

test

The test data, in a data.frame or tibble.

verbose

Should informative messages be printed? Defaults to TRUE.

Value

The encoded dataset in a cattonum_df if no test dataset was provided, and the encoded datasets in a cattonum_df2 otherwise.

Examples

catto_aggregate(iris, aggregate_fun = max, response = Sepal.Length)

[Package cattonum version 0.0.5 Index]