Tidy version of the lm object into a flextable object

Create a rich-formatted table with the 'tidy' information from an lm object.

Usage

# S3 method for lm
tabularise_tidy(
  data,
  header = TRUE,
  title = NULL,
  equation = header,
  auto.labs = TRUE,
  origdata = NULL,
  labs = NULL,
  conf.int = FALSE,
  conf.level = 0.95,
  lang = getOption("data.io_lang", "en"),
  show.signif.stars = getOption("show.signif.stars", TRUE),
  ...,
  kind = "ft",
  env = parent.frame()
)

Arguments

data: An lm 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 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 no term is changed.
conf.int: If TRUE, add the confidence interval. The default is FALSE.
conf.level: The confidence level to use for the confidence interval if conf.int = TRUE. The default is 0.95.
lang: The natural language to use. The default value can be set with, e.g., options(data.io_lang = "fr") for French.
show.signif.stars: If TRUE, add the significance stars to the table. The default is getOption("show.signif.stars")
...: 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 that you can print in different formats (HTML, LaTeX, Word, PowerPoint) or rearrange with the {flextable} functions.

Examples

iris_lm <- lm(data = iris, Petal.Length ~ Sepal.Length)
tabularise::tabularise$tidy(iris_lm)
Linear model
NA
Term Estimate Standard Error t value p value 
\alpha -7.10 0.5067 -14.0 < 2·10-16 ***
\beta_{}  1.86 0.0859  21.6 < 2·10-16 ***
0 <= '***' < 0.001 < '**' < 0.01 < '*' < 0.05

Linear model
NA
Term	Estimate	Standard Error	t value	p value
\alpha	-7.10	0.5067	-14.0	< 2·10-16	***
\beta_{}	1.86	0.0859	21.6	< 2·10-16	***
0 <= '*' < 0.001 < '' < 0.01 < '*' < 0.05