VetResearchLMM (version 1.1.0)

report_mixed_model: Report a Fitted Mixed Model

Description

Create an easystats-style narrative report for a fitted linear mixed model.

Usage

report_mixed_model(model, ...)

Value

A report object returned by report::report().

Arguments

model

A fitted model object, typically from lme4::lmer(), lmerTest::lmer(), or nlme::lme().

...

Additional arguments passed to report::report().

Details

This helper keeps the report package optional. It checks that a fitted model was supplied, verifies that report is installed, and then delegates the model interpretation to report::report(). This provides a stable package-level entry point for readers who want easystats-style interpretation of the fitted mixed models used throughout the book examples.

The helper does not change the fitted model, refit the model, or alter any estimates. It only formats and interprets the model object produced by the modelling package.

References

Duchateau, L., Janssen, P., and Rowlands, G. J. (1998). Linear Mixed Models: An Introduction with Applications in Veterinary Research. International Livestock Research Institute.

See utils::citation("report") for the citation for the optional easystats reporting package.

See Also

lme4::lmer, nlme::lme.

Examples

if (requireNamespace("lme4", quietly = TRUE) &&
    requireNamespace("report", quietly = TRUE)) {
  data(ex127, package = "VetResearchLMM")
  fit <- lme4::lmer(Ww ~ 1 + (1 | sire), data = ex127, REML = TRUE)
  report_mixed_model(fit)
}