is_data_frame

paramcheckup.types.is_data_frame(data_frame, param_name, kind, kind_name, stacklevel=4, error=True)

This function checks whether a variable data_frame is of the DataFrame type.

Parameters:

data_frameany type

The variable that is tested as being of DataFrame type;

param_namestr

The name of the parameter that received the variable data_frame;

kindstr

The object where param_name is applied (function, method, class, etc.);

kind_namestr

The name of the object kind;

stacklevelint, optional

The stacking level (default is 4);

errorbool, optional

Whether to display error text (True, default) or not (False);

Returns:

outputTrue

If variable data_frame IS of the DataFrame type;

raisesTypeError

If variable data_frame is NOT of the DataFrame type;

Examples

>>> from paramcheckup import types
>>> import pandas as pd
>>> df = pd.DataFrame(data=[1, 2, 3, 4, 5], columns=["Dataset"])
>>> result = types.is_data_frame(
    data_frame=df,
    param_name="x_data",
    kind="function",
    kind_name="ttest",
    stacklevel=3,
    error=True,
)
>>> print(result)
True

>>> from paramcheckup import types
>>> import pandas as pd
>>> df = [1, 2, 3, 4, 5]
>>> result = types.is_data_frame(
    data_frame=df,
    param_name="x_data",
    kind="function",
    kind_name="ttest",
    stacklevel=3,
    error=False,
)
UserWarning at line 4: The parameter `x_data` in function `ttest` must be of type `DataFrame`, but its type is `list`.