variable.names.mlmm: Variables Involved in Multiple Linear Mixed Models

View source: R/variable.names.R

variable.names.mlmmR Documentation

Variables Involved in Multiple Linear Mixed Models

Description

Extract the variables used to obtain multiple linear mixed models.

Usage

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

Arguments

object

a mlmm 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"), or variable defining the split of the dataset on which a separate linear mixed model is fit ("by")?

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.