View source: R/add_significance_stars.R
add_significance_stars | R Documentation |
experimental Add significance stars to estimates with small p-values
add_significance_stars(
x,
pattern = NULL,
thresholds = c(0.001, 0.01, 0.05),
hide_ci = TRUE,
hide_p = inherits(x, c("tbl_regression", "tbl_uvregression")),
hide_se = FALSE
)
x |
a |
pattern |
glue-syntax string indicating what to display in formatted column.
Default is |
thresholds |
thresholds for significance stars. Default is |
hide_ci |
logical whether to hide confidence interval. Default is |
hide_p |
logical whether to hide p-value. Default is |
hide_se |
logical whether to hide standard error. Default is |
There are planned updates to the implementation of this function
with respect to the pattern=
argument.
Currently, this function replaces the numeric estimate column, with a
formatted character column following pattern=
.
Once gt::cols_merge()
gains the rows=
argument the
implementation will be updated to use it, which will keep
numeric columns numeric. For the vast majority of users,
the planned change will be go unnoticed.
Example 1
Example 2
Example 3
Example 4
tbl <-
lm(time ~ ph.ecog + sex, survival::lung) %>%
tbl_regression(label = list(ph.ecog = "ECOG Score", sex = "Sex"))
# Example 1 ----------------------------------
add_significance_stars_ex1 <-
tbl %>%
add_significance_stars(hide_ci = FALSE, hide_p = FALSE)
# Example 2 ----------------------------------
add_significance_stars_ex2 <-
tbl %>%
add_significance_stars(
pattern = "{estimate} ({conf.low}, {conf.high}){stars}",
hide_ci = TRUE, hide_se = TRUE
) %>%
modify_header(estimate ~ "**Beta (95% CI)**") %>%
modify_footnote(estimate ~ "CI = Confidence Interval", abbreviation = TRUE)
# Example 3 ----------------------------------
# Use ' \n' to put a line break between beta and SE
add_significance_stars_ex3 <-
tbl %>%
add_significance_stars(
hide_se = TRUE,
pattern = "{estimate}{stars} \n({std.error})"
) %>%
modify_header(estimate ~ "**Beta \n(SE)**") %>%
modify_footnote(estimate ~ "SE = Standard Error", abbreviation = TRUE) %>%
as_gt() %>%
gt::fmt_markdown(columns = everything()) %>%
gt::tab_style(
style = "vertical-align:top",
locations = gt::cells_body(columns = label)
)
# Example 4 ----------------------------------
add_significance_stars_ex4 <-
lm(marker ~ stage + grade, data = trial) %>%
tbl_regression() %>%
add_global_p() %>%
add_significance_stars(
hide_p = FALSE,
pattern = "{p.value}{stars}"
) %>%
as_gt() %>%
gt::tab_style(
style = "vertical-align:top",
locations = gt::cells_body(columns = label)
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.