variable.names.lmm: Variables Involved in a Linear Mixed Model

View source: R/variable.names.R

variable.names.lmmR Documentation

Variables Involved in a Linear Mixed Model

Description

Extract the variables used by the linear mixed model.

Usage

## S3 method for class 'lmm'
variable.names(object, effects = "all", original = TRUE, simplify = TRUE, ...)

Arguments

object

a lmm object.

effects

[character] Should all variable be output ("all"), or only those related to the outcome ("outcome"), mean ("mean"), variance ("variance"), correlation ("correlation"), time ("time"), cluster ("cluster"), strata ("strata")?

original

[logical] Should only the variables present in the original data be output? When FALSE, variables internally created are output instead of the original variable for time, cluster, and strata.

simplify

[logical] Should the list be converted into a vector if a single effects is requested?

...

not used. For compatibility with the generic function

Value

A list of character vectors or a character vector.


bozenne/repeated documentation built on July 16, 2025, 11:16 p.m.