Fixes #541 extend set parameter value by path (#543)

Open-Systems-Pharmacology · Jul 1, 2021 · 1b9bc04 · 1b9bc04
1 parent d8d32bb
commit 1b9bc04
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 11 deletions.
diff --git a/R/utilities-parameter.R b/R/utilities-parameter.R
@@ -111,6 +111,9 @@ setParameterValues <- function(parameters, values) {
 #' of numeric values, if the value of more than one parameter should be changed. Must have the same
 #' length as 'parameterPaths'
 #' @param simulation Simulation uses to retrieve parameter instances from given paths.
+#' @param stopIfNotFound Boolean. If \code{TRUE} (default) and no parameter exists for the given path,
+#' an error is thrown. If \code{FALSE}, a warning is shown to the user
+#'
 #' @examples
 #'
 #' simPath <- system.file("extdata", "simple.pkml", package = "ospsuite")
@@ -119,9 +122,12 @@ setParameterValues <- function(parameters, values) {
 #'
 #' setParameterValuesByPath(c("Organism|Liver|Volume", "Organism|Volume"), c(2, 3), sim)
 #' @export
-setParameterValuesByPath <- function(parameterPaths, values, simulation) {
+setParameterValuesByPath <- function(parameterPaths, values, simulation, stopIfNotFound = TRUE) {
   setQuantityValuesByPath(
-    quantityPaths = parameterPaths, values = values, simulation = simulation
+    quantityPaths = parameterPaths,
+    values = values,
+    simulation = simulation,
+    stopIfNotFound = stopIfNotFound
   )
 }
 

diff --git a/R/utilities-quantity.R b/R/utilities-quantity.R
@@ -103,6 +103,9 @@ setQuantityValues <- function(quantities, values) {
 #' of numeric values, if the value of more than one quantity should be changed. Must have the same
 #' length as 'quantityPaths'
 #' @param simulation Simulation uses to retrieve quantity instances from given paths.
+#' @param stopIfNotFound Boolean. If \code{TRUE} (default) and no qyantuty exists for the given path,
+#' an error is thrown. If \code{FALSE}, a warning is shown to the user
+
 #' @examples
 #'
 #' simPath <- system.file("extdata", "simple.pkml", package = "ospsuite")
@@ -111,7 +114,7 @@ setQuantityValues <- function(quantities, values) {
 #'
 #' setParameterValuesByPath(list("Organism|Liver|Volume", "Organism|Liver|A"), c(2, 3), sim)
 #' @export
-setQuantityValuesByPath <- function(quantityPaths, values, simulation) {
+setQuantityValuesByPath <- function(quantityPaths, values, simulation, stopIfNotFound = TRUE) {
   validateIsString(quantityPaths)
   validateIsNumeric(values)
   validateIsSameLength(quantityPaths, values)
@@ -120,8 +123,11 @@ setQuantityValuesByPath <- function(quantityPaths, values, simulation) {
   task <- getContainerTask()
   for (i in seq_along(quantityPaths)) {
     rClr::clrCall(
-      task, "SetValueByPath", simulation$ref,
-      enc2utf8(quantityPaths[[i]]), values[[i]]
+      task, "SetValueByPath",
+      simulation$ref,
+      enc2utf8(quantityPaths[[i]]),
+      values[[i]],
+      stopIfNotFound
     )
   }
 }

diff --git a/inst/lib/OSPSuite.Assets.dll b/inst/lib/OSPSuite.Assets.dll
diff --git a/inst/lib/OSPSuite.Core.dll b/inst/lib/OSPSuite.Core.dll
diff --git a/inst/lib/OSPSuite.Infrastructure.Autofac.dll b/inst/lib/OSPSuite.Infrastructure.Autofac.dll
diff --git a/inst/lib/OSPSuite.Infrastructure.Import.dll b/inst/lib/OSPSuite.Infrastructure.Import.dll
diff --git a/inst/lib/OSPSuite.Infrastructure.dll b/inst/lib/OSPSuite.Infrastructure.dll
diff --git a/inst/lib/OSPSuite.R.dll b/inst/lib/OSPSuite.R.dll
diff --git a/packages.config b/packages.config
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="OSPSuite.Assets" version="10.0.227"/>
-  <package id="OSPSuite.Core" version="10.0.227"/>
-  <package id="OSPSuite.Infrastructure" version="10.0.227"/>
-  <package id="OSPSuite.Infrastructure.Import" version="10.0.227"/>
-  <package id="OSPSuite.Infrastructure.Autofac" version="10.0.227"/>
-  <package id="OSPSuite.R" version="10.0.227"/>
+  <package id="OSPSuite.Assets" version="10.0.263"/>
+  <package id="OSPSuite.Core" version="10.0.263"/>
+  <package id="OSPSuite.Infrastructure" version="10.0.263"/>
+  <package id="OSPSuite.Infrastructure.Import" version="10.0.263"/>
+  <package id="OSPSuite.Infrastructure.Autofac" version="10.0.263"/>
+  <package id="OSPSuite.R" version="10.0.263"/>
   <package id="OSPSuite.Serializer" version="3.0.0.1"/>
   <package id="OSPSuite.Utility" version="4.0.0.4"/>
   <package id="LumenWorksCsvReader" version="4.0.0"/>

diff --git a/tests/testthat/test-utilities-quantity.R b/tests/testthat/test-utilities-quantity.R
@@ -73,3 +73,11 @@ test_that("It throws an exception when setting values for a quantity that does n
   parameterPath <- "Organism|Liver|NOPE|Volume"
   expect_that(setQuantityValuesByPath(parameterPath, 100, sim), throws_error())
 })
+
+test_that("It does not throw an exception when setting values for a quantity that does not exist and the stopIfnotFound flag is set to false", {
+  sim <- loadTestSimulation("S1", loadFromCache = TRUE)
+  parameterPath <- "Organism|Liver|NOPE|Volume"
+  setQuantityValuesByPath(parameterPath, 100, sim, FALSE)
+  expect_false(is.null(sim))
+})
+