getParameter: Retrieve a single parameter by path in the given container

In Open-Systems-Pharmacology/OSPSuite-R: R package to manipulate OSPSuite Models

Retrieve a single parameter by path in the given container

Description

Retrieve a single parameter by path in the given container

Usage

getParameter(path, container, stopIfNotFound = TRUE)

Arguments

path	A string representing the path relative to the container
container	A Container or Simulation used to find the parameters
stopIfNotFound	Boolean. If TRUE (default) and no parameter exist for the given path, an error is thrown. If FALSE, NULL is returned.

Value

The Parameter with the given path. If the parameter for the path does not exist, an error is thrown if stopIfNotFound is TRUE (default), otherwise NULL

See Also

loadSimulation(), getContainer() and getAllContainersMatching() to retrieve objects of type Container or Simulation

Examples

simPath <- system.file("extdata", "simple.pkml", package = "ospsuite")
sim <- loadSimulation(simPath)
param <- getParameter("Organism|Liver|Volume", sim)

Open-Systems-Pharmacology/OSPSuite-R documentation built on Feb. 14, 2025, 4:48 p.m.