summary_as_tex: Model Summary as table

View source: R/summary_as_tex.R

summary_as_texR Documentation

Model Summary as table

Description

This is just a quick way to make a table for output to either html or, more importantly, latex fragments. If you want more fine grained customization, use gtsummary or kable yourself. Right now these have to be glmers or lmers, but I'll make something more general later when/if I need it.

Usage

summary_as_tex(
  model,
  correct = NA,
  statistic = "$z$",
  caption = NA,
  label = NA,
  table.envir = "table",
  tabular.envir = "tabular",
  include_prior = FALSE,
  ci_level = 0.95,
  use_ROPE = FALSE
)

Arguments

model

Model object

correct

Regular expressions targeting coefficients to bonferroni correct

statistic

Header label for the test statistic, recommended to bookend in $s

caption

Caption to use for the table

label

Label to use when referencing the table

table.envir

LaTeX table environment to use, defaults to table, change not implemented yet

tabular.envir

LaTeX tabular environment to use, defaults to table, can be changed to tabular*

include_prior

Should priors be included? (only if model is brmsfit)

ci_level

Defaults to .95 (only if model is brmsfit)

use_ROPE

ROPE object from bayestestR::rope, or TRUE to run this with the default settings. Adds the to not include. (only if model is brmsfit)


tsostarics/sostools documentation built on Nov. 22, 2022, 7:26 p.m.