Prints tables (i.e. data frame) in different output formats.
print_md()
is a alias for display(format = "markdown")
.
# S3 method for parameters_model
display(
object,
format = "markdown",
pretty_names = TRUE,
split_components = TRUE,
select = NULL,
caption = NULL,
subtitle = NULL,
footer = NULL,
align = NULL,
digits = 2,
ci_digits = 2,
p_digits = 3,
footer_digits = 3,
ci_brackets = c("(", ")"),
show_sigma = FALSE,
show_formula = FALSE,
zap_small = FALSE,
verbose = TRUE,
...
)# S3 method for parameters_stan
display(
object,
split_components = TRUE,
select = NULL,
format = "markdown",
...
)
# S3 method for parameters_sem
display(
object,
format = "markdown",
digits = 2,
ci_digits = 2,
p_digits = 3,
ci_brackets = c("(", ")"),
...
)
# S3 method for parameters_efa_summary
display(object, format = "markdown", digits = 3, ...)
# S3 method for parameters_efa
display(
object,
format = "markdown",
digits = 2,
sort = FALSE,
threshold = NULL,
labels = NULL,
...
)
# S3 method for equivalence_test_lm
display(object, format = "markdown", digits = 2, ...)
# S3 method for parameters_model
format(
x,
pretty_names = TRUE,
split_components = TRUE,
select = NULL,
digits = 2,
ci_digits = 2,
p_digits = 3,
ci_width = NULL,
ci_brackets = NULL,
zap_small = FALSE,
format = NULL,
...
)
# S3 method for parameters_model
print_html(
x,
pretty_names = TRUE,
split_components = TRUE,
select = NULL,
caption = NULL,
subtitle = NULL,
footer = NULL,
align = NULL,
digits = 2,
ci_digits = 2,
p_digits = 3,
footer_digits = 3,
ci_brackets = c("(", ")"),
show_sigma = FALSE,
show_formula = FALSE,
zap_small = FALSE,
verbose = TRUE,
...
)
# S3 method for parameters_model
print_md(
x,
pretty_names = TRUE,
split_components = TRUE,
select = NULL,
caption = NULL,
subtitle = NULL,
footer = NULL,
align = NULL,
digits = 2,
ci_digits = 2,
p_digits = 3,
footer_digits = 3,
ci_brackets = c("(", ")"),
show_sigma = FALSE,
show_formula = FALSE,
zap_small = FALSE,
verbose = TRUE,
...
)
An object returned by model_parameters()
,
simulate_parameters()
,
equivalence_test()
or
principal_components()
.
String, indicating the output format. Can be "markdown"
or "html"
.
Return "pretty" (i.e. more human readable) parameter names.
Logical, if TRUE
(default), For models with
multiple components (zero-inflation, smooth terms, ...), each component is
printed in a separate table. If FALSE
, model parameters are printed
in a single table and a Component
column is added to the output.
Character vector (or numeric index) of column names that should
be printed. If NULL
(default), all columns are printed. The shortcut
select = "minimal"
prints coefficient, confidence intervals and p-values,
while select = "short"
prints coefficient, standard errors and p-values.
Table caption as string. If NULL
, no table caption is printed.
Table title (same as caption) and subtitle, as strings. If NULL
,
no title or subtitle is printed, unless it is stored as attributes (table_title
,
or its alias table_caption
, and table_subtitle
).
Table footer, as string. For markdown-formatted tables, table footers, due to the limitation in markdown rendering, are actually just a new text line under the table.
Only applies to HTML tables. May be one of "left"
,
"right"
or "center"
.
Number of decimal places for numeric values (except confidence intervals and p-values).
Number of decimal places for confidence intervals.
Number of decimal places for p-values. May also be "scientific"
for scientific notation of p-values.
Number of decimal places for values in the footer summary.
Logical, if TRUE
(default), CI-values are
encompassed in square brackets (else in parentheses).
Logical, if TRUE
, adds information about the residual
standard deviation.
Logical, if TRUE
, adds the model formula to the output.
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.
Toggle messages and warnings.
Arguments passed to or from other methods.
Sort the loadings.
A value between 0 and 1 indicates which (absolute) values
from the loadings should be removed. An integer higher than 1 indicates the
n strongest loadings to retain. Can also be "max"
, in which case it
will only display the maximum loading per variable (the most simple
structure).
A character vector containing labels to be added to the loadings data. Usually, the question related to the item.
An object returned by model_parameters()
.
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.
If format = "markdown"
, the return value will be a character
vector in markdown-table format. If format = "html"
, an object of
class gt_tbl
.
display()
is useful when the table-output from functions,
which is usually printed as formatted text-table to console, should
be formatted for pretty table-rendering in markdown documents, or if
knitted from rmarkdown to PDF or Word files. See
vignette
for examples.
# NOT RUN {
model <- lm(mpg ~ wt + cyl, data = mtcars)
mp <- model_parameters(model)
display(mp)
# }
Run the code above in your browser using DataLab