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

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

Create a rich-formatted table using the coefficients of an lm object

Description

This function extracts and formats the table of coefficients from an lm object, similar to stats::coef(), but in a rich-formatted table using {flextable}.

Usage

## S3 method for class 'lm'
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	An lm 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 a equation to the table header. The equation can also be passed in the form of a character string.
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(data.io_lang = "fr") for French.
...	Additional arguments
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$coef(iris_lm)

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