ard_strata

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=cards&version=0.3.0" alt="[Experimental]"></a> 
General function for calculating ARD results within subgroups.
While the examples below show use with other functions from the cards package,
this function would primarily be used with the statistical functions in the
cardx functions.

Construct CDISC (Clinical Data Interchange Standards
Consortium) compliant Analysis Results Data objects. These objects are
used and re-used to construct summary tables, visualizations, and
written reports. The package also exports utilities for working with
these objects and creating new Analysis Results Data objects.

Daniel D. Sjoberg

cards

Analysis Results Data

Becca Krouse

Emily de la Rua

F. Hoffmann-La Roche AG 

GlaxoSmithKline Research & Development Limited 

ard_strata function

<dl><dt>.data</dt>
<dd>(<code>data.frame</code>) 
a data frame</dd>
<dt>.by, .strata</dt>
<dd>(<code><a href="https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html">tidy-select</a></code>) 
columns to tabulate by/stratify by for calculation.
Arguments are similar, but with an important distinction:
<code>.by</code>: results are tabulated by all combinations of the columns specified,
including unobserved combinations and unobserved factor levels.
<code>.strata</code>: results are tabulated by all observed combinations of the
columns specified.
These argument should not include any columns that appear in the <code>.f</code> argument.</dd>
<dt>.f</dt>
<dd>(<code>function</code>, <code>formula</code>) 
a function or a formula that can be coerced to a function with
<code><a href="https://rlang.r-lib.org/reference/as_function.html">rlang::as_function()</a></code> (similar to <code>purrr::map(.f)</code>)</dd>
<dt>...</dt>
<dd>Additional arguments passed on to the <code>.f</code> function.</dd></dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a> 
General function for calculating ARD results within subgroups.
While the examples below show use with other functions from the cards package,
this function would primarily be used with the statistical functions in the
cardx functions.

Stratified ARD — ard_strata

<dl>

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


<dt>.by, .strata</dt>
<dd>(<code><a href='https://dplyr.tidyverse.org/reference/dplyr_tidy_select.html'>tidy-select</a></code>) 
columns to tabulate by/stratify by for calculation.
Arguments are similar, but with an important distinction:
<code>.by</code>: results are tabulated by all combinations of the columns specified,
including unobserved combinations and unobserved factor levels.
<code>.strata</code>: results are tabulated by all observed combinations of the
columns specified.
These argument should not include any columns that appear in the <code>.f</code> argument.</dd>


<dt>.f</dt>
<dd>(<code>function</code>, <code>formula</code>) 
a function or a formula that can be coerced to a function with
<code><a href='https://rlang.r-lib.org/reference/as_function.html'>rlang::as_function()</a></code> (similar to <code>purrr::map(.f)</code>)</dd>


<dt>...</dt>
<dd>Additional arguments passed on to the <code>.f</code> function.</dd>

</dl>

ard_strata: Stratified ARD

Description

Usage

Value

Arguments

Examples