outfun-class

A generic, easy-to-use and intuitive
pharmacokinetic/pharmacodynamic (PK/PD) simulation platform based on
the R packages 'rxode2' and 'mrgsolve'. Campsis provides an
abstraction layer over the underlying processes of defining a PK/PD
model, assembling a custom dataset and running a simulation. The
package has a strong dependency on the R package 'campsismod', which
allows models to be read from and written to files, including through
a JSON-based interface, and to be adapted further on the fly in the R
environment. In addition, 'campsis' allows users to assemble datasets
in an intuitive manner, including via a JSON-based interface to import
Campsis datasets defined using formal JSON schemas distributed with
the package. Once the dataset is ready, the package prepares the
simulation, calls 'rxode2' or 'mrgsolve' (at the user's choice), and
returns the results for the given model, dataset and desired
simulation settings. The package itself is licensed under the GPL (>=
3); the JSON schema files shipped in inst/extdata are licensed
separately under the Creative Commons Attribution 4.0 International
(CC BY 4.0).

Nicolas Luyckx

campsis

Generic PK/PD Simulation Platform Campsis

outfun-class function

<dl>
<dt><code>fun</code></dt>
<dd>function or purrr-style lambda formula, first argument 'x' must be the results</dd></dl>
<dt><code>name</code></dt>
<dd>name of the output function</dd>
<dt><code>args</code></dt>
<dd>extra arguments, named list</dd>
<dt><code>packages</code></dt>
<dd>packages that must be loaded to execute the given function, character vector</dd>
<dt><code>level</code></dt>
<dd>either 'scenario' or 'replicate'. Default is 'scenario'.</dd>
<dt><code>cls</code></dt>
<dd>resulting S3 class(es) of the Campsis output</dd>
<dt><code>outfun_as_arg</code></dt>
<dd>logical, whether to pass the outfun object as an argument to the function</dd>

Slots

Output function class. — outfun-class

<dl>
<dt><code>fun</code></dt>
<dd>function or purrr-style lambda formula, first argument 'x' must be the results</dd>


<dt><code>name</code></dt>
<dd>name of the output function</dd>


<dt><code>args</code></dt>
<dd>extra arguments, named list</dd>


<dt><code>packages</code></dt>
<dd>packages that must be loaded to execute the given function, character vector</dd>


<dt><code>level</code></dt>
<dd>either 'scenario' or 'replicate'. Default is 'scenario'.</dd>


<dt><code>cls</code></dt>
<dd>resulting S3 class(es) of the Campsis output</dd>


<dt><code>outfun_as_arg</code></dt>
<dd>logical, whether to pass the outfun object as an argument to the function</dd>


</dl>

outfun-class: Output function class.

Description

Arguments

Slots