ard_proportion_ci {cardx}

ARD Proportion Confidence Intervals

Description

Calculate confidence intervals for proportions.

Usage

ard_proportion_ci(
  data,
  variables,
  by = dplyr::group_vars(data),
  conf.level = 0.95,
  strata,
  weights = NULL,
  max.iterations = 10,
  method = c("waldcc", "wald", "clopper-pearson", "wilson", "wilsoncc", "strat_wilson",
    "strat_wilsoncc", "agresti-coull", "jeffreys")
)

Arguments

data

(data.frame)
a data frame

variables

(tidy-select)
columns to include in summaries. Columns must be class ⁠<logical>⁠ or ⁠<numeric>⁠ values coded as c(0, 1).

by

(tidy-select)
columns to stratify calculations by

conf.level

(numeric)
a scalar in ⁠(0, 1)⁠ indicating the confidence level. Default is 0.95

strata, weights, max.iterations

arguments passed to proportion_ci_strat_wilson(), when method='strat_wilson'

method

(string)
string indicating the type of confidence interval to calculate. Must be one of 'waldcc', 'wald', 'clopper-pearson', 'wilson', 'wilsoncc', 'strat_wilson', 'strat_wilsoncc', 'agresti-coull', 'jeffreys'. See ?proportion_ci for details.

Value

an ARD data frame

Examples

ard_proportion_ci(mtcars, variables = c(vs, am), method = "wilson")