add_CustomSpace: Add a Custom Space to a PMLModels Object

Description

Adds a new model space, defined by custom PML code, to an existing collection of model spaces (a PMLModels object).

Usage

add_CustomSpace(Spaces, CustomCode, SpaceName = character())

Value

An updated PMLModels object (a named list) containing all the original spaces plus the newly added custom space.

Arguments

Spaces: A PMLModels object (a named list) representing the existing collection of model spaces to which the new custom space will be added. This can be an empty list or a previously created PMLModels object.
CustomCode: A character string containing the complete custom PML code (e.g., the content of a test(){...} block, potentially excluding the test(){ and closing } depending on usage context, although including them is safer for parsing). Multi-line strings are collapsed. Cannot be empty.
SpaceName: An optional character string specifying the name for this custom model space. This name will be used as the key for this model within the returned PMLModels list. If omitted or an empty string (""), a unique identifier will be created by concatenating the letter "l" with the number of characters in CustomCode. Providing a meaningful name is recommended for clarity, especially when working with multiple custom models. Ensure provided names are unique if creating multiple custom spaces intended to coexist.

Details

This function serves as a wrapper around create_CustomSpace(). It first calls create_CustomSpace using the provided CustomCode and SpaceName to parse the code and create a representation of the new custom space. The name of this new space is either the provided SpaceName or one automatically generated by create_CustomSpace if SpaceName was omitted or empty (e.g., "l<number>" based on code length).

Examples

Run this code

# Start with some built-in models
pk_models <- create_ModelPK(CompartmentsNumber = 1)

# Define custom code
custom_pml <- "test() {
  cfMicro(A1, Cl / V)
  dosepoint(A1)
  C = A1 / V
  error(CEps = 1)
  observe(CObs = C + CEps)
  stparm(V = tvV * exp(nV))
  stparm(Cl = tvCl * exp(nCl))
  fixef(tvV = c(, 1, ))
  fixef(tvCl = c(, 1, ))
  ranef(block(nV, nCl) = c(1, 0.001, 1))
}
"

# Add custom space with an explicit name
all_models <-
  add_CustomSpace(pk_models, custom_pml, SpaceName = "1cptOmegaBlock")
names(all_models)

# Add another custom space with auto-generated name
all_models_2 <- add_CustomSpace(all_models,
  "test() {
  cfMicro(A1, Cl / V)
  dosepoint(A1)
  C = A1 / V
  error(CEps = 1)
  observe(CObs = C + C ^ (0.5) * CEps)
  stparm(V = tvV * exp(nV))
  stparm(Cl = tvCl * exp(nCl))
  fixef(tvV = c(, 1, ))
  fixef(tvCl = c(, 1, ))
  ranef(block(nV, nCl) = c(1, 0.001, 1))
}
")
names(all_models_2) # Will include original names + "l"