Skip to contents

[Experimental]
Summarize a continuous variable by one or more categorical variables

Usage

tbl_ard_continuous(
  cards,
  variable,
  include,
  by = NULL,
  label = NULL,
  statistic = everything() ~ "{median} ({p25}, {p75})",
  value = NULL
)

Arguments

cards

(card)
An ARD object of class "card" typically created with cards::ard_*() functions.

variable

(string)
A single variable name of the continuous variable being summarized.

include

(character)
Character vector of the categorical variables to

by

(string)
A single variable name of the stratifying variable.

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.

statistic

(formula-list-selector)
Specifies summary statistics to display for each variable. The default is everything() ~ "{median} ({p25}, {p75})".

value

(formula-list-selector)
Supply a value to display a variable on a single row, printing the results for the variable associated with the value (similar to a 'dichotomous' display in tbl_summary()).

Value

a gtsummary table of class "tbl_ard_summary"

Examples

library(cards)

# Example 1 ----------------------------------
# the primary ARD with the results
ard_continuous(
  # the order variables are passed is important for the `by` variable.
  # 'trt' is the column stratifying variable and needs to be listed first.
  trial, by = c(trt, grade), variables = age
) |>
  # adding OPTIONAL information about the summary variables
  bind_ard(
    # add univariate trt tabulation
    ard_categorical(trial, variables = trt),
    # add missing and attributes ARD
    ard_missing(trial, by = c(trt, grade), variables = age),
    ard_attributes(trial, variables = c(trt, grade, age))
  ) |>
  tbl_ard_continuous(by = "trt", variable = "age", include = "grade")
Characteristic Drug A1 Drug B1
Grade

    I 46.0 (36.0, 60.0) 48.0 (42.0, 55.0)
    II 44.5 (31.0, 55.0) 50.5 (42.0, 57.5)
    III 51.5 (41.5, 60.5) 45.0 (36.0, 52.0)
1 Age: Median (Q1, Q3)
# Example 2 ---------------------------------- # the primary ARD with the results ard_continuous(trial, by = grade, variables = age) |> # adding OPTIONAL information about the summary variables bind_ard( # add missing and attributes ARD ard_missing(trial, by = grade, variables = age), ard_attributes(trial, variables = c(grade, age)) ) |> tbl_ard_continuous(variable = "age", include = "grade")
Characteristic Overall1
Grade
    I 47.0 (37.0, 56.0)
    II 48.5 (37.0, 57.0)
    III 47.0 (38.0, 58.0)
1 Age: Median (Q1, Q3)