
Print tables in different output formats
Source:R/display.R
, R/format.R
, R/print_html.R
, and 1 more
display.parameters_model.Rd
Prints tables (i.e. data frame) in different output formats.
print_md()
is a alias for display(format = "markdown")
.
Usage
# 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_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,
groups = 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,
groups = NULL,
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,
groups = NULL,
verbose = TRUE,
...
)
Arguments
- object
An object returned by
model_parameters()
,simulate_parameters()
,equivalence_test()
orprincipal_components()
.- format
String, indicating the output format. Can be
"markdown"
or"html"
.- pretty_names
Return "pretty" (i.e. more human readable) parameter names.
- split_components
Logical, if
TRUE
(default), For models with multiple components (zero-inflation, smooth terms, ...), each component is printed in a separate table. IfFALSE
, model parameters are printed in a single table and aComponent
column is added to the output.- select
Character vector (or numeric index) of column names that should be printed. If
NULL
(default), all columns are printed. The shortcutselect = "minimal"
prints coefficient, confidence intervals and p-values, whileselect = "short"
prints coefficient, standard errors and p-values.- caption
Table caption as string. If
NULL
, no table caption is printed.- subtitle
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 aliastable_caption
, andtable_subtitle
). Ifx
is a list of data frames,caption
may be a list of table captions, one for each table.- footer
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. If
x
is a list of data frames,footer
may be a list of table captions, one for each table.- align
Only applies to HTML tables. May be one of
"left"
,"right"
or"center"
.- digits, ci_digits, p_digits
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, ordigits = "signif5"
for 5 significant figures (see alsosignif()
).- footer_digits
Number of decimal places for values in the footer summary.
- ci_brackets
Logical, if
TRUE
(default), CI-values are encompassed in square brackets (else in parentheses).- show_sigma
Logical, if
TRUE
, adds information about the residual standard deviation.- show_formula
Logical, if
TRUE
, adds the model formula to the output.- zap_small
Logical, if
TRUE
, small values are rounded afterdigits
decimal places. IfFALSE
, values with more decimal places thandigits
are printed in scientific notation.- verbose
Toggle messages and warnings.
- ...
Arguments passed to or from other methods.
- sort
Sort the loadings.
- threshold
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).- labels
A character vector containing labels to be added to the loadings data. Usually, the question related to the item.
- x
An object returned by
model_parameters()
.- ci_width
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. Ifwidth="auto"
, width will be set to the length of the longest string.- groups
Named list, can be used to group parameters in the printed output. List elements may either be character vectors that match the name of those parameters that belong to one group, or list elements can be row numbers of those parameter rows that should belong to one group. The names of the list elements will be used as group names, which will be inserted as "header row". A possible use case might be to emphasize focal predictors and control variables, see 'Examples'. Parameters will be re-ordered according to the order used in
groups
, while all non-matching parameters will be added to the end.
Value
If format = "markdown"
, the return value will be a character
vector in markdown-table format. If format = "html"
, an object of
class gt_tbl
.
Details
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.
Examples
model <- lm(mpg ~ wt + cyl, data = mtcars)
mp <- model_parameters(model)
display(mp)
#>
#>
#> |Parameter | Coefficient | SE | 95% CI | t(29) | p |
#> |:-----------|:-----------:|:----:|:--------------:|:-----:|:------:|
#> |(Intercept) | 39.69 | 1.71 | (36.18, 43.19) | 23.14 | < .001 |
#> |wt | -3.19 | 0.76 | (-4.74, -1.64) | -4.22 | < .001 |
#> |cyl | -1.51 | 0.41 | (-2.36, -0.66) | -3.64 | 0.001 |