Learn R Programming

matrixCorr (version 0.10.0)

summary.ccc_rm_reml: Summary Method for ccc_rm_reml Objects

Description

Produces a detailed summary of a "ccc_rm_reml" object, including Lin's CCC estimates and associated variance component estimates per method pair.

Usage

# S3 method for ccc_rm_reml
summary(
  object,
  digits = 4,
  ci_digits = 2,
  n = NULL,
  topn = NULL,
  max_vars = NULL,
  width = NULL,
  show_ci = NULL,
  ...
)

# S3 method for summary.ccc_rm_reml print( x, digits = NULL, n = NULL, topn = NULL, max_vars = NULL, width = NULL, show_ci = NULL, ... )

Value

A data frame of class "summary.ccc_rm_reml" with columns: method1, method2, estimate, and optionally lwr, upr, as well as variance component estimates: sigma2_subject, sigma2_subject_method, sigma2_subject_time, sigma2_error, sigma2_extra, SB, se_ccc.

Arguments

object

An object of class "ccc_rm_reml", as returned by ccc_rm_reml().

digits

Integer; number of decimal places to round CCC estimates and components.

ci_digits

Integer; decimal places for confidence interval bounds.

n

Optional row threshold for compact preview output.

topn

Optional number of leading/trailing rows to show when truncated.

max_vars

Optional maximum number of visible columns; NULL derives this from console width.

width

Optional display width; defaults to getOption("width").

show_ci

Character string indicating whether to show confidence intervals: "yes" shows CI information when available and "no" suppresses it.

...

Passed to print.data.frame.

x

An object of class "summary.ccc_rm_reml".