Use "safety factor" to diminish max values

Author: hsonne

inst/scripts/plumber.R

@@ -3,11 +3,11 @@
 # /example_data ----------------------------------------------------------------
 
 #* Example data for Abimo (Berlin, 2019)
-#* @param n_records number of records (= input rows = "Blockteilflaechen").
-#* @param seed seed value for the random number generator used to randomly select rows
-#* @param output_only whether to return only the data frame with example data (true, the default) or a list with inputs and output (false).
-#* @post /example_data
-function(req, n_records = 3L, seed = as.integer(Sys.time()), output_only = TRUE)
+#* @param n_records:int number of records (= input rows = "Blockteilflaechen").
+#* @param seed seed:int value for the random number generator used to randomly select rows
+#* @param output_only:logical whether to return only the data frame with example data (true) or a list with inputs and output (false).
+#* @get /example_data
+function(n_records = 3L, seed = as.integer(Sys.time()), output_only = TRUE)
 {
   n_records <- as.integer(n_records)
   seed <- as.integer(seed)
@@ -38,28 +38,33 @@ function(req, n_records = 3L, seed = as.integer(Sys.time()), output_only = TRUE)
 # /get_measure_stats -----------------------------------------------------------
 
 #* Statistics (mean, max) on measures within selected blocks
-#* @param blocks_json Selected blocks
-#* @param reference_system "Reference system" (1:old, 2:new = percentages of total area)
+#* @param blocks:data.frame Selected blocks
+#* @param max_only:logical whether or not to return only the "max" (and not also the "mean") values
+#* @param reference_system:int "Reference system" (1:old, 2:new = percentages of total area)
+#* @param safety_factor:float Factor that the "max" values are multiplied with to make them a bit smaller
 #* @serializer unboxedJSON
 #* @post get_measure_stats
-function(req, blocks_json, reference_system = 2)
+function(blocks = data.frame(), max_only = TRUE, reference_system = 2L, safety_factor = 0.999)
 {
-  blocks <- jsonlite::fromJSON(blocks_json)
-  kwb.rabimo::get_measure_stats(blocks, reference_system)
+  stats <- kwb.rabimo::get_measure_stats(blocks, reference_system)
+
+  if (max_only) {
+    lapply(lapply(stats, `[[`, "max"), `*`, as.numeric(safety_factor))
+  } else {
+    stats
+  }
 }
 
 # /run_rabimo ------------------------------------------------------------------
 
 #' Run R-Abimo with data and config (optional)
-#* @param data_json input data as json string, as returned by /example_data in "output"
+#* @param data:data.frame input data as json string, as returned by /example_data in "output"
 #* @param measures_json Optional. Target values of measures, as json string, e.g. '{"green_roof":0.1, "unpaved":0.2, "to_swale":0.3}'
 #* @param config_json Optional. Configuration as json string, as returned by /default_config
 #* @serializer unboxedJSON
 #* @post /run_rabimo
-function(req, data_json, measures_json = "", config_json = "")
+function(data = data.frame(), measures_json = "", config_json = "")
 {
-  data <- jsonlite::fromJSON(data_json)
-
   # Convert json string to data frame and set all columns to expected types
   data <- kwb.rabimo:::check_or_convert_data_types(
     data = data,
@@ -93,6 +98,7 @@ function(req, data_json, measures_json = "", config_json = "")
 
   list(
     data = if (failed) NULL else output,
+    measures = measures,
     weighted_means = if (failed) NULL else {
       areas <- output$area
       cols <- 3:5