Creates balance tables with summary statistics for different subsets of the data (e.g., control and treatment groups). It can also be used to create summary tables for full data sets. See the Details and Examples sections below, and the vignettes on the modelsummary website:
https://modelsummary.com/
https://modelsummary.com/vignettes/datasummary.html
datasummary_balance(
formula,
data,
output = getOption("modelsummary_output", default = "default"),
fmt = fmt_decimal(digits = 1, pdigits = 3),
title = getOption("modelsummary_title", default = NULL),
notes = getOption("modelsummary_notes", default = NULL),
align = getOption("modelsummary_align", default = NULL),
stars = getOption("modelsummary_stars", default = FALSE),
add_columns = getOption("modelsummary_add_columns", default = NULL),
add_rows = getOption("modelsummary_add_rows", default = NULL),
dinm = getOption("modelsummary_dinm", default = TRUE),
dinm_statistic = getOption("modelsummary_dinm_statistic", default = "std.error"),
escape = getOption("modelsummary_escape", default = TRUE),
...
)
formula
|
|
data
|
A data.frame (or tibble). If this data includes columns called "blocks", "clusters", and/or "weights", the "estimatr" package will consider them when calculating the difference in means. If there is a weights column, the reported mean and standard errors will also be weighted.
|
output
|
filename or object type (character string)
|
fmt
|
how to format numeric values: integer, user-supplied function, or
|
title
|
string. Cross-reference labels should be added with Quarto or Rmarkdown chunk options when applicable. When saving standalone LaTeX files, users can add a label such as \label{tab:mytable} directly to the title string, while also specifying escape=FALSE.
|
notes
|
list or vector of notes to append to the bottom of the table. |
align
|
A string with a number of characters equal to the number of columns in the table (e.g.,
|
stars
|
to indicate statistical significance
|
add_columns
|
a data.frame (or tibble) with the same number of rows as your main table. |
add_rows
|
a data.frame (or tibble) with the same number of columns as your main table. By default, rows are appended to the bottom of the table. Positions can be defined using integers. In the
|
dinm
|
TRUE calculates a difference in means with uncertainty estimates. This option is only available if the estimatr package is installed. If data includes columns named "blocks", "clusters", or "weights", this information will be taken into account automatically by estimatr::difference_in_means.
|
dinm_statistic
|
string: "std.error" or "p.value" |
escape
|
boolean TRUE escapes or substitutes LaTeX/HTML characters which could prevent the file from compiling/displaying. TRUE escapes all cells, captions, and notes. Users can have more fine-grained control by setting escape=FALSE and using an external command such as: modelsummary(model, “latex”) |> tinytable::format_tt(tab, j=1:5, escape=TRUE)
|
…
|
all other arguments are passed through to the table-making functions tinytable::tt, kableExtra::kbl, gt::gt, DT::datatable, etc. depending on the output argument. This allows users to pass arguments directly to datasummary in order to affect the behavior of other functions behind the scenes.
|
Since version 2.0.0, modelsummary uses tinytable as its default table-drawing backend. Learn more at: https://vincentarelbundock.github.io/tinytable/",
Revert to kableExtra for one session:
options(modelsummary_factory_default = ‘kableExtra’) options(modelsummary_factory_latex = ‘kableExtra’) options(modelsummary_factory_html = ‘kableExtra’)
The behavior of modelsummary can be modified by setting global options. In particular, most of the arguments for most of the package’s functions cna be set using global options. For example:
options(modelsummary_output = “modelsummary_list”)
options(modelsummary_statistic = ‘({conf.low}, {conf.high})’)
options(modelsummary_stars = TRUE)
Options not specific to given arguments are listed below.
These global option changes the style of the default column headers:
options(modelsummary_model_labels = “roman”)
The supported styles are: "model", "arabic", "letters", "roman", "(arabic)", "(letters)", "(roman)"
modelsummary supports 6 table-making packages: tinytable, kableExtra, gt, flextable, huxtable, and DT. Some of these packages have overlapping functionalities. To change the default backend used for a specific file format, you can use ’ the options function:
options(modelsummary_factory_html = ‘kableExtra’) options(modelsummary_factory_word = ‘huxtable’) options(modelsummary_factory_png = ‘gt’) options(modelsummary_factory_latex = ‘gt’) options(modelsummary_factory_latex_tabular = ‘kableExtra’)
Change the look of tables in an automated and replicable way, using the modelsummary theming functionality. See the vignette: https://modelsummary.com/vignettes/appearance.html
modelsummary_theme_gt
modelsummary_theme_kableExtra
modelsummary_theme_huxtable
modelsummary_theme_flextable
modelsummary_theme_dataframe
modelsummary can use two sets of packages to extract information from statistical models: the easystats family (performance and parameters) and broom. By default, it uses easystats first and then falls back on broom in case of failure. You can change the order of priorities or include goodness-of-fit extracted by both packages by setting:
options(modelsummary_get = “easystats”)
options(modelsummary_get = “broom”)
options(modelsummary_get = “all”)
The "all" option (default) means easystats then broom.
By default, LaTeX tables enclose all numeric entries in the command from the siunitx package. To prevent this behavior, or to enclose numbers in dollar signs (for LaTeX math mode), users can call:
options(modelsummary_format_numeric_latex = “plain”)
options(modelsummary_format_numeric_latex = “mathmode”)
A similar option can be used to display numerical entries using MathJax in HTML tables:
options(modelsummary_format_numeric_html = “mathjax”)
When creating LaTeX via the tinytable backend (default in version 2.0.0 and later), it is useful to include the following commands in the LaTeX preamble of your documents. These commands are automatically added to the preamble when compiling Rmarkdown or Quarto documents, except when the modelsummary() calls are cached.
\usepackage{tabularray}
\usepackage{float}
\usepackage{graphicx}
\usepackage[normalem]{ulem}
\UseTblrLibrary{booktabs}
\UseTblrLibrary{siunitx}
\newcommand{\tinytableTabularrayUnderline}[1]{\underline{#1}}
\newcommand{\tinytableTabularrayStrikeout}[1]{\sout{#1}}
\NewTableCommand{\tinytableDefineColor}[3]{\definecolor{#1}{#2}{#3}}
library("modelsummary")
library(modelsummary)
datasummary_balance(~am, mtcars)| 0 | 1 | |||||
|---|---|---|---|---|---|---|
| Mean | Std. Dev. | Mean | Std. Dev. | Diff. in Means | Std. Error | |
| mpg | 17.1 | 3.8 | 24.4 | 6.2 | 7.2 | 1.9 |
| cyl | 6.9 | 1.5 | 5.1 | 1.6 | -1.9 | 0.6 |
| disp | 290.4 | 110.2 | 143.5 | 87.2 | -146.8 | 35.0 |
| hp | 160.3 | 53.9 | 126.8 | 84.1 | -33.4 | 26.4 |
| drat | 3.3 | 0.4 | 4.0 | 0.4 | 0.8 | 0.1 |
| wt | 3.8 | 0.8 | 2.4 | 0.6 | -1.4 | 0.2 |
| qsec | 18.2 | 1.8 | 17.4 | 1.8 | -0.8 | 0.6 |
| vs | 0.4 | 0.5 | 0.5 | 0.5 | 0.2 | 0.2 |
| gear | 3.2 | 0.4 | 4.4 | 0.5 | 1.2 | 0.2 |
| carb | 2.7 | 1.1 | 2.9 | 2.2 | 0.2 | 0.7 |