This function was inspired by the excellent skimr package for R.

datasummary_skim(
data,
type = "numeric",
output = "default",
fmt = "%.1f",
histogram = TRUE,
title = NULL,
notes = NULL,
align = NULL,
escape = TRUE,
...
)

## Arguments

data A data.frame (or tibble) of variables to summarize: "numeric" or "categorical" (character) filename or object type (character string) Supported filename extensions: .html, .tex, .md, .txt, .png, .jpg. Supported object types: "default", "html", "markdown", "latex", "latex_tabular", "data.frame", "modelsummary_list", "gt", "kableExtra", "huxtable", "flextable", "jupyter". Warning: Users should not supply a file name to the output argument if they intend to customize the table with external packages. See the 'Details' section. LaTeX compilation requires the booktabs and siunitx packages, but siunitx can be disabled or replaced with global options. See the 'Details' section. The default output formats and table-making packages can be modified with global options. See the 'Details' section. determines how to format numeric values integer: the number of digits to keep after the period format(round(x, fmt), nsmall=fmt) character: passed to the sprintf function (e.g., '%.3f' keeps 3 digits with trailing zero). See ?sprintf function: returns a formatted character string. Note on LaTeX formatting: To ensure proper typography, all numeric entries are enclosed in the \num{} command from the siunitx LaTeX package by default. This behavior can be altered with global options. See the 'Details' section. include a histogram (TRUE/FALSE). Supported for: type = "numeric" output is "html", "default", "jpg", "png", or "kableExtra" PDF and HTML documents compiled via Rmarkdown or knitr See the examples section below for an example of how to use datasummary to include histograms in other formats such as markdown. string list or vector of notes to append to the bottom of the table. A string with a number of characters equal to the number of columns in the table (e.g., align = "lcc"). Valid characters: l, c, r, S. "l": left-aligned column "c": centered column "r": right-aligned column "d": dot-aligned column. Only supported for LaTeX/PDF tables produced by kableExtra. These commands must appear in the LaTeX preamble (they are added automatically when compiling Rmarkdown documents to PDF): \usepackage{booktabs} \usepackage{siunitx} \newcolumntype{d}{S[input-symbols = ()]} boolean TRUE escapes or substitutes LaTeX/HTML characters which could prevent the file from compiling/displaying. This setting does not affect captions or notes. all other arguments are passed through to the table-making functions. This allows users to pass arguments directly to datasummary in order to affect the behavior of other functions behind the scenes, for instance: kableExtra::kbl(escape=FALSE) to avoid escaping math characters in kableExtra tables.

## Global Options

The behavior of modelsummary can be affected by setting global options:

• modelsummary_factory_default

• modelsummary_factory_latex

• modelsummary_factory_html

• modelsummary_factory_png

• modelsummary_get

• modelsummary_format_numeric_latex

• modelsummary_format_numeric_html

### Table-making packages

modelsummary supports 4 table-making packages: kableExtra, gt, flextable, and huxtable. Some of these packages have overlapping functionalities. For example, 3 of those packages can export to LaTeX. 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_latex = 'gt') options(modelsummary_factory_word = 'huxtable') options(modelsummary_factory_png = 'gt')

### Model extraction functions

modelsummary can use two sets of packages to extract information from statistical models: broom and the easystats family (performance and parameters). By default, it uses broom first and easystats as a fallback if broom fails. You can change the order of priorities or include goodness-of-fit extracted by both packages by setting:

options(modelsummary_get = "broom") options(modelsummary_get = "easystats") options(modelsummary_get = "all")

### Formatting numeric entries

By default, LaTeX tables enclose all numeric entries in the \num{} 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")

## Examples


if (FALSE) {
dat <- mtcars
dat$vs <- as.logical(dat$vs)
dat$cyl <- as.factor(dat$cyl)
datasummary_skim(dat)
datasummary_skim(dat, "categorical")

# You can use datasummary to produce a similar table in different formats.
# Note that the Histogram function relies on unicode characters. These
# characters will only display correctly in some operating systems, under some
# locales, using some fonts. Displaying such histograms on Windows computers
# is notoriously tricky. The modelsummary authors cannot provide support to
# display these unicode histograms.

f <- All(mtcars) ~ Mean + SD + Min + Median + Max + Histogram
datasummary(f, mtcars, output="markdown")

}