ard_proportion_ci

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=cardx&version=0.1.0" alt="[Experimental]"></a> 
Calculate confidence intervals for proportions.

Create extra Analysis Results Data (ARD) summary objects.
The package supplements the simple ARD functions from the 'cards'
package, exporting functions to put statistical results in the ARD
format. These objects are used and re-used to construct summary
tables, visualizations, and written reports.

Daniel D. Sjoberg

cardx

Extra Analysis Results Data Utilities

Daniel Sjoberg

F. Hoffmann-La Roche AG 

ard_proportion_ci function

<dl><dt>data</dt>
<dd>(<code>data.frame</code>) 
a data frame</dd>
<dt>variables</dt>
<dd>(<code><a href="https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html">tidy-select</a></code>) 
columns to include in summaries. Columns must be class <code>&lt;logical&gt;</code>
or <code>&lt;numeric&gt;</code> values coded as <code>c(0, 1)</code>.</dd>
<dt>by</dt>
<dd>(<code><a href="https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html">tidy-select</a></code>) 
columns to stratify calculations by</dd>
<dt>conf.level</dt>
<dd>(<code>numeric</code>) 
a scalar in <code>(0, 1)</code> indicating the confidence level.
Default is <code>0.95</code></dd>
<dt>strata, weights, max.iterations</dt>
<dd>arguments passed to <code>proportion_ci_strat_wilson()</code>,
when <code>method='strat_wilson'</code></dd>
<dt>method</dt>
<dd>(<code>string</code>) 
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 <code>?proportion_ci</code> for details.</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a> 
Calculate confidence intervals for proportions.

ARD Proportion Confidence Intervals — ard_proportion_ci

<dl>

<dt>data</dt>
<dd>(<code>data.frame</code>) 
a data frame</dd>


<dt>variables</dt>
<dd>(<code><a href='https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html'>tidy-select</a></code>) 
columns to include in summaries. Columns must be class <code>&lt;logical&gt;</code>
or <code>&lt;numeric&gt;</code> values coded as <code>c(0, 1)</code>.</dd>


<dt>by</dt>
<dd>(<code><a href='https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html'>tidy-select</a></code>) 
columns to stratify calculations by</dd>


<dt>conf.level</dt>
<dd>(<code>numeric</code>) 
a scalar in <code>(0, 1)</code> indicating the confidence level.
Default is <code>0.95</code></dd>


<dt>strata, weights, max.iterations</dt>
<dd>arguments passed to <code>proportion_ci_strat_wilson()</code>,
when <code>method='strat_wilson'</code></dd>


<dt>method</dt>
<dd>(<code>string</code>) 
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 <code>?proportion_ci</code> for details.</dd>

</dl>

ard_proportion_ci: ARD Proportion Confidence Intervals

Description

Usage

Value

Arguments

Examples