Skip to contents

Translate the model to C code if needed

Source: R/rxode2.R
rxTrans.Rd

This function translates the model to C code, if needed

Usage

rxTrans(
  model,
  modelPrefix = "",
  md5 = "",
  modName = NULL,
  modVars = FALSE,
  ...
)

# Default S3 method
rxTrans(
  model,
  modelPrefix = "",
  md5 = "",
  modName = NULL,
  modVars = FALSE,
  ...
)

# S3 method for class 'character'
rxTrans(
  model,
  modelPrefix = "",
  md5 = "",
  modName = NULL,
  modVars = FALSE,
  eventSensKey = .rxEventSensCacheKey,
  ...
)

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 rxode2 Syntax below.

modelPrefix

Prefix of the model functions that will be compiled to make sure that multiple rxode2 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.

...

Ignored parameters.

eventSensKey

event ("jump") sensitivity mode key folded into the parsed md5 cache key so the same model text translated in different modes (e.g. "fd" vs "jump") compiles to distinct DLLs instead of colliding on a cached translation. Defaults to the session global .rxEventSensCacheKey (set by rxode2() before parsing); an empty string leaves the md5 unchanged so the legacy "fd" path keeps existing caches valid. It is a formal argument (rather than read from the global in the body) because rxTrans.character is memoised and memoise keys on default-valued formals, so the cache distinguishes the modes.

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

rxode2(), rxCompile().

Author

Matthew L.Fidler