RxODE (version 0.8.0-9)

rxTrans: Translate the model to C code if needed

Description

This function translates the model to C code, if needed

Usage

rxTrans(model, cFile = sprintf("%s.c", gsub("[.][^.]*$", "", model)),
  extraC = NULL, modelPrefix = "", md5 = "", modName = NULL,
  modVars = FALSE, calcSens = NULL, calcJac = NULL,
  collapseModel = FALSE, ...)

# S3 method for default rxTrans(model, cFile = sprintf("%s.c", gsub("[.][^.]*$", "", model)), extraC = NULL, modelPrefix = "", md5 = "", modName = NULL, modVars = FALSE, calcSens = NULL, calcJac = NULL, collapseModel = FALSE, ...)

# S3 method for character rxTrans(model, cFile = sprintf("%s.c", gsub("[.][^.]*$", "", model)), extraC = NULL, modelPrefix = "", md5 = "", modName = NULL, modVars = FALSE, calcSens = NULL, calcJac = NULL, collapseModel = FALSE, ...)

Arguments

model

This is the ODE model specification. It can be:

  • a string containing the set of ordinary differential equations (ODE) and other expressions defining the changes in the dynamic system.

  • a file name where the ODE system equation is contained

  • An ODE expression enclosed in {}

(see also the filename argument). For details, see the sections “Details” and “RxODE Syntax” below.

cFile

The C file where the code should be output

extraC

Extra c code to include in the model. This can be useful to specify functions in the model. These C functions should usually take double precision arguments, and return double precision values.

modelPrefix

Prefix of the model functions that will be compiled to make sure that multiple RxODE objects can coexist in the same R session.

md5

Is the md5 of the model before parsing, and is used to embed the md5 into DLL, and then provide for functions like rxModelVars.

modName

a string to be used as the model name. This string is used for naming various aspects of the computations, including generating C symbol names, dynamic libraries, etc. Therefore, it is necessary that modName consists of simple ASCII alphanumeric characters starting with a letter.

modVars

returns the model variables instead of the named vector of translated properties.

calcSens

boolean indicating if RxODE will calculate the sennsitivities according to the specified ODEs.

calcJac

boolean indicating if RxODE will calculate the Jacobain according to the specified ODEs.

collapseModel

boolean indicating if RxODE will remove all LHS variables when calculating sensitivities.

...

Ignored parameters.

Value

a named vector of translated model properties including what type of jacobian is specified, the C function prefixes, as well as the C functions names to be called through the compiled model.

See Also

RxODE, rxCompile.