View source: R/datasummary_skim.R
datasummary_skim | R Documentation |
This function was inspired by the excellent skimr
package for R.
See the Details and Examples sections below, and the vignettes on the
modelsummary
website:
https://modelsummary.com/
https://modelsummary.com/articles/datasummary.html
datasummary_skim(
data,
type = "numeric",
output = "default",
fmt = "%.1f",
histogram = TRUE,
title = NULL,
notes = NULL,
align = NULL,
escape = TRUE,
...
)
data |
A data.frame (or tibble) |
type |
of variables to summarize: "numeric" or "categorical" (character) |
output |
filename or object type (character string)
|
fmt |
how to format numeric values: integer, user-supplied function, or
|
histogram |
include a histogram (TRUE/FALSE). Supported for:
|
title |
string |
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.,
|
escape |
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 kableExtra::kbl, gt::gt, DT::datatable, etc. depending on the |
The behavior of modelsummary
can be modified by setting global options. For example:
options(modelsummary_model_labels = "roman")
The rest of this section describes each of the options above.
These global option changes the style of the default column headers:
options(modelsummary_model_labels = "roman")
options(modelsummary_panel_labels = "roman")
The supported styles are: "model", "panel", "arabic", "letters", "roman", "(arabic)", "(letters)", "(roman)""
The panel-specific option is only used when shape="rbind"
modelsummary
supports 4 table-making packages: kableExtra
, gt
,
flextable
, huxtable
, and DT
. 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')
Change the look of tables in an automated and replicable way, using the modelsummary
theming functionality. See the vignette: https://modelsummary.com/articles/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 = "broom")
options(modelsummary_get = "easystats")
options(modelsummary_get = "all")
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")
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")
Arel-Bundock V (2022). “modelsummary: Data and Model Summaries in R.” Journal of Statistical Software, 103(1), 1-23. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.18637/jss.v103.i01")}.'
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.