campsis1.5.4 package

Generic PK/PD Simulation Platform CAMPSIS

applyCompartmentCharacteristics

Apply compartment characteristics from model. In practice, only compar...

applyScenario

Apply scenario to the given model or dataset.

arm-class

Arm class.

Arm

Create a treatment arm.

arms-class

Arms class.

assignDoseNumber

Assign dose number to each treatment entry.

BinomialDistribution

Binomial distribution.

bolus-class

Bolus class.

Bolus

Create one or several bolus(es).

bootstrap_distribution-class

Bootstrap distribution class.

bootstrap-class

Bootstrap class.

Bootstrap

Create a bootstrap object.

BootstrapDistribution

Create a bootstrap distribution. During function sampling, CAMPSIS wil...

campsis_handler

Suggested Campsis handler for showing the progress bar.

checkIIandADDL

Check ii and addl arguments in addition to time.

computeIncrementalProgress

Compute incremental progress.

constant_distribution-class

Constant distribution class.

ConstantDistribution

Create a constant distribution. Its value will be constant across all ...

convertTime

Convert numeric time vector based on the provided units.

counterBalanceLocfMode

Counter-balance LOCF mode for occasions & IOV. This function will simp...

counterBalanceNocbMode

Counter-balance NOCB mode for occasions & IOV. This function will simp...

covariate-class

Covariate class.

Covariate

Create a non time-varying (fixed) covariate.

covariates-class

Covariates class.

cutTableForEvent

Cut table according to given iteration.

dataset_config-class

Dataset configuration class.

dataset-class

Dataset class.

Dataset

Create a dataset.

DatasetConfig

Create a dataset configuration. This configuration allows CAMPSIS to k...

DatasetSummary

Create a dataset summary (internal method).

days

Convert days to hours.

declare_settings-class

Declare settings class.

Declare

Create declare settings.

DiscreteDistribution

Discrete distribution.

distribution-class

Distribution class. See this class as an interface.

dose_adaptation-class

Dose adaptation class.

dose_adaptations-class

Dose adaptations class.

DoseAdaptation

Create a dose adaptation.

dosingOnly

Filter CAMPSIS output on dosing rows.

dropOthers

Return the 'DROP_OTHERS' string that may be used in the 'outvars' vect...

EtaDistribution

Create an ETA distribution. The resulting distribution is a normal dis...

event_covariate-class

Event covariate class.

event-class

Event class.

Event

Create an interruption event.

EventCovariate

Create an event covariate. These covariates can be modified further in...

EventIteration

Create an event iteration object.

EventRelatedObservations

Create an event-related observations list. Please note that the provid...

events-class

Events class.

Events

Create a list of interruption events.

exportDelegate

Export delegate method. This method is common to RxODE and mrgsolve.

exportTableDelegate

Export table delegate.

factorScenarios

Factor scenarios columns if not done yet.

fillIOVOccColumns

Fill IOV/Occasion columns.

fixed_covariate-class

Fixed covariate class.

fixed_distribution-class

Fixed distribution class.

FixedDistribution

Create a fixed distribution. Each sample will be assigned a fixed valu...

function_distribution-class

Function distribution class.

FunctionDistribution

Create a function distribution. During distribution sampling, the prov...

generateIIV_

Generate IIV matrix for the given OMEGA matrix.

generateIIV

Generate IIV matrix for the given Campsis model.

getAvailableTimeUnits

Return the list of available time units.

getColumn

Get data of given column unless if does not exist (return NULL in that...

getCovariates

Get all covariates (fixed / time-varying / event covariates).

getDatasetMaxTime

Get dataset max time.

getEventCovariates

Get all event-related covariates.

getEventIterations

Get list of event iterations.

getFixedCovariates

Get all fixed covariates.

getFurrrScheduling

Get scheduling mode for furrr (see argument 'scheduling' available in ...

getInitialConditions

Get initial conditions at simulation start-up.

getIOVs

Get all IOV objects.

getOccasions

Get all occasions.

getRandomSeedValue

Get random seed value.

getSeed

Get seed value.

getSeedForDatasetExport

Get seed for dataset export.

getSeedForIteration

Get seed for iteration.

getSeedForParametersSampling

Get seed for parameter uncertainty sampling.

getSimulationEngineType

Get simulation engine type.

getSplittingConfiguration

Get splitting configuration for parallel export.

getTimes

Get all distinct times for the specified object.

getTimeVaryingCovariates

Get all time-varying covariates.

getTimeVaryingVariables

Get all time-varying variables. These variables are likely to be influ...

hardware_settings-class

Hardware settings class.

Hardware

Create hardware settings.

hours

Convert hours to hours (do nothing).

importCampsismodToNamespace

Import the whole campsismod package into NAMESPACE when parsed by 'rox...

infusion-class

Infusion class.

Infusion

Create one or several infusion(s).

internal_settings-class

Internal settings class (transient object from the simulation settings...

IOV

Define inter-occasion variability (IOV) into the dataset. A new variab...

isEmptyBootstrap

Is the given bootstrap empty.

leftJoinIIV

Left-join IIV matrix.

length-arm-method

Return the number of subjects contained in this arm.

length-dataset-method

Return the number of subjects contained in this dataset.

LogNormalDistribution

Create a log normal distribution.

mergeTimeVaryingCovariates

Merge time-varying covariates into a single data frame. This last data...

minutes

Convert minutes to hours.

months

Convert pharma months (1 month = 4 weeks) to hours.

mrgsolve_engine-class

mrgsolve engine class.

nocb_settings-class

NOCB settings class.

NOCB

Create NOCB settings.

NormalDistribution

Create a normal distribution.

observations_set-class

Observations set class.

observations-class

Observations class.

Observations

Create an observations list. Please note that the provided 'times' wil...

obsOnly

Filter CAMPSIS output on observation rows.

occasion-class

Occasion class.

Occasion

Define a new occasion. Occasions are defined by mapping occasion value...

occasions-class

Occasions class.

Outfun

Create a new output function

output_function-class

Output function class.

ParameterDistribution

Create a parameter distribution. The resulting distribution is a log-n...

PI

Compute the prediction interval summary over time.

preprocessArmColumn

Preprocess ARM column. Add ARM equation in model automatically.

preprocessDest

Pre-process destination engine. Throw an error message if the destinat...

preprocessDosing

Preprocess 'dosing' argument.

preprocessEvents

Pre-process events.

preprocessIds

Preprocess subjects ID's.

preprocessNocbvars

Preprocess 'nocbvars' argument.

preprocessOutfun

Pre-process outfun argument.

preprocessOutvars

Preprocess 'outvars' argument. 'Outvars' is a character vector which t...

preprocessReplicates

Preprocess 'replicates' argument.

preprocessScenarios

Pre-process scenarios.

preprocessSettings

Preprocess the simulation settings.

preprocessSlices

Preprocess 'slices' argument.

preprocessTablefun

Pre-process tablefun argument.

preprocessTSLDAndTDOSColumn

Preprocess TSLD and TDOS columns according to given dataset configurat...

processAllTimeColumns

Process time-related columns according to given dataset configuration.

processArmLabels

Process arm labels. Arm identifiers in ARM column are replaced by arm ...

processDropOthers

Process 'DROP_OTHERS'.

processSimulateArguments

Preprocess arguments of the simulate method.

progress_settings-class

Progress settings class.

Progress

Create progress settings.

protocol-class

Protocol class.

removeInitialConditions

Remove initial conditions.

reorderColumns

Reorder output columns.

retrieveParameterValue

Retrieve the parameter value (standardized) for the specified paramete...

rxode_engine-class

RxODE/rxode2 engine class.

sample

Sample generic object.

sampleCovariatesList

Sample covariates list.

sampleDistributionAsTibble

Sample a distribution and return a tibble.

sampleTimeVaryingCovariates

Sample time-varying covariates.

scatterPlot

Scatter plot (or X vs Y plot).

scenario-class

Scenario class.

Scenario

Create an scenario.

scenarios-class

Scenarios class.

Scenarios

Create a list of scenarios.

seconds

Convert seconds to hours.

setLabel

Set the label.

setSeed

Set the seed. The goal of this method is to centralize all calls to th...

setSubjects

Set the number of subjects.

Settings

Create advanced simulation settings.

setupPlanDefault

Setup default plan for the given simulation or hardware settings. This...

setupPlanSequential

Setup plan as sequential (i.e. no parallelisation).

shadedPlot

Shaded plot (or prediction interval plot).

simulate

Simulate function.

simulateDelegate

Simulation delegate (several replicates).

simulateDelegateCore

Simulation delegate core (single replicate).

simulateScenarios

Simulation scenarios.

simulation_engine-class

Simulation engine class.

simulation_progress-class

Simulation progress class.

simulation_settings-class

Simulation settings class.

SimulationProgress

Create a simulation progress object.

solver_settings-class

Solver settings class. See ?mrgsolve::update. See ?rxode2::rxSolve.

Solver

Create solver settings.

spaghettiPlot

Spaghetti plot.

splitDataset

Split dataset according to config.

standardiseTime

Standardise time to hours.

time_varying_covariate-class

Time-varying covariate class.

TimeVaryingCovariate

Create a time-varying covariate. This covariate will be implemented us...

toDatasetSummary

Convert dataset to dataset summary (internal method).

toExplicitDistribution

Convert user-given distribution to an explicit CAMPSIS distribution. P...

treatment_iov-class

Treatment IOV class.

treatment_iovs-class

Treatment IOV's class.

treatment-class

Treatment class.

undefined_distribution-class

Undefined distribution class. This type of object is automatically cre...

UniformDistribution

Create an uniform distribution.

uniteColumns

Unite the given column names.

VPC

Compute the VPC summary. Input data frame must contain the following c...

vpcPlot

VPC plot.

weeks

Convert weeks to hours.

years

Convert pharma years (1 year = 12*4 weeks) to hours.

A generic, easy-to-use and intuitive pharmacokinetic/pharmacodynamic (PK/PD) simulation platform based on R packages 'rxode2' and 'mrgsolve'. CAMPSIS provides an abstraction layer over the underlying processes of writing a PK/PD model, assembling a custom dataset and running a simulation. CAMPSIS has a strong dependency to the R package 'campsismod', which allows to read/write a model from/to files and adapt it further on the fly in the R environment. Package 'campsis' allows the user to assemble a dataset in an intuitive manner. Once the user’s dataset is ready, the package is in charge of preparing the simulation, calling 'rxode2' or 'mrgsolve' (at the user's choice) and returning the results, for the given model, dataset and desired simulation settings.

  • Maintainer: Nicolas Luyckx
  • License: GPL (>= 3)
  • Last published: 2024-08-30