add_p.tbl_survfit
Adds p-value to survfit table
Description
![[Experimental]](../help/figures/lifecycle-experimental.svg)
Calculate and add a p-value
Usage
## S3 method for class 'tbl_survfit' add_p( x, test = "logrank", test.args = NULL, pvalue_fun = style_pvalue, include = everything(), quiet = NULL, ... )
Arguments
x |
Object of class |
test |
string indicating test to use. Must be one of |
test.args |
List of formulas containing additional arguments to pass to
tests that accept arguments. For example, add an argument for all t-tests,
use |
pvalue_fun |
Function to round and format p-values.
Default is style_pvalue.
The function must have a numeric vector input (the numeric, exact p-value),
and return a string that is the rounded/formatted p-value (e.g.
|
include |
Variables to include in output. Input may be a vector of
quoted variable names, unquoted variable names, or tidyselect select helper
functions. Default is |
quiet |
Logical indicating whether to print messages in console. Default is
|
... |
Not used |
test argument
The most common way to specify test= is by using a single string indicating
the test name. However, if you need to specify different tests within the same
table, the input in flexible using the list notation common throughout the
gtsummary package. For example, the following code would call the log-rank test,
and a second test of the G-rho family.
... %>%
add_p(test = list(trt ~ "logrank", grade ~ "survdiff"),
test.args = grade ~ list(rho = 0.5))
Example Output
Example 1
Example 2
See Also
Other tbl_survfit tools:
add_n.tbl_survfit(),
add_nevent.tbl_survfit(),
modify,
tbl_merge(),
tbl_stack(),
tbl_survfit()
Examples
library(survival)
gts_survfit <-
list(
survfit(Surv(ttdeath, death) ~ grade, trial),
survfit(Surv(ttdeath, death) ~ trt, trial)
) %>%
tbl_survfit(times = c(12, 24))
# Example 1 ----------------------------------
add_p_tbl_survfit_ex1 <-
gts_survfit %>%
add_p()
# Example 2 ----------------------------------
# Pass `rho=` argument to `survdiff()`
add_p_tbl_survfit_ex2 <-
gts_survfit %>%
add_p(test = "survdiff", test.args = list(rho = 0.5))