This is an preview of this function. There will be changes in the coming releases, and changes will not undergo a formal deprecation cycle.
Constructs tables from nested or hierarchical data structures (e.g. adverse events).
Usage
tbl_ard_hierarchical(
cards,
variables,
by = NULL,
include = everything(),
statistic = ~"{n} ({p}%)",
label = NULL
)
Arguments
- cards
(
card
)
An ARD object of class"card"
typically created withcards::ard_*()
functions.- variables
(
tidy-select
)
character vector or tidy-selector of columns in data used to create a hierarchy. Hierarchy will be built with variables in the order given.- by
(
tidy-select
)
a single column fromdata
. Summary statistics will be stratified by this variable. Default isNULL
.- include
(
tidy-select
)
variables fromhierarchy
for which summary statistics should be returned (on the variable label rows) Including the last element ofhierarchy
has no effect since each level has its own row for this variable. The default iseverything()
.- statistic
(
formula-list-selector
)
used to specify the summary statistics to display for all variables intbl_hierarchical()
. The default iseverything() ~ "{n} ({p})"
.- label
(
formula-list-selector
)
used to override default labels in hierarchical table, e.g.list(AESOC = "System Organ Class")
. The default for each variable is the column label attribute,attr(., 'label')
. If no label has been set, the column name is used.
Examples
ADAE_subset <- cards::ADAE |>
dplyr::filter(
AESOC %in% unique(cards::ADAE$AESOC)[1:5],
AETERM %in% unique(cards::ADAE$AETERM)[1:5]
)
# Example 1: Event Rates --------------------
# First, build the ARD
ard <-
cards::ard_stack_hierarchical(
data = ADAE_subset,
variables = c(AESOC, AETERM),
by = TRTA,
denominator = cards::ADSL |> mutate(TRTA = ARM),
id = USUBJID
)
# Second, build table from the ARD
tbl_ard_hierarchical(
cards = ard,
variables = c(AESOC, AETERM),
by = TRTA
)
AESOC
AETERM
Placebo
N = 861
Xanomeline High Dose
N = 841
Xanomeline Low Dose
N = 841
1 n (%)
# Example 2: Event Counts -------------------
ard <-
cards::ard_stack_hierarchical_count(
data = ADAE_subset,
variables = c(AESOC, AETERM),
by = TRTA,
denominator = cards::ADSL |> mutate(TRTA = ARM)
)
tbl_ard_hierarchical(
cards = ard,
variables = c(AESOC, AETERM),
by = TRTA,
statistic = ~"{n}"
)
AESOC
AETERM
Placebo
N = 861
Xanomeline High Dose
N = 841
Xanomeline Low Dose
N = 841
1 n