tabularise_glance.glm: Create a glance version of the glm object as a rich-formatted...

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

Create a glance version of the glm object as a rich-formatted table

Description

Turn the glance of glm object into a rich-formatted table with {flextable}. The table can be printed in different formats (HTML, LaTeX, Word, PowerPoint), or rearranged later on.

Usage

## S3 method for class 'glm'
tabularise_glance(
  data,
  header = TRUE,
  title = NULL,
  equation = TRUE,
  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 an 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 original labels are not used.
labs	Labels to change the names of elements in the term column of the table. By default it is NULL and nothing is changed.
lang	The natural language to use. The default value can be set with, e.g., options(data.io_lang = "fr") for French.
...	Additional arguments passed to tabularise::equation()
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 produced that you can print in different formats (HTML, LaTeX, Word, PowerPoint) or rearrange with the {flextable} functions.

Examples

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

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