DefaultSettings

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

DefaultSettings function

<dl><dt>engine</dt>
<dd>Simulation engine: <code>'rxode2'</code> or <code>'mrgsolve'</code>.
Default is <code>NULL</code> (unspecified). If <code>NULL</code>, <code>'mrgsolve'</code> is used first 
(if installed), followed by <code>'rxode2'</code> (if installed).</dd>
<dt>seed</dt>
<dd>random seed number, integer (or NULL for auto-generated seed)</dd>
<dt>replicates</dt>
<dd>number of replicates, integer. Default is 1.</dd>
<dt>outvars</dt>
<dd>output variables, character vector</dd>
<dt>outfuns</dt>
<dd>output functions, outfuns object</dd>
<dt>disabled_variabilities</dt>
<dd>variabilities to disable in the simulation, character vector</dd>
<dt>dosing</dt>
<dd>output dosing information, logical</dd></dl>

Arguments

Create default settings. — DefaultSettings

<dl>

<dt>engine</dt>
<dd>Simulation engine: <code>'rxode2'</code> or <code>'mrgsolve'</code>.
Default is <code>NULL</code> (unspecified). If <code>NULL</code>, <code>'mrgsolve'</code> is used first 
(if installed), followed by <code>'rxode2'</code> (if installed).</dd>


<dt>seed</dt>
<dd>random seed number, integer (or NULL for auto-generated seed)</dd>


<dt>replicates</dt>
<dd>number of replicates, integer. Default is 1.</dd>


<dt>outvars</dt>
<dd>output variables, character vector</dd>


<dt>outfuns</dt>
<dd>output functions, outfuns object</dd>


<dt>disabled_variabilities</dt>
<dd>variabilities to disable in the simulation, character vector</dd>


<dt>dosing</dt>
<dd>output dosing information, logical</dd>

</dl>

DefaultSettings: Create default settings.

Description

Usage

Value

Arguments