brainstat.stats.terms.Random

class brainstat.stats.terms.Random(ran=None, fix=None, name_ran=None, name_fix=None, ranisvar=False)[source]

Bases: object

Build a random term object for a linear model.

Parameters

  • ran (array-like or DataFrame, optional) – For the random effects. If None, the random term is empty. Default is None.

  • fix (array-like or DataFrame, optional) – If None, the fixed effects.

  • name_ran (str, optional) – Name for the random term. If None, it defauts to ‘xi’. Default is None.

  • name_fix (str, optional) – Name for the fix term. If None, it defauts to ‘xi’. Default is None.

  • ranisvar (bool, optional) – If True, ran is already a term for the variance. Default is False.

Variables

  • mean (Term) – Term for the mean.

  • variance (Term) – Term for the variance.

See also

Term

Term object

Examples

>>> r = Random()
>>> r.is_empty
True

>>> r2 = Random(np.arange(5), name_ran='r1')
>>> r2.mean.is_empty
True
>>> r2.variance.shape
(25, 1)
__init__(ran=None, fix=None, name_ran=None, name_fix=None, ranisvar=False)[source]

Methods

__init__([ran, fix, name_ran, name_fix, ...])

broadcast_to(r1, r2)

Attributes

empty

shape