scatter_plot.std_campsis_tbl

Plots one or two variables against each other at a given time point, 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

scatter_plot.std_campsis_tbl function

<dl><dt>x</dt>
<dd>a <code>std_campsis_tbl</code> object</dd>
<dt>variable</dt>
<dd>character vector of length 1 or 2 giving the column name(s)
to plot. Defaults to <code>"CONC"</code>. An informative error is raised when
any column is absent.</dd>
<dt>colour</dt>
<dd>stratification for point colour. One of <code>"auto"</code>,
<code>NULL</code>, or a character vector of column names. See Details.</dd>
<dt>time</dt>
<dd>numeric vector of time point(s) to filter to before plotting.
When <code>NULL</code> (default) the minimum time in the data is used (typically
time 0), which is useful for plotting individual parameters. Forwarded to
<code>scatterPlot</code>.</dd>
<dt>...</dt>
<dd>additional arguments (currently unused, reserved for future use)</dd></dl>

Arguments

Plots one or two variables against each other at a given time point, 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).

Scatter plot for standard Campsis simulation output. — scatter_plot.std_campsis_tbl

<dl>

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


<dt>variable</dt>
<dd>character vector of length 1 or 2 giving the column name(s)
to plot. Defaults to <code>"CONC"</code>. An informative error is raised when
any column is absent.</dd>


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


<dt>time</dt>
<dd>numeric vector of time point(s) to filter to before plotting.
When <code>NULL</code> (default) the minimum time in the data is used (typically
time 0), which is useful for plotting individual parameters. Forwarded to
<code>scatterPlot</code>.</dd>


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

</dl>

scatter_plot.std_campsis_tbl: Scatter plot for standard Campsis simulation output.

Description

Usage

Value

Arguments

Details

See Also