api documentation

summary module

summary.ColumnSummariser(to_summarise_columns)	Summarisation of columns in a DataFrame.
summary.DataFrameValueCounter([columns, ...])	Summarisation of values in a DataFrame.

discretisation module

discretisation.Discretiser(variable)	Abstract base class for different discretisation methods.
discretisation.EqualWidthDiscretiser(variable)	Equal width discretisation.
discretisation.EqualWeightDiscretiser(variable)	Equal weight discretisation.
discretisation.QuantileDiscretiser(variable)	Quantile discretisation.

plot.matplotlib module

plot.matplotlib.plot_summarised_variable(...)	Produce one way summary plot from pre-summarised data.
plot.matplotlib.plot_summarised_variable_2way(...)	Produce one way summary plot from pre-summarised data.

checks module

checks.check_type(obj, expected_types, obj_name)	Function to check object is of given types and raise a TypeError if not.
checks.check_condition(condition, ...)	Check that condition (which evaluates to a bool) is True and raise a ValueError if not.
checks.check_columns_in_df(df, columns)	Function to check that all specified columns are in a given DataFrame and raise a ValueError if not.