reghelper (version 0.3.3)

ICC: Intra-class correlation.

Description

ICC is a generic function for calculating the intra-class correlation (ICC) for a fitted model.

Usage

ICC(model, ...)

Arguments

model

A fitted linear model of type 'lme' (nlme) or 'merMod' (lme4).

...

Additional arguments to be passed to the particular method for the given model.

Value

The form of the value returned by ICC depends on the class of its argument. See the documentation of the particular methods for details of what is produced by that method.

See Also

ICC.lme, ICC.merMod

Examples

# NOT RUN {
# iris data
if (require(nlme, quietly=TRUE)) {
    model <- lme(Sepal.Width ~ 1, random=~1|Species, data=iris)
    ICC(model)  # .49 of variance is between-subjects
}
# }