This functions takes a data frame with model parameters as input
and formats certain columns into a more readable layout (like collapsing
separate columns for lower and upper confidence interval values). Furthermore,
column names are formatted as well. Note that format_table()
converts all columns into character vectors!
format_table(
x,
pretty_names = TRUE,
stars = FALSE,
digits = 2,
ci_width = "auto",
ci_brackets = TRUE,
ci_digits = 2,
p_digits = 3,
rope_digits = 2,
ic_digits = 1,
zap_small = FALSE,
preserve_attributes = FALSE,
exact = TRUE,
use_symbols = getOption("insight_use_symbols", FALSE),
verbose = TRUE,
...
)A data frame. Note that format_table() converts all columns
into character vectors!
A data frame of model's parameters, as returned by various functions
of the easystats-packages. May also be a result from
broom::tidy().
Return "pretty" (i.e. more human readable) parameter names.
If TRUE, add significance stars (e.g., p < .001***). Can
also be a character vector, naming the columns that should include stars
for significant values. This is especially useful for Bayesian models,
where we might have multiple columns with significant values, e.g. BF
for the Bayes factor or pd for the probability of direction. In such
cases, use stars = c("pd", "BF") to add stars to both columns, or
stars = "BF" to only add stars to the Bayes factor and exclude the pd
column. Currently, following columns are recognized: "BF", "pd" and "p".
Number of digits for
rounding or significant figures. May also be "signif" to return significant
figures or "scientific" to return scientific notation. Control the
number of digits by adding the value as suffix, e.g. digits = "scientific4"
to have scientific notation with 4 decimal places, or digits = "signif5"
for 5 significant figures (see also signif()).
Minimum width of the returned string for confidence
intervals. If not NULL and width is larger than the string's length,
leading whitespaces are added to the string. If width="auto", width
will be set to the length of the longest string.
Logical, if TRUE (default), CI-values are
encompassed in square brackets (else in parentheses).
Logical, if TRUE, small values are rounded after
digits decimal places. If FALSE, values with more decimal
places than digits are printed in scientific notation.
Logical, if TRUE, preserves all attributes
from the input data frame.
Formatting for Bayes factor columns, in case the provided data
frame contains such a column (i.e. columns named "BF" or "log_BF").
For exact = TRUE, very large or very small values are then either reported
with a scientific format (e.g., 4.24e5), else as truncated values (as "> 1000"
and "< 1/1000").
Logical, if TRUE, column names that refer to particular
effectsizes (like Phi, Omega or Epsilon) include the related unicode-character
instead of the written name. This only works on Windows for R >= 4.2, and on
OS X or Linux for R >= 4.0. It is possible to define a global option for this
setting, see 'Note'.
Toggle messages and warnings.
Arguments passed to or from other methods.