BPt.CompareSubset#

class BPt.CompareSubset(name, data, decode_values=True, include_all=False)[source]#

BPt input class designed to combine functionality from BPt.Compare and ValueSubset, for running compare across different sets of Subjects. Note: This class can only be used with Evaluate() where Compare is supported.

Parameters

namestr

The name of the loaded column in Dataset in which to evaluate according to each unique value from.

dataDataset

The reference Dataset to base the unique values of column “name” from.

decode_valuesbool, optional

This parameter is boolean flag which represents if encoded values should be used or not when getting the unique values from. This will mostly just determine the naming of each seperate scope.

default = True

include_allbool, optional

If set to True, then also include in the generated Compare an entry with ‘all’, for running the experiment also with all avaliable subjects.

default = False