present_mdl.lm: Format and present a LaTeX table that summarizes a linear...

In trahelyk/trahelyk_pkg: A collection of tools, mostly for formatting output for dynamic documents

Description

Format and present a LaTeX table that summarizes a linear model object.

Usage

## S3 method for class 'lm'
present_mdl(
  mdl,
  d = 3,
  coef.head = "Coefficient",
  intercept = TRUE,
  varnames = NULL,
  lbl = "",
  footer = c(),
  caption = "",
  latex = TRUE
)

Arguments

mdl	A lm object produced by stats::lm()
d	An integer specifying the number of significant digits to be presented in the point estimate and interval. Defaults to 3.
intercept	Logical indicating whether the intercept should be included in the presentation of the model. Defaults to TRUE.
varnames	Character vector containing the English-version names of the independent variables in themodel. Defaults to names(mdl$coefficients)
lbl	LaTeX label to attach to the presented table.
footer	Text to add to the table footer, printed below the formatted LaTeX table.
caption	Caption to print above the table.
coef_head	Header text to place at the top of the coefficients column in the formatted table.
link	Function to be applied to beta coefficients to yield, for example, odds ratios. I know this is not the link function. Defaults to identity.

Value

A formatted LaTeX table containing estimates of model parameters and some simple fit statistics.

trahelyk/trahelyk_pkg documentation built on June 14, 2021, 9:25 p.m.