R/inline_text.R
inline_text.tbl_uvregression.Rd
Extracts and returns statistics from a table created by the tbl_uvregression
function for inline reporting in an R markdown document.
Detailed examples in the
inline_text vignette
# S3 method for tbl_uvregression
inline_text(
x,
variable,
level = NULL,
pattern = "{estimate} ({conf.level*100}% CI {conf.low}, {conf.high}; {p.value})",
estimate_fun = NULL,
pvalue_fun = NULL,
...
)
Object created from tbl_uvregression
Variable name of statistics to present
Level of the variable to display for categorical variables.
Default is NULL
, returning the top row in the table for the variable.
String indicating the statistics to return.
Uses glue::glue formatting.
Default is "{estimate} ({conf.level }% CI {conf.low}, {conf.high}; {p.value})"
.
All columns from x$table_body
are available to print as well as the
confidence level (conf.level). See below for details.
function to style model coefficient estimates.
Columns 'estimate', 'conf.low', and 'conf.high' are formatted.
Default is x$inputs$estimate_fun
function to style p-values and/or q-values.
Default is function(x) style_pvalue(x, prepend_p = TRUE)
Not used
A string reporting results from a gtsummary table
The following items (and more) are available to print. Use print(x$table_body)
to
print the table the estimates are extracted from.
{estimate}
coefficient estimate formatted with 'estimate_fun'
{conf.low}
lower limit of confidence interval formatted with 'estimate_fun'
{conf.high}
upper limit of confidence interval formatted with 'estimate_fun'
{p.value}
p-value formatted with 'pvalue_fun'
{N}
number of observations in model
{label}
variable/variable level label
Other tbl_uvregression tools:
add_global_p()
,
add_q()
,
bold_italicize_labels_levels
,
modify
,
tbl_merge()
,
tbl_split()
,
tbl_stack()
,
tbl_strata()
,
tbl_uvregression()
# \donttest{
inline_text_ex1 <-
trial[c("response", "age", "grade")] %>%
tbl_uvregression(
method = glm,
method.args = list(family = binomial),
y = response,
exponentiate = TRUE
)
inline_text(inline_text_ex1, variable = age)
#> [1] "1.02 (95% CI 1.00, 1.04; p=0.10)"
inline_text(inline_text_ex1, variable = grade, level = "III")
#> [1] "1.10 (95% CI 0.52, 2.29; p=0.8)"
# }