Merge pull request #9 from KWB-R/dev

First release

Author: hsonne

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.rabimo
 Title: R Implementation of Water Balance Model Abimo
-Version: 0.0.0.9000
+Version: 1.0.0
 Authors@R: c(
     person("Hauke", "Sonnenberg", , "hauke.sonnenberg@kompetenz-wasser.de", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9134-2871")),

NAMESPACE

@@ -3,18 +3,18 @@
 export("%>%")
 export(BERLIN_TYPES_TO_USAGE_YIELD_IRRIGATION)
 export(abimo_config_to_config)
-export(actualEvaporationWaterbodyOrPervious)
+export(actual_evaporation_waterbody_or_pervious)
 export(call_with_data)
-export(getPotentialEvaporation)
-export(getPrecipitation)
-export(getSoilProperties)
-export(getUsageTuple)
+export(get_potential_evaporation)
+export(get_precipitation)
+export(get_soil_properties)
+export(get_usage_tuple)
 export(index_string_to_integers)
 export(list_to_data_frame_with_keys)
-export(prepareInputData)
-export(realEvapoTranspiration)
+export(prepare_input_data)
+export(real_evapo_transpiration)
 export(run_rabimo)
-export(yearlyHeightToVolumeFlow)
+export(yearly_height_to_volume_flow)
 importFrom(dplyr,left_join)
 importFrom(kwb.utils,catAndRun)
 importFrom(kwb.utils,catIf)

NEWS.md

@@ -1,7 +1,14 @@
+# kwb.rabimo 1.0.0 (2023-11-09)
+
+First release of kwb.rabimo. This version tries to simulate exactly what
+Abimo 3.3.0 (https://github.com/KWB-R/abimo/releases/tag/v3.3.0) does.
+When being applied to the Berlin data (kwb.abimo::abimo_input_2019) there
+are remaining maximum differences between intermediate variables calculated
+by Abimo and kwb.rabimo, respectively, between about -6% and + 2%. They are
+most probably the result of differences in the precision of fractional numbers
+and rounding behaviour in C++ and R, respectively.
+
 # kwb.rabimo 0.0.0.9000
 
 * Added a `NEWS.md` file to track changes to the package.
-
 * see https://style.tidyverse.org/news.html for writing a good `NEWS.md`
-
-

R/abimo_config_to_config.R

@@ -1,9 +1,9 @@
 #' Convert Abimo Configuration to List
 #'
 #' @param abimo_config as returned by \code{kwb.abimo:::read_config}
-#' @return list with elements \code{"potentialEvaporation"},
-#'   \code{"runoffFactors"}, \code{"bagrovValues"}, \code{"diverse"},
-#'   \code{"resultDigits"}
+#' @return list with elements \code{"potential_evaporation"},
+#'   \code{"runoff_factors"}, \code{"bagrov_values"}, \code{"diverse"},
+#'   \code{"result_digits"}
 #' @export
 abimo_config_to_config <- function(abimo_config)
 {
@@ -28,16 +28,16 @@ abimo_config_to_config <- function(abimo_config)
     expand_district_ranges() %>%
     all_columns_to_int() %>%
     rename_columns(list(eg = "etp")) %>%
-    cbind(etps = -1L, isWaterbody = TRUE)
+    cbind(etps = 0, is_waterbody = TRUE)
 
   evap_else <- result %>%
     select_elements(element_else) %>%
     expand_district_ranges() %>%
     all_columns_to_int() %>%
-    cbind(isWaterbody = FALSE)
+    cbind(is_waterbody = FALSE)
 
-  result[["potentialEvaporation"]] <- rbind(evap_water, evap_else) %>%
-    move_columns_to_front("isWaterbody")
+  result[["potential_evaporation"]] <- rbind(evap_water, evap_else) %>%
+    move_columns_to_front("is_waterbody")
 
   convert_element <- function(config, from, to, convert = identity) {
     x <- select_elements(config, from)
@@ -48,19 +48,19 @@ abimo_config_to_config <- function(abimo_config)
     remove_elements(config, from)
   }
 
-  result %>%
+  result <- result %>%
     remove_elements(c(
       element_water,
       element_else
     )) %>%
     convert_element(
       from = "Infiltrationsfaktoren",
-      to = "runoffFactors",
+      to = "runoff_factors",
       convert = function(x) 1 - as.numeric(x)
     ) %>%
     convert_element(
       from = "Bagrovwerte",
-      to = "bagrovValues",
+      to = "bagrov_values",
       convert = as.numeric
     ) %>%
     convert_element(
@@ -69,9 +69,15 @@ abimo_config_to_config <- function(abimo_config)
     ) %>%
     convert_element(
       from = "ErgebnisNachkommaStellen",
-      to = "resultDigits",
+      to = "result_digits",
       convert = as.numeric
     )
+
+  result[["precipitation_correction_factor"]] <- as.numeric(
+    select_elements(result, "diverse")[["NIEDKORRF"]]
+  )
+
+  result
 }
 
 # get_all_item_data ------------------------------------------------------------