tbl_ard_summary {gtsummary} | R Documentation |
ARD summary table
Description
![[Experimental]](../help/figures/lifecycle-experimental.svg)
The tbl_ard_summary()
function tables descriptive statistics for
continuous, categorical, and dichotomous variables.
The functions accepts an ARD object.
Usage
tbl_ard_summary(
cards,
by = NULL,
statistic = list(all_continuous() ~ "{median} ({p25}, {p75})", all_categorical() ~
"{n} ({p}%)"),
type = NULL,
label = NULL,
missing = c("no", "ifany", "always"),
missing_text = "Unknown",
missing_stat = "{N_miss}",
include = everything()
)
Arguments
cards |
(card )
An ARD object of class "card" typically created with cards::ard_*() functions.
|
by |
(tidy-select )
A single column from data . Summary statistics will be stratified by this variable.
Default is NULL
|
statistic |
(formula-list-selector )
Used to specify the summary statistics for each variable.
Each of the statistics must be present in card as no new statistics are calculated
in this function.
The default is
list(all_continuous() ~ "{median} ({p25}, {p75})", all_categorical() ~ "{n} ({p}%)") .
|
type |
(formula-list-selector )
Specifies the summary type. Accepted value are
c("continuous", "continuous2", "categorical", "dichotomous") .
Continuous summaries may be assigned c("continuous", "continuous2") , while
categorical and dichotomous cannot be modified.
|
label |
(formula-list-selector )
Used to override default labels in summary table, e.g. list(age = "Age, years") .
The default for each variable is the column label attribute, attr(., 'label') .
If no label has been set, the column name is used.
|
missing , missing_text , missing_stat |
Arguments dictating how and if missing values are presented:
-
missing : must be one of c("no", "ifany", "always")
-
missing_text : string indicating text shown on missing row. Default is "Unknown"
-
missing_stat : statistic to show on missing row. Default is "{N_miss}" .
Possible values are N_miss , N_obs , N_nonmiss , p_miss , p_nonmiss
|
include |
(tidy-select )
Variables to include in the summary table. Default is everything()
|
Value
a gtsummary table of class "tbl_ard_summary"
Examples
library(cards)
ard_stack(
data = ADSL,
ard_categorical(variables = "AGEGR1"),
ard_continuous(variables = "AGE"),
.attributes = TRUE,
.missing = TRUE,
.total_n = TRUE
) |>
tbl_ard_summary()
ard_stack(
data = ADSL,
.by = ARM,
ard_categorical(variables = "AGEGR1"),
ard_continuous(variables = "AGE"),
.attributes = TRUE,
.missing = TRUE,
.total_n = TRUE
) |>
tbl_ard_summary(by = ARM)
[Package
gtsummary version 2.0.2
Index]