Describe lmerTest results

Note that this function uses summary object from lmerTest::lmer model and not the model itself (see examples). Otherwise p-values will be computed during the call and everything will be very slow.

Usage

# S3 method for class 'summary.merMod'
apa(obj, factor, dtype = "t", ...)

# S3 method for class 'lmert'
apa(obj, factor, dtype = "t", ...)

Arguments

obj

summary object from lmerTest::lmer model

factor

name or number of the factor that needs to be described

dtype

description type ("B"/"t")

...

other parameters passed to format_results

Value

A character vector reporting the selected fixed-effect estimate, standard error, test statistic, degrees of freedom when available, and p-value.

Examples

if (requireNamespace("lmerTest", quietly = TRUE)) {
  # Fit a mixed-effects model with p-values
  fm <- lmerTest::lmer(Reaction ~ Days + (Days | Subject), lme4::sleepstudy)
  fms <- summary(fm)
  
  # Format results in APA style
  print(apa(fms, "Days"))
  print(apa(fms, "(Intercept)"))
  print(apa(fms, 2))
  print(apa(fms, "Days", "B"))
}
#> [1] "_t_(17) = 6.77, _p_ < .001"
#> [1] "_t_(17) = 36.84, _p_ < .001"
#> [1] "_t_(17) = 6.77, _p_ < .001"
#> [1] "_B_ = 10.47 (1.55), _p_ < .001"