summary.lmm: Summary Output for a Linear Mixed Model

View source: R/summary.R

summary.lmmR Documentation

Summary Output for a Linear Mixed Model

Description

Summary output for a linear mixed model fitted with lmm.

Usage

## S3 method for class 'lmm'
summary(
  object,
  level = 0.95,
  robust = FALSE,
  print = TRUE,
  columns = NULL,
  digits = 3,
  digits.df = 1,
  digits.p.value = 3,
  hide.data = FALSE,
  hide.fit = FALSE,
  hide.cor = NULL,
  type.cor = NULL,
  hide.var = NULL,
  hide.sd = NULL,
  hide.re = NULL,
  hide.mean = FALSE,
  ...
)

Arguments

object

[lmm] output of the lmm function.

level

[numeric,0-1] confidence level for the confidence intervals.

robust

[logical] Should robust standard errors (aka sandwich estimator) be output instead of the model-based standard errors.

print

[logical] should the output be printed in the console.

columns

[character vector] Columns to be output for the fixed effects. Can be any of "estimate", "se", "statistic", "df", "null", "lower", "upper", "p.value".

digits

[interger, >0] number of digits used to display estimates.

digits.df

[interger, >0] number of digits used to display degrees of freedom.

digits.p.value

[interger, >0] number of digits used to display p-values.

hide.data

[logical] should information about the dataset not be printed.

hide.fit

[logical] should information about the model fit not be printed.

hide.cor

[logical] should information about the correlation structure not be printed.

type.cor

[character] should the correlation matrix be display ("matrix") or the parameter values ("param").

hide.var

[logical] should information about the variance not be printed.

hide.sd

[logical] should information about the standard deviation not be printed.

hide.re

[logical] should information about the random effect not be printed.

hide.mean

[logical] should information about the mean structure not be printed.

...

not used. For compatibility with the generic function.

Value

A list containing elements displayed in the summary:

  • correlation: the correlation structure.

  • variance: the variance structure.

  • sd: the variance structure expressed in term of standard deviations.

  • mean: the mean structure.


LMMstar documentation built on Nov. 9, 2023, 1:06 a.m.