argument_convention

The documentation to this function lists all the arguments in <code>random.cdisc.data</code>
that are used repeatedly in dataset creation.

internal

A set of functions to create random Analysis Data Model
(ADaM) datasets and cached dataset.  ADaM dataset specifications are
described by the Clinical Data Interchange Standards Consortium
(CDISC) Analysis Data Model Team.

Joe Zhu

random.cdisc.data

Create Random ADaM Datasets

argument_convention function

<dl><dt>seed</dt>
<dd>(<code>numeric</code>) Seed to use for reproducible random number generation.</dd>
<dt>na_percentage</dt>
<dd>(<code>proportion</code>) Default percentage of values to be replaced by <code>NA</code>.</dd>
<dt>na_vars</dt>
<dd>(<code>list</code>) A named list where the name of each element is a column name of <code>ds</code>. Each
element of this list should be a numeric vector with two elements:<ul>
<li><code>seed</code> (<code>numeric</code>) The seed to be used for this element - can be <code>NA</code>.</li>
<li><code>percentage</code> (<code>proportion</code>) Percentage of elements to be replaced with <code>NA</code>.
If <code>NA</code>, <code>na_percentage</code> is used as a default.</li>
</ul></dd>
<dt>adsl</dt>
<dd>(<code>data.frame</code>) Subject-Level Analysis Dataset (ADSL).</dd>
<dt>lookup</dt>
<dd>(<code>data.frame</code>) Additional parameters.</dd>
<dt>lookup_aag</dt>
<dd>(<code>data.frame</code>) Additional metadata parameters.</dd>
<dt>param</dt>
<dd>(<code>character vector</code>) Parameter values.</dd>
<dt>paramcd</dt>
<dd>(<code>character vector</code>) Parameter code values.</dd>
<dt>paramu</dt>
<dd>(<code>character vector</code>) Parameter unit values.</dd>
<dt>visit_format</dt>
<dd>(<code>character</code>) Type of visit. Options are "WEEK" and "CYCLE".</dd>
<dt>n_assessments</dt>
<dd>(<code>integer</code>) Number of weeks or cycles.</dd>
<dt>n_days</dt>
<dd>(<code>integer</code>) Number of days in each cycle (only used if <code>visit_format</code> is "CYCLE").</dd>
<dt>aval_mean</dt>
<dd>(<code>numeric vector</code>) Mean values corresponding to each parameter.</dd></dl>

Arguments

Standard Arguments — argument_convention

<dl>

<dt>seed</dt>
<dd>(<code>numeric</code>) Seed to use for reproducible random number generation.</dd>


<dt>na_percentage</dt>
<dd>(<code>proportion</code>) Default percentage of values to be replaced by <code>NA</code>.</dd>


<dt>na_vars</dt>
<dd>(<code>list</code>) A named list where the name of each element is a column name of <code>ds</code>. Each
element of this list should be a numeric vector with two elements:<ul>
<li><code>seed</code> (<code>numeric</code>) The seed to be used for this element - can be <code>NA</code>.</li>
<li><code>percentage</code> (<code>proportion</code>) Percentage of elements to be replaced with <code>NA</code>.
If <code>NA</code>, <code>na_percentage</code> is used as a default.</li>
</ul></dd>


<dt>adsl</dt>
<dd>(<code>data.frame</code>) Subject-Level Analysis Dataset (ADSL).</dd>


<dt>lookup</dt>
<dd>(<code>data.frame</code>) Additional parameters.</dd>


<dt>lookup_aag</dt>
<dd>(<code>data.frame</code>) Additional metadata parameters.</dd>


<dt>param</dt>
<dd>(<code>character vector</code>) Parameter values.</dd>


<dt>paramcd</dt>
<dd>(<code>character vector</code>) Parameter code values.</dd>


<dt>paramu</dt>
<dd>(<code>character vector</code>) Parameter unit values.</dd>


<dt>visit_format</dt>
<dd>(<code>character</code>) Type of visit. Options are "WEEK" and "CYCLE".</dd>


<dt>n_assessments</dt>
<dd>(<code>integer</code>) Number of weeks or cycles.</dd>


<dt>n_days</dt>
<dd>(<code>integer</code>) Number of days in each cycle (only used if <code>visit_format</code> is "CYCLE").</dd>


<dt>aval_mean</dt>
<dd>(<code>numeric vector</code>) Mean values corresponding to each parameter.</dd>

</dl>

argument_convention: Standard Arguments

Description

Arguments