tabularise_coef.glm: Create a rich-formatted table using the coefficients of a glm...

In SciViews/modelit: Statistical Models for 'SciViews::R'

Create a rich-formatted table using the coefficients of a glm object

Description

Extract and format the table of coefficients from a glm object, similar to stats::coef(), but in a rich-formatted flextable object.

Usage

## S3 method for class 'glm'
tabularise_coef(
  data,
  header = TRUE,
  title = NULL,
  equation = header,
  auto.labs = TRUE,
  origdata = NULL,
  labs = NULL,
  lang = getOption("data.io_lang", "en"),
  ...,
  kind = "ft",
  env = parent.frame()
)

Arguments

data	A glm object
header	If TRUE (by default), add a header to the table
title	If TRUE, add a title to the table header. Default to the same value than header, except outside of a chunk where it is FALSE if a table caption is detected (tbl-cap YAML entry).
equation	If TRUE (by default), add an equation to the table header. The equation can also be passed in the form of a character string (LaTeX).
auto.labs	If TRUE (by default), use labels (and units) automatically from ⁠origdata=⁠.
origdata	The original data set this model was fitted to. By default it is NULL and labels of the original data set are not used.
labs	Labels to change the names of elements in the term column of the table. By default, it is NULL and no change is performed.
lang	The natural language to use. The default value can be set with, e.g., options(data.io_lang = "fr") for French.
...	Additional arguments (not used yet).
kind	The kind of table to produce: "tt" for tinytable, or "ft" for flextable (default).
env	The environment where to evaluate lazyeval expressions (unused for now).

Value

A flextable object is returned. You can print it in different formats (HTML, LaTeX, Word, PowerPoint) or rearrange it with the {flextable} functions.

Examples

iris_glm <- glm(data = iris, Petal.Length ~ Sepal.Length)
tabularise::tabularise$coef(iris_glm)

SciViews/modelit documentation built on Nov. 24, 2024, 10:23 a.m.