vpc_plot.pi_campsis_tbl

Plots VPC ribbons (a confidence interval around the median, lower and upper
percentiles) from a <code>pi_campsis_tbl</code>, i.e. the output of
<code><a href="/link/simulate()?package=campsis&version=1.9.0" data-mini-rdoc="campsis::simulate()">simulate()</a></code> with multiple replicates and a <code>PIOutfun</code>.
Such data already contains the per-replicate prediction interval in long
format (columns <code>replicate</code>, <code>TIME</code>, <code>metric</code> with values
<code>"low"</code> / <code>"med"</code> / <code>"up"</code> and <code>value</code>). This method
only needs to compute the confidence interval around each percentile across
replicates.

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

vpc_plot.pi_campsis_tbl function

<dl><dt>x</dt>
<dd>a <code>pi_campsis_tbl</code> object with a <code>replicate</code> column</dd>
<dt>strata</dt>
<dd>stratification for the VPC. One of <code>"auto"</code>,
<code>NULL</code>, or a named character vector of length 1. See Details.</dd>
<dt>level</dt>
<dd>confidence interval level for the ribbons around each
percentile. Default is <code>0.90</code> (90% CI).</dd>
<dt>alpha</dt>
<dd>transparency of the ribbons. Default is <code>0.15</code>.</dd>
<dt>facet</dt>
<dd>how the stratification variable is displayed when present.
<code>TRUE</code> (default) draws one panel per stratum; <code>FALSE</code> overlays
the strata in a single panel and maps the stratum to the ribbon fill
colour. Forwarded to <code>vpcPlot</code>.</dd>
<dt>...</dt>
<dd>additional arguments (currently unused, reserved for future use)</dd></dl>

Arguments

Plots VPC ribbons (a confidence interval around the median, lower and upper
percentiles) from a <code>pi_campsis_tbl</code>, i.e. the output of
<code><a href='https://rdrr.io/r/stats/simulate.html'>simulate()</a></code> with multiple replicates and a <code>PIOutfun</code>.
Such data already contains the per-replicate prediction interval in long
format (columns <code>replicate</code>, <code>TIME</code>, <code>metric</code> with values
<code>"low"</code> / <code>"med"</code> / <code>"up"</code> and <code>value</code>). This method
only needs to compute the confidence interval around each percentile across
replicates.

VPC plot for prediction-interval Campsis output. — vpc_plot.pi_campsis_tbl

<dl>

<dt>x</dt>
<dd>a <code>pi_campsis_tbl</code> object with a <code>replicate</code> column</dd>


<dt>strata</dt>
<dd>stratification for the VPC. One of <code>"auto"</code>,
<code>NULL</code>, or a named character vector of length 1. See Details.</dd>


<dt>level</dt>
<dd>confidence interval level for the ribbons around each
percentile. Default is <code>0.90</code> (90% CI).</dd>


<dt>alpha</dt>
<dd>transparency of the ribbons. Default is <code>0.15</code>.</dd>


<dt>facet</dt>
<dd>how the stratification variable is displayed when present.
<code>TRUE</code> (default) draws one panel per stratum; <code>FALSE</code> overlays
the strata in a single panel and maps the stratum to the ribbon fill
colour. Forwarded to <code>vpcPlot</code>.</dd>


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

</dl>

vpc_plot.pi_campsis_tbl: VPC plot for prediction-interval Campsis output.

Description

Usage

Value

Arguments

Details

See Also