display_linear: Display linear regression results (given a model fit)

In emilelatour/latable: Latour's Table Functions and Helpers

Display linear regression results (given a model fit)

Description

Given a fit object, univariable and (optionally) multivariable results from linear regression are displayed in a format suitable for presentation.

Usage

display_linear(
  fit,
  data,
  add_multi = FALSE,
  format = "html",
  conf_level = 0.95,
  include_last_row = TRUE
)

Arguments

fit	An object of class lm or glm with family = gaussian.
data	A tibble or data frame with the full data set.
add_multi	Logical; include multivariable results. Default is FALSE.
format	Display format in case I need to escape some characters. A placeholder for now in case I need it in the future. Default is "html".
conf_level	The confidence level to use for the confidence interval. Must be strictly greater than 0 and less than 1. Defaults to 0.95, which corresponds to a 95 percent confidence interval.
include_last_row	Adds a row at the end of each set of results to give some breathing room. Default is TRUE.

Value

A tibble

Examples

## Not run: 
# Example with the `mtcars` dataset:
model <- glm(mpg ~ cyl + disp, family = gaussian, data = mtcars)
display_linear(fit = model, data = mtcars, add_multi = TRUE)

## End(Not run)

emilelatour/latable documentation built on Nov. 25, 2024, 4:58 a.m.