watex.utils.funcutils.is_depth_in#

watex.utils.funcutils.is_depth_in(X, name, columns=None, error='ignore')[source]#

Assert wether depth exists in the data from column attributes.

If name is an integer value, it assumes to be the index in the columns of the dataframe if not exist , a warming will be show to user.

Parameters

  • X – dataframe dataframe containing the data for plotting

  • columns – list, New labels to replace the columns in the dataframe. If given , it should fit the number of colums of X.

  • name – str, int depth name in the dataframe or index to retreive the name of the depth in dataframe

  • error – str , default=’ignore’ Raise or ignore when depth is not found in the dataframe. Whe error is set to ignore, a pseudo-depth is created using the lenght of the the dataframe, otherwise a valueError raises.

Returns

X, depth Dataframe without the depth columns and depth values.