check_categorical_variables

feature_engine.variable_handling.check_categorical_variables(X, variables)

Checks that the variables in the list are of type object or categorical.

More details in the User Guide.

Parameters

Xpandas dataframe of shape = [n_samples, n_features]

The dataset

variableslist

The list with the names of the variables to check.

Returns

variables: List

The names of the categorical variables.

Examples

>>> import pandas as pd
>>> from feature_engine.variable_handling import check_categorical_variables
>>> X = pd.DataFrame({
>>>     "var_num": [1, 2, 3],
>>>     "var_cat": ["A", "B", "C"],
>>>     "var_date": pd.date_range("2020-02-24", periods=3, freq="T")
>>> })
>>> var_ = check_categorical_variables(X, "var_cat")
>>> var_
['var_cat']

Return type

List[Union[str, int]]