Fix simulation id validation (#138)

* extract simulation ids assuming up to two levels of piParameters depth

* ensure simulation ids are identical

* update snapshots due to new error bar caps size in ospsuite::DefaultPlotConfiguration

* improve error message for missing simulation IDs

* Add tests for multi-path ID verification

* run styler:::style_active_pkg()

R/ParameterIdentification.R

@@ -263,7 +263,7 @@ ParameterIdentification <- R6::R6Class(
         costControl$scaling <- private$.outputMappings[[idx]]$scaling
         ospsuite.utils::validateIsOption(
           options = costControl,
-          validOptions =  ObjectiveFunctionSpecs
+          validOptions = ObjectiveFunctionSpecs
         )
         costSummary <- calculateCostMetrics(
           df = obsVsPredDf,

R/messages.R

@@ -32,9 +32,14 @@ messages$hessianEstimation <- function() {
   "Post-hoc estimation of Hessian matrix."
 }
 
-messages$errorSimulationIdMissing <- function(id) {
-  paste0(
-    "Mismatch or missing ID detected: ", id,
-    ". Ensure each Simulation ID matches with corresponding PIParameter and OutputMapping IDs."
-  )
+messages$errorSimulationIdMissing <- function(simulationIds, piParamIds, outputMappingIds) {
+  message <- capture.output(cat(
+    "Mismatch or missing ID detected.\n",
+    "Ensure each Simulation ID matches with corresponding PIParameter and OutputMapping IDs.\n",
+    "Simulation IDs: ", paste(simulationIds, collapse = ", "), "\n",
+    "PIParameter IDs: ", paste(piParamIds, collapse = ", "), "\n",
+    "OutputMapping IDs: ", paste(outputMappingIds, collapse = ", ")
+  ))
+
+  return(paste(message, collapse = "\n"))
 }

R/utilities-simulation.R

@@ -31,19 +31,34 @@
 #' the mismatch or absence of IDs.
 #' @keywords internal
 .validateSimulationIds <- function(simulationIds, piParameters, outputMappings) {
-  # Extract unique IDs from piParameters
-  piParamIds <- lapply(piParameters, function(param) .getSimulationContainer(param$parameters[[1]])$id)
+  # Extract unique IDs from piParameters assuming up to two levels of list depth
+  piParamIds <- lapply(piParameters, function(param) {
+    if (is.list(param$parameters)) {
+      return(lapply(param$parameters, function(sub_param) {
+        .getSimulationContainer(sub_param)$id
+      }))
+    } else {
+      return(.getSimulationContainer(param$parameters[[1]])$id)
+    }
+  })
   piParamIds <- unique(unlist(piParamIds))
 
   # Extract unique IDs from outputMappings
-  outputMappingIds <- lapply(outputMappings, function(mapping) .getSimulationContainer(mapping$quantity)$id)
+  outputMappingIds <- lapply(outputMappings, function(mapping) {
+    .getSimulationContainer(mapping$quantity)$id
+  })
   outputMappingIds <- unique(unlist(outputMappingIds))
 
-  # Validate that each simulationId is present in both piParamIds and outputMappingIds
-  for (id in simulationIds) {
-    if (!(id %in% piParamIds && id %in% outputMappingIds)) {
-      stop(messages$errorSimulationIdMissing(id))
-    }
+  # sort IDs before comparison
+  simulationIds <- sort(unique(unlist(simulationIds)))
+  piParamIds <- sort(piParamIds)
+  outputMappingIds <- sort(outputMappingIds)
+
+  # Validate that simulationId is identical with piParamIds and outputMappingIds
+  if (!identical(simulationIds, piParamIds) || !identical(simulationIds, outputMappingIds)) {
+    stop(messages$errorSimulationIdMissing(
+      simulationIds, piParamIds, outputMappingIds
+    ), call. = TRUE)
   }
 
   return()