nlme (version 3.1-1)

getGroupsFormula.lme: Extract lme Object Grouping Formula

Description

The grouping formula associated with the random effects structure (reStruct) of object is returned either as a named list of one-sided formulas, or a single one-sided formula, depending on the value of asList. The components of the returned list are ordered from outermost to innermost level and are named after the grouping factor expression.

Usage

getGroupsFormula(object, asList)

Arguments

object

an object inheriting from class lme, representing a fitted linear mixed-effects model.

asList

an optional logical value. If TRUE the returned value with be a list of formulas; else, if FALSE the returned value will be a one-sided formula. Defaults to FALSE.

Value

• a one-sided formula, or a list of one-sided formulas, with the grouping structure associated with the random effects structure of object.

See Also

reStruct, getGroups.lme

Examples

data(Orthodont)
fm1 <- lme(distance ~ age + Sex, data = Orthodont, random = ~ 1)
getGroupsFormula(fm1)