BPt.Dataset.apply_inclusions#

Dataset.apply_inclusions(subjects, inplace=False)[source]#

This method will drop all subjects that do not overlap with the passed subjects to this function. In this sense, this method acts like a whitelist, where you could pass for example only valid subjects that passed some QC, and all other’s loaded will be dropped.

Parameters
subjectsSubjects

This argument can be any of the BPt accepted subject style inputs. E.g., None, ‘nan’ for subjects with any nan data, or ‘not not’ for subjects without any, the str location of a file formatted with one subject per line, or directly as an array-like of subjects, to list a few options.

See Subjects for all options, and a more detailed description of the already mentioned options.

inplacebool, optional

If True, perform the current function inplace and return None.

default = False