reghelper (version 0.3.3)

ICC.lme: Intra-class correlation.

Description

ICC.lme calculates the intra-class correlation (ICC) from a fitted multi-level model using the 'nlme' package.

Usage

# S3 method for lme
ICC(model, ...)

Arguments

model

A fitted model of type 'lme'.

...

Not currently implemented; used to ensure consistency with S3 generic.

Value

The intra-class correlation of the model.

Details

The ICC is the proportion of variance that is between-person variance. For more information, see Hoyt & Kenny (2013).

See Also

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
}
# }