grouping

bandicoot.helper.group.grouping(f=None, interaction=['call', 'text'], summary='default', user_kwd=False)

grouping is a decorator for indicator functions, used to simplify the source code.

Parameters

f : function

The function to decorate

user_kwd : boolean

If user_kwd is True, the user object will be passed to the decorated function

interaction : 'call', 'text', 'location', or a list

By default, all indicators use only 'call' and 'text' records, but the interaction keywords filters the records passed to the function.

summary: 'default', 'extended', None

An indicator returns data statistics, ether mean and std by default, more with 'extended', or the inner distribution with None. See statistics() for more details.

See :ref:`new-indicator-label` to learn how to write an indicator with

this decorator.