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

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.

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

Arguments

data

A glm object

header

Logical. If TRUE (TRUE by default), a header is added to the table. The header includes both the title and the equation (if applicable). If set to FALSE, neither the title nor the equation will be displayed in the table header, even if the title or equation parameters are provided.

title

If TRUE (TRUE by default), 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

Logical or character. Controls whether an equation is added to the table header and how parameters are used. Accepted values are:

TRUE (default) : The equation is generated and added to the table header. Its parameters are also used in the "Term" column.
FALSE: No equation is generated or displayed, and its parameters are not used in the "Term" column.
Character string: A custom equation is provided directly and added to the table header.

auto.labs

If TRUE (by default), use labels (and units) automatically from data or origdata=.

origdata

The original data set this model was fitted to. By default it is NULL and no label is 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(SciViews_lang = "fr") for French.

...

Additional arguments passed to equatiomatic::equation()

kind

The kind of table to produce: "tt" for tinytable, or "ft" for flextable (default).

env

The environment where to evaluate formulas (you probably do not need to change the default).

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)
Generalized Linear Model
 $E( \operatorname{Petal.Length} ) = \alpha + \beta_{}(\operatorname{Sepal.Length})$ 
Total deviance Total df Log-Likelihood AIC BIC Deviance Residuals df N
464 149 -191 387 396 111 148 150
tabularise::tabularise$glance(iris_glm, equation = FALSE)
Generalized Linear Model
Total deviance Total df Log-Likelihood AIC BIC Deviance Residuals df N
464 149 -191 387 396 111 148 150
tabularise::tabularise$glance(iris_glm, equation = "my personal equation")
Generalized Linear Model
 $my personal equation$ 
Total deviance Total df Log-Likelihood AIC BIC Deviance Residuals df N
464 149 -191 387 396 111 148 150

Generalized Linear Model
$E( \operatorname{Petal.Length} ) = \alpha + \beta_{}(\operatorname{Sepal.Length})$
Total deviance	Total df	Log-Likelihood	AIC	BIC	Deviance	Residuals df	N
464	149	-191	387	396	111	148	150

Generalized Linear Model
$my personal equation$
Total deviance	Total df	Log-Likelihood	AIC	BIC	Deviance	Residuals df	N
464	149	-191	387	396	111	148	150