model.equation function

Generate a Model Equation from a Linear Model

Generate a Model Equation from a Linear Model

This function extracts and formats the equation from a linear model object. It includes an option to return the equation as a LaTeX-formatted string or print it to the console.

model.equation(model, latex = TRUE)

Arguments

  • model: A linear model object (e.g., output from lm()).
  • latex: A logical value indicating whether to return a LaTeX-formatted equation (default: TRUE). If FALSE, the equation is printed to the console.

Returns

If latex is TRUE, the equation is returned as LaTeX code using knitr::asis_output(). If FALSE, the equation is printed to the console.

Examples

# Fit a linear model model <- lm(mpg ~ wt + hp, data = mtcars) # Get LaTeX equation model.equation(model) # Print equation to console print(model.equation(model, latex = FALSE))
  • Maintainer: Aidan J. Wagner
  • License: MIT + file LICENSE
  • Last published: 2025-03-24

Useful links