R/get_random.R

In insight: Easy Access to Model Information for Various Model Objects

#' @title Get the data from random effects
#' @name get_random
#'
#' @description Returns the data from all random effects terms.
#'
#' @inheritParams find_random
#'
#' @return The data from all random effects terms, as data frame. Or `NULL`
#'    if model has no random effects.
#'
#' @examplesIf require("lme4", quietly = TRUE)
#' data(sleepstudy)
#' # prepare some data...
#' sleepstudy$mygrp <- sample(1:5, size = 180, replace = TRUE)
#' sleepstudy$mysubgrp <- NA
#' for (i in 1:5) {
#'   filter_group <- sleepstudy$mygrp == i
#'   sleepstudy$mysubgrp[filter_group] <-
#'     sample(1:30, size = sum(filter_group), replace = TRUE)
#' }
#'
#' m <- lmer(
#'   Reaction ~ Days + (1 | mygrp / mysubgrp) + (1 | Subject),
#'   data = sleepstudy
#' )
#'
#' head(get_random(m))
#'
#' @export
get_random <- function(x) {
  UseMethod("get_random")
}

#' @export
get_random.default <- function(x) {
  if (is_empty_object(find_random(x))) {
    format_warning("No random effects found in model.")
    return(NULL)
  }

  get_data(x, effects = "random", verbose = FALSE)
}


#' @export
get_random.afex_aov <- function(x) {
  get_data(x, shape = "long", verbose = FALSE)[find_random(x, flatten = TRUE)]
}