Skip to contents

Compute a compact residual-diagnostics summary that works across univariate, multivariate, and multilevel mars fits.

Usage

residual_diagnostics(object, cluster = NULL, outcome = NULL)

Arguments

object

A fitted mars object.

cluster

Optional column name in object$data for cluster-level summaries.

outcome

Optional column name in object$data for outcome-level summaries.

Value

A list containing residual vectors, global summaries, and optional grouped summaries.

Examples

if (FALSE) { # \dontrun{
fit <- mars(
  data = teacher_expectancy,
  studyID = "study",
  effectID = NULL,
  sample_size = NULL,
  formula = yi ~ 1,
  variance = "vi",
  varcov_type = "univariate",
  structure = "univariate"
)
residual_diagnostics(fit)
} # }