check_type: Quantitatively check on variables

In tidymodels/recipes: Preprocessing and Feature Engineering Steps for Modeling

Quantitatively check on variables

Description

This internal function is to be used in the prep function to ensure that the type of the variables matches the expectation. Throws an error if check fails.

Usage

check_type(dat, quant = TRUE, types = NULL, call = caller_env())

Arguments

dat	A data frame or tibble of the training data.
quant	A logical indicating whether the data is expected to be numeric (TRUE) or a factor/character (FALSE). Is ignored if types is specified.
types	Character vector of allowed types. Following the same types as has_role(). See details for more.

Details

Using types is a more fine-tuned way to use this. function compared to using quant. types should specify all allowed types as designated by .get_data_types. Suppose you want to allow doubles, integers, characters, factors and ordered factors, then you should specify types = c("double", "integer", "string", "factor", "ordered") to get a clear error message.

See Also

developer_functions

tidymodels/recipes documentation built on Nov. 29, 2024, 3:05 p.m.