sort_ard_hierarchical

<a href="https://lifecycle.r-lib.org/articles/stages.html#experimental"><img src="figures/lifecycle-experimental.svg?package=cards&version=0.6.1" alt="[Experimental]"></a> 
This function is used to sort stacked hierarchical ARDs.
For the purposes of this function, we define a "variable group" as a combination of ARD rows grouped by the
combination of all their variable levels, but excluding any <code>by</code> variables.

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 

sort_ard_hierarchical function

<dl><dt>x</dt>
<dd>(<code>card</code>) 
a stacked hierarchical ARD of class <code>'card'</code> created using <code>ard_stack_hierarchical()</code> or
<code>ard_stack_hierarchical_count()</code>.</dd>
<dt>sort</dt>
<dd>(<code>string</code>) 
type of sorting to perform. Value must be one of:<ul>
<li><code>"alphanumeric"</code> - within each hierarchical section of the ARD, groups are ordered alphanumerically (i.e. A to Z)
by <code>variable_level</code> text.</li>
<li><code>"descending"</code> - within each variable group of the ARD, count sums are calculated for each group and groups are
sorted in descending order by sum. If <code>sort = "descending"</code>, the <code>n</code> statistic is used to calculate variable
group sums if included in <code>statistic</code> for all variables, otherwise <code>p</code> is used. If neither <code>n</code> nor <code>p</code> are
present in <code>x</code> for all variables, an error will occur.</li>
</ul></dd>Defaults to <code>"descending"</code>.</dl>

Arguments

<a href='https://lifecycle.r-lib.org/articles/stages.html#experimental'><img src='figures/lifecycle-experimental.svg' alt='[Experimental]' /></a> 
This function is used to sort stacked hierarchical ARDs.
For the purposes of this function, we define a "variable group" as a combination of ARD rows grouped by the
combination of all their variable levels, but excluding any <code>by</code> variables.

Sort Stacked Hierarchical ARDs — sort_ard_hierarchical

<dl>

<dt>x</dt>
<dd>(<code>card</code>) 
a stacked hierarchical ARD of class <code>'card'</code> created using <code>ard_stack_hierarchical()</code> or
<code>ard_stack_hierarchical_count()</code>.</dd>


<dt>sort</dt>
<dd>(<code>string</code>) 
type of sorting to perform. Value must be one of:<ul>
<li><code>"alphanumeric"</code> - within each hierarchical section of the ARD, groups are ordered alphanumerically (i.e. A to Z)
by <code>variable_level</code> text.</li>
<li><code>"descending"</code> - within each variable group of the ARD, count sums are calculated for each group and groups are
sorted in descending order by sum. If <code>sort = "descending"</code>, the <code>n</code> statistic is used to calculate variable
group sums if included in <code>statistic</code> for all variables, otherwise <code>p</code> is used. If neither <code>n</code> nor <code>p</code> are
present in <code>x</code> for all variables, an error will occur.</li>
</ul>

Defaults to <code>"descending"</code>.</dd>

</dl>

sort_ard_hierarchical: Sort Stacked Hierarchical ARDs

Description

Usage

Value

Arguments

See Also