d_proportion

<a href="https://lifecycle.r-lib.org/articles/stages.html#stable"><img src="figures/lifecycle-stable.svg?package=tern&version=0.9.12" alt="[Stable]"></a>
This is a helper function that describes the analysis in <code>s_proportion()</code>.

Table, Listings, and Graphs (TLG) library for common outputs
used in clinical trials.

Joe Zhu

tern

Create Common TLGs Used in Clinical Trials

d_proportion function

<dl><dt>conf_level</dt>
<dd>(<code>proportion</code>) confidence level of the interval.</dd>
<dt>method</dt>
<dd>(<code>string</code>) the method used to construct the confidence interval
for proportion of successful outcomes; one of <code>waldcc</code>, <code>wald</code>, <code>clopper-pearson</code>,
<code>wilson</code>, <code>wilsonc</code>, <code>strat_wilson</code>, <code>strat_wilsonc</code>, <code>agresti-coull</code> or <code>jeffreys</code>.</dd>
<dt>long</dt>
<dd>(<code>flag</code>) whether a long or a short (default) description is
required.</dd>
<dt>method_only</dt>
<dd>(<code>flag</code>) whether to return only the method description,
without the confidence interval part of the description.
If <code>TRUE</code>, <code>conf_level</code> and <code>long</code> are ignored.</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#stable'><img src='figures/lifecycle-stable.svg' alt='[Stable]' /></a>
This is a helper function that describes the analysis in <code>s_proportion()</code>.

Description of the proportion summary — d_proportion

<dl>

<dt>conf_level</dt>
<dd>(<code>proportion</code>) confidence level of the interval.</dd>


<dt>method</dt>
<dd>(<code>string</code>) the method used to construct the confidence interval
for proportion of successful outcomes; one of <code>waldcc</code>, <code>wald</code>, <code>clopper-pearson</code>,
<code>wilson</code>, <code>wilsonc</code>, <code>strat_wilson</code>, <code>strat_wilsonc</code>, <code>agresti-coull</code> or <code>jeffreys</code>.</dd>


<dt>long</dt>
<dd>(<code>flag</code>) whether a long or a short (default) description is
required.</dd>


<dt>method_only</dt>
<dd>(<code>flag</code>) whether to return only the method description,
without the confidence interval part of the description.
If <code>TRUE</code>, <code>conf_level</code> and <code>long</code> are ignored.</dd>

</dl>

d_proportion: Description of the proportion summary

Description

Usage

Value

Arguments

See Also

Examples