summary.ICCfit: Summary for ICCfit Objects

View source: R/summary.ICCfit.R

summary.ICCfitR Documentation

Summary for ICCfit Objects

Description

The function summarizes the results of ICC estimation.

Usage

## S3 method for class 'ICCfit'
summary(object, ...)

Arguments

object

object of the class ICCfit (output of the intervalICC function)

...

additional arguments passed to the function (they do not affect the summary produced)

Details

For more details about ICC estimation and output values shortly described below, please refer to the documentation for intervalICC.

Value

An object of class "summary.ICCfit". The object is a list with the components:

estimates

a data frame containing maximum likelihood estimates for ICC, mean and variance components

loglikelihood

log-likelihood evaluated at maximum likelihood estimates

Author(s)

Jelena Kovacic jkovacic@imi.hr

References

Kovacic J, Varnai VM. Intraclass correlation coefficient for grouped data. Epidemiology 2014;25(5):769–770.

See Also

intervalICC

Examples

# Example with 6 predefined classes (grouped data)
classes <- 1:6
class.limits <- cbind(classes-0.5,classes+0.5)
r1 <- sample(classes,30,replace=TRUE)
r2 <- sample(classes,30,replace=TRUE)
icc.est <- intervalICC(r1,r2,predefined.classes=TRUE,classes,class.limits)
summary(icc.est)

iRepro documentation built on Aug. 8, 2023, 5:13 p.m.