util_handling_additional_fun_params

retrieve_extra_afun_params

get_additional_afun_params

<a href="https://lifecycle.r-lib.org/articles/stages.html#stable"><img src="figures/lifecycle-stable.svg?package=tern&version=0.9.8" alt="[Stable]"></a>
Important additional parameters, useful to modify behavior of analysis and summary
functions are listed in rtables::additional_fun_params. With these utility functions
we can retrieve a curated list of these parameters from the environment, and pass them
to the analysis functions with dedicated <code>...</code>; notice that the final <code>s_*</code> function
will get them through argument matching.

internal

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

Joe Zhu

tern

Create Common TLGs Used in Clinical Trials

util_handling_additional_fun_params function

<dl><dt>extra_afun_params</dt>
<dd>(<code>list</code>) list of additional parameters (<code>character</code>) to be
retrieved from the environment. Curated list is present in rtables::additional_fun_params.</dd>
<dt>add_alt_df</dt>
<dd>(<code>logical</code>) if <code>TRUE</code>, the function will also add <code>.alt_df</code> and <code>.alt_df_row</code>
parameters.</dd></dl>

Arguments

<ul>
<li><code>retrieve_extra_afun_params()</code>: Retrieve additional parameters from the environment.</li>
<li><code>get_additional_afun_params()</code>: Curated list of additional parameters for
analysis functions. Please check rtables::additional_fun_params for precise descriptions.</li>
</ul>

Functions

<a href='https://lifecycle.r-lib.org/articles/stages.html#stable'><img src='figures/lifecycle-stable.svg' alt='[Stable]' /></a>
Important additional parameters, useful to modify behavior of analysis and summary
functions are listed in rtables::additional_fun_params. With these utility functions
we can retrieve a curated list of these parameters from the environment, and pass them
to the analysis functions with dedicated <code>...</code>; notice that the final <code>s_*</code> function
will get them through argument matching.

Utilities to handle extra arguments in analysis functions — util_handling_additional_fun_params

<dl>

<dt>extra_afun_params</dt>
<dd>(<code>list</code>) list of additional parameters (<code>character</code>) to be
retrieved from the environment. Curated list is present in rtables::additional_fun_params.</dd>


<dt>add_alt_df</dt>
<dd>(<code>logical</code>) if <code>TRUE</code>, the function will also add <code>.alt_df</code> and <code>.alt_df_row</code>
parameters.</dd>

</dl>

util_handling_additional_fun_params: Utilities to handle extra arguments in analysis functions

Description

Usage

Value

Arguments

Functions