Retrieve a single quantity by path in the given container
Source:R/utilities-quantity.R
getQuantity.Rd
Retrieve a single quantity by path in the given container
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 quantity exists for the given path, an error is thrown. IfFALSE
,NULL
is returned.
Value
The Quantity
with the given path. If the quantity 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)
quantity <- getQuantity("Organism|Liver|Volume", sim)