ard_dichotomous  R Documentation 
Dichotomous ARD Statistics
Description
Compute Analysis Results Data (ARD) for dichotomous summary statistics.
Usage
ard_dichotomous(
data,
variables,
by = dplyr::group_vars(data),
strata = NULL,
value = maximum_variable_value(data[variables]),
statistic = everything() ~ categorical_summary_fns(),
denominator = NULL,
fmt_fn = NULL,
stat_label = everything() ~ default_stat_labels()
)
Arguments
data 
(data.frame )
a data frame

variables 
(tidyselect )
columns to include in summaries. Default is everything() .

by , strata 
(tidyselect )
columns to tabulate by/stratify by for tabulation.
Arguments are similar, but with an important distinction:
by : results are tabulated by all combinations of the columns specified,
including unobserved combinations and unobserved factor levels.
strata : results are tabulated by all observed combinations of the
columns specified.
Arguments may be used in conjunction with one another.

value 
(named list )
named list of dichotomous values to tabulate. Default is maximum_variable_value(data) ,
which returns the largest/last value after a sort.

statistic 
(formulalistselector )
a named list, a list of formulas,
or a single formula where the list element is a named list of functions
(or the RHS of a formula),
e.g. list(mpg = categorical_summary_fns()) .

denominator 
(data.frame , integer )
Specify this optional argument to change the denominator,
e.g. the "N" statistic. Default is NULL . See below for details.

fmt_fn 
(formulalistselector )
a named list, a list of formulas,
or a single formula where the list element is a named list of functions
(or the RHS of a formula),
e.g. list(mpg = list(mean = \(x) round(x, digits = 2) > as.character)) .

stat_label 
(formulalistselector )
a named list, a list of formulas, or a single formula where
the list element is either a named list or a list of formulas defining the
statistic labels, e.g. everything() ~ list(n = "n", p = "pct") or
everything() ~ list(n ~ "n", p ~ "pct") .

Value
an ARD data frame of class 'card'
Examples
ard_dichotomous(mtcars, by = vs, variables = c(cyl, am), value = list(cyl = 4))
mtcars >
dplyr::group_by(vs) >
ard_dichotomous(
variables = c(cyl, am),
value = list(cyl = 4),
statistic = ~ categorical_summary_fns("p")
)