shaded_plot.std_campsis_tbl

Plots a median line with a prediction interval ribbon from a
<code>std_campsis_tbl</code> (the default output of <code><a href="/link/simulate()?package=campsis&version=1.9.0" data-mini-rdoc="campsis::simulate()">simulate()</a></code> when no
custom <code>outfun</code> is used).

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

shaded_plot.std_campsis_tbl function

<dl><dt>x</dt>
<dd>a <code>std_campsis_tbl</code> object</dd>
<dt>variable</dt>
<dd>name of the column to summarise on the y-axis. Defaults to
<code>"CONC"</code>. An informative error is raised when the column is absent.</dd>
<dt>colour</dt>
<dd>stratification for line and ribbon colour. One of
<code>"auto"</code>, <code>NULL</code>, or a character vector of column names.
See Details.</dd>
<dt>strat_extra</dt>
<dd>additional column name(s) used for stratification in the
prediction interval computation but not mapped to colour — useful
when combined with <code>facet_wrap()</code>. Forwarded to
<code>shadedPlot</code>. Default is <code>NULL</code>.</dd>
<dt>level</dt>
<dd>prediction interval level. Default is <code>0.90</code> (90% PI).</dd>
<dt>alpha</dt>
<dd>transparency of the ribbon. Default is <code>0.25</code>.</dd>
<dt>...</dt>
<dd>additional arguments (currently unused, reserved for future use)</dd></dl>

Arguments

Plots a median line with a prediction interval ribbon from a
<code>std_campsis_tbl</code> (the default output of <code><a href='https://rdrr.io/r/stats/simulate.html'>simulate()</a></code> when no
custom <code>outfun</code> is used).

Shaded plot for standard Campsis simulation output. — shaded_plot.std_campsis_tbl

<dl>

<dt>x</dt>
<dd>a <code>std_campsis_tbl</code> object</dd>


<dt>variable</dt>
<dd>name of the column to summarise on the y-axis. Defaults to
<code>"CONC"</code>. An informative error is raised when the column is absent.</dd>


<dt>colour</dt>
<dd>stratification for line and ribbon colour. One of
<code>"auto"</code>, <code>NULL</code>, or a character vector of column names.
See Details.</dd>


<dt>strat_extra</dt>
<dd>additional column name(s) used for stratification in the
prediction interval computation but not mapped to colour — useful
when combined with <code>facet_wrap()</code>. Forwarded to
<code>shadedPlot</code>. Default is <code>NULL</code>.</dd>


<dt>level</dt>
<dd>prediction interval level. Default is <code>0.90</code> (90% PI).</dd>


<dt>alpha</dt>
<dd>transparency of the ribbon. Default is <code>0.25</code>.</dd>


<dt>...</dt>
<dd>additional arguments (currently unused, reserved for future use)</dd>

</dl>

shaded_plot.std_campsis_tbl: Shaded plot for standard Campsis simulation output.

Description

Usage

Value

Arguments

Details

See Also