Learn R Programming

⚠️There's a newer version (1.1.5) of this package.Take me there.

RxODE (version 1.0.4)

Facilities for Simulating from ODE-Based Models

Description

Facilities for running simulations from ordinary differential equation ('ODE') models, such as pharmacometrics and other compartmental models. A compilation manager translates the ODE model into C, compiles it, and dynamically loads the object code into R for improved computational efficiency. An event table object facilitates the specification of complex dosing regimens (optional) and sampling schedules. NB: The use of this package requires both C and Fortran compilers, for details on their use with R please see Section 6.3, Appendix A, and Appendix D in the "R Administration and Installation" manual. Also the code is mostly released under GPL. The 'VODE' and 'LSODA' are in the public domain. The information is available in the inst/COPYRIGHTS.

Copy Link

Version

Install

install.packages('RxODE')

Monthly Downloads

121

Version

1.0.4

License

GPL (>= 3)

Maintainer

Wenping Wang

Last Published

February 24th, 2021

Functions in RxODE (1.0.4)

.s3register

Register a method for a suggested dependency
etExpand

Expand additional doses
genShinyApp.template

Generate an example (template) of a dosing regimen shiny app
forderForceBase

Force using base order for RxODE radix sorting
.rxFinalizePred

Finalize RxODE pred based on symengine saved info
gammap

Gammap: normalized lower incomplete gamma function
cvPost

Sample a covariance Matrix from the Posterior Inverse Wishart distribution.
.rxGenEBE

Generate pieces for EBE only problem
et

Event Table Function
getRxThreads

Get/Set the number of threads that RxODE uses
.rxGenHdEta

Generate the d(err)/d(eta) values for FO related methods
rinvchisq

Scaled Inverse Chi Squared distribution
.rxGenFunState

Get the state information for the current model
.rxGenFocei

Generate pieces for FOCEi inner problem
rxSEinner

Setup Pred function based on RxODE object.
etRbind

Combining event tables
.setWarnIdSort

Turn on/off warnings for ID sorting.
rxAllowUnload

Allow unloading of dlls
invWR1d

One correlation sample from the Inverse Wishart distribution
eventTable

Create an event table object
etRep

Repeat an RxODE event table
findLhs

Find the assignments in R expression
.rxGenEtaS

Generate the ETA sensitivities for FO related methods
.rxWithSink

With one sink, then release
rxAddReturn

Add a return statment to a function.
rxIsLoaded

Determine if the DLL associated with the RxODE object is loaded
rxParams

Parameters specified by the model
reexports

Objects exported from other packages
.rxGenFoce

Generate FOCE without interaction
gammaq

Gammaq: normalized upper incomplete gamma function
is.rxEt

Check to see if this is an rxEt object.
gammaqInv

gammaqInv and gammaqInva: Inverses of normalized gammaq function
etSeq

Sequence of event tables
.rxGenPred

Generate Augmented pred/err RxODE model
rxSetupIni

Setup the initial conditions.
rxCat

Use cat when RxODE.verbose is TRUE
guide_none

Empty Guide
rxchisq

Simulate chi-squared variable from threefry generator
.rxRmIni

Remove INIs
rxIndLinState

Set the preferred factoring by state
rxEvid

EVID formatting for tibble and other places.
rxSymInvCholN

Return the dimension of the built-in derivatives/inverses
rxGetLin

Get the linear compartment model true function
rxChain

rxChain Chain or add item to solved system of equations
rxExpandGrid

Faster expand.grid
rxMd5

Return the md5 of an RxODE object or file
etTrans

Event translation for RxODE
rxGetModel

Get model properties without compiling it.
rLKJ1

One correlation sample from the LKJ distribution
rxReload

Reload RxODE DLL
logit

logit and inverse logit (expit) functions
rxCreateCache

This will create the cache directory for RxODE to save between sessions
is.rxSolve

Check to see if this is an rxSolve object.
rxTheme

rxTheme is the RxODE theme for plots
lowergamma

lowergamma: upper incomplete gamma function
rxWinSetup

Setup Windows components for RxODE
rxD

Add to RxODE's derivative tables
rxDelete

Delete the DLL for the model
rxS

Load a model into a symengine environment
rxPrune

Prune branches (ie if/else) from RxODE
rxexp

Simulate exponential variable from threefry generator
rxCompile

Compile a model if needed
rxInits

Initial Values and State values for a RxODE object
rxLock

Lock/unlocking of RxODE dll file
rxRateDur

Creates a rxRateDur object
rxAssignPtr

Assign pointer based on model variables
rxLhs

Left handed Variables
rxSupportedFuns

Get list of supported functions
rxInv

Invert matrix using RcppArmadillo.
rxCondition

Current Condition for RxODE object
rxSymInvCholCreate

Creates an object for calculating Omega/Omega^-1 and derivatives
rxParsePk

Parse PK function for inclusion in RxODE
rxSetProgressBar

Set timing for progress bar
rxSumProdModel

Recast model in terms of sum/prod
.rxRmPrint

Remove print statements
print.RxODE

Print information about the RxODE object.
rxParsePred

Prepare Pred function for inclusion in RxODE
rxSetSum

Defunct setting of sum
rxSetSilentErr

Silence some of RxODE's C/C++ messages
rxf

Simulate F variable from threefry generator
rxbeta

Simulate beta variable from threefry generator
probit

probit and inverse probit functions
gammapInv

gammapInv and gammapInva: Inverses of normalized gammap function
gammapDer

gammapDer: derivative of gammap
rxbinom

Simulate Binomial variable from threefry generator
.rxWithWd

Temporarily set options then restore them while running code
rxunif

Simulate uniform variable from threefry generator
rxDerived

Calculate derived parameters for the 1-, 2-, and 3- compartment linear models.
rxHtml

Format rxSolve and related objects as html.
phi

Cumulative distribution of standard normal
+.rxSolve

Update Solved object with '+'
print.rxDll

Print rxDll object
rxgeom

Simulate geometric variable from threefry generator
rxShiny

Use Shiny to help develop an RxODE model
rxC

Return the C file associated with the RxODE object
rxBlockZeros

Creates a logical matrix for block matrixes.
rxIsCurrent

Checks if the RxODE object was built with the current build
rxcauchy

Simulate Cauchy variable from threefry generator
rxnorm

Simulate random normal variable from threefry/vandercorput generator
rxDynLoad

Load RxODE object
rxpois

Simulate random Poisson variable from threefry generator
rxDfdy

Jacobian and parameter derivatives
rxodeTest

Wrap a test in RxODE
rxNorm

Get the normalized model
rxDll

Return the DLL associated with the RxODE object
rxSetupScale

Setup the initial conditions.
rxt

Simulate student t variable from threefry generator
rxIndLinStrategy

This sets the inductive linearization strategy for matrix building
rxParseErr

Prepare Error function for inclusion in RxODE
rxSyncOptions

Sync options with RxODE variables
rxStack

Stack a solved object for things like ggplot
stat_amt

Dosing/Amt geom/stat
rxState

State variables
rxPp

Simulate a from a Poisson process
rxTempDir

Get the RxODE temporary directory
.rxWithOptions

Temporarily set options then restore them while running code
.rxWinRtoolsPath

Setup Rtools path
rxPkg

Creates a package from compiled RxODE models
stat_cens

Censoring geom/stat
rxVersion

Version and repository for this dparser package.
rxDynUnload

Unload RxODE object
rxSplitPlusQ

This function splits a function based on + or - terms
rxIs

Check the type of an object using Rcpp
rxGetRxODE

Get RxODE model from object
rxRandNV

Create a random "normal" matrix using vandercorput generator
rxOptExpr

Optimize RxODE for computer evaluation
rxUnloadAll

Unloads all RxODE compiled DLLs
rxProgress

RxODE progress bar functions
print.rxCoef

Print the rxCoef object
summary.RxODE

Print expanded information about the RxODE object.
rxClean

Cleanup anonymous DLLs by unloading them
rxChain2

Second command in chaining commands
rxToSE

RxODE to symengine environment
rxTrans

Translate the model to C code if needed
rxSolveFree

Free the C solving/parsing information.
rxFun

Add user function to RxODE
rxForget

Clear memoise cache for RxODE
rxgamma

Simulate gamma variable from threefry generator
rxExpandIfElse

Expand if/else clauses into mutiple different types of lines.
rxweibull

Simulate Weibull variable from threefry generator
rxRmvn

Simulate from a (truncated) multivariate normal
summary.rxDll

Summary of rxDll object
rxReq

Require namespace, otherwise throw error.
rxGenSaem

Generate pred-only SAEM RxODE model
rxPhysicalDrives

Returns a list of physical drives that have been or currently are mounted to the computer.
rxModelVars

All model variables for a RxODE object
rxModels_

Get the rxModels information
rxSolve

Solving & Simulation of a ODE/solved system (and solving options) equation
rxSetProd

Defunct setting of product
rxSetIni0

Set Initial conditions to time zero instead of the first observed/dosed time
rxSimThetaOmega

Simulate Parameters from a Theta/Omega specification
rxSuppressMsg

Respect suppress messages
rxUse

Use model object in your package
tibble

type_sum function for units
uppergamma

uppergamma: upper incomplete gamma function
rxSymInvChol

Get Omega^-1 and derivatives
rxValidate

Validate RxODE This allows easy validation/qualification of nlmixr by running the testing suite on your system.
.clearPipe

Clear/Set pipeline
.rxFinalizeInner

Finalize inner RxODE based on symengine saved info
add.sampling

Add sampling to eventTable
as_tibble.rxEt

Convert to tbl
as.data.table.rxEt

Convert an event table to a data.table
coef.RxODE

Return the RxODE coefficients
as.et

Coerce object to data.frame
RxODE

Create an ODE-based model specification
add.dosing

Add dosing to eventTable