collapse_by_group: Collapse raw data by random effect groups

In ggeffects: Create Tidy Data Frames of Marginal Effects for 'ggplot' from Model Outputs

Collapse raw data by random effect groups

Description

This function extracts the raw data points (i.e. the data that was used to fit the model) and "averages" (i.e. "collapses") the response variable over the levels of the grouping factor given in collapse_by. Only works with mixed models.

Usage

collapse_by_group(
  grid,
  model,
  collapse_by = NULL,
  residuals = FALSE,
  collapse.by = collapse_by
)

Arguments

grid	A data frame representing the data grid, or an object of class ggeffects, as returned by ggpredict() and others.
model	The model for which to compute partial residuals. The data grid grid should match to predictors in the model.
collapse_by	Name of the (random effects) grouping factor. Data is collapsed by the levels of this factor.
residuals	Logical, if TRUE, collapsed partial residuals instead of raw data by the levels of the grouping factor.
collapse.by	Deprecated. Use collapse_by instead.

Value

A data frame with raw data points, averaged over the levels of the given grouping factor from the random effects. The group level of the random effect is saved in the column "random".

Examples

library(ggeffects)
if (require("lme4", quietly = TRUE)) {
  data(efc)
  efc$e15relat <- as.factor(efc$e15relat)
  efc$c161sex <- as.factor(efc$c161sex)
  levels(efc$c161sex) <- c("male", "female")
  model <- lmer(neg_c_7 ~ c161sex + (1 | e15relat), data = efc)
  me <- ggpredict(model, terms = "c161sex")
  head(attributes(me)$rawdata)
  collapse_by_group(me, model, "e15relat")
}

ggeffects documentation built on Oct. 17, 2023, 5:07 p.m.