present_mdl: Generic function to format and present a LaTeX table that...

Description Usage Arguments Value

View source: R/present_models.R

Description

Generic function to format and present a LaTeX table that summarizes a model object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
present_mdl(
  mdl,
  coef.head = "",
  link = identity,
  footer = c(),
  d = 3,
  intercept = TRUE,
  varnames,
  lbl = "",
  caption = "",
  corPars = FALSE
)

Arguments

mdl

A model object

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.

footer

Text to add to the table footer, printed below the formatted LaTeX table.

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.

caption

Caption to print above the table.

corPars

Logical indicating whether correlation parameters should be included in the presentation of the model (for GEE models). Defaults to FALSE.

coef_head

Header text to place at the top of the coefficients column in the formatted table.

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.