eelbrain.align1

eelbrain.align1(d, to, by='index', out='data')[source]

Align a data object to an index variable

Parameters:

d (Dataset | Var | NDVar | Factor | Interaction | NestedEffect | Model | Datalist) – Data object with cases that should be aligned to idx.
to (Var | NDVar | Factor | Interaction | NestedEffect | Model | Datalist) – Index array to which d should be aligned. If to is a Dataset, use to[by].
by (str | Var | NDVar | Factor | Interaction | NestedEffect | Model | Datalist) – Variable labeling cases in d for aligning them to to. If d is a Dataset, by can be the name of a variable in d.
out (Literal['data', 'index']) – Return a restructured copy of d (default) or an index array into d.

Returns:

d_aligned – Aligned copy of d (or index to align d to idx if out='index').

Return type:

DataObjectArg | numpy.ndarray