Prepare next release

.github/workflows/R-CMD-check.yaml

@@ -58,7 +58,7 @@ jobs:
           restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-3-
 
       - name: Install system dependencies
-        if: runner.os == 'Linux'
+        if: runner.os == 'Linux (no, skip this!)'
         env:
           RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
         run: |

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.rabimo
 Title: R Implementation of Water Balance Model Abimo
-Version: 1.0.1
+Version: 1.0.1.9000
 Authors@R: c(
     person("Hauke", "Sonnenberg", , "hauke.sonnenberg@kompetenz-wasser.de", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9134-2871")),
@@ -15,17 +15,27 @@ URL: https://github.com/KWB-R/kwb.rabimo
 BugReports: https://github.com/KWB-R/kwb.rabimo/issues
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Suggests: 
-    covr
+    covr,
+    ggplot2,
+    kwb.rect,
+    plumber,
+    testthat (>= 3.0.0)
 Imports: 
     dplyr,
+    foreign,
     kwb.abimo,
     kwb.utils,
     magrittr,
-    methods,
     parallel,
+    rlang,
     xml2
 Remotes: 
-    github::kwb-r/kwb.abimo,
-    github::kwb-r/kwb.utils
+    github::kwb-r/kwb.abimo@dev,
+    github::kwb-r/kwb.rect,
+    github::kwb-r/kwb.utils@dev
+Config/testthat/edition: 3
+Depends: 
+    R (>= 3.5.0)
+LazyData: true

NAMESPACE

@@ -1,19 +1,29 @@
 # Generated by roxygen2: do not edit by hand
 
 export("%>%")
-export(BERLIN_TYPES_TO_USAGE_YIELD_IRRIGATION)
+export(BERLIN_TYPES_TO_LAND_TYPE_VEG_CLASS_IRRIGATION)
 export(abimo_config_to_config)
 export(actual_evaporation_waterbody_or_pervious)
-export(call_with_data)
+export(calculate_delta_w)
+export(data_to_natural)
+export(define_controls)
+export(distribute_measures)
+export(generate_rabimo_area)
+export(get_measure_stats)
 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(prepare_input_data)
+export(plot_block)
+export(plot_block_2)
+export(prepare_berlin_inputs)
+export(read_column_info)
 export(real_evapo_transpiration)
 export(run_rabimo)
+export(run_rabimo_with_measures)
+export(test_api)
+export(triangle_of_fractions)
 export(yearly_height_to_volume_flow)
 importFrom(dplyr,left_join)
 importFrom(kwb.utils,catAndRun)
@@ -25,20 +35,29 @@ importFrom(kwb.utils,getAttribute)
 importFrom(kwb.utils,inRange)
 importFrom(kwb.utils,moveColumnsToFront)
 importFrom(kwb.utils,multiColumnLookup)
+importFrom(kwb.utils,multiSubstitute)
+importFrom(kwb.utils,pasteColumns)
 importFrom(kwb.utils,printIf)
 importFrom(kwb.utils,removeColumns)
 importFrom(kwb.utils,removeElements)
 importFrom(kwb.utils,renameAndSelect)
 importFrom(kwb.utils,renameColumns)
 importFrom(kwb.utils,resetRowNames)
+importFrom(kwb.utils,right)
+importFrom(kwb.utils,safePath)
 importFrom(kwb.utils,safeRowBindAll)
 importFrom(kwb.utils,selectColumns)
 importFrom(kwb.utils,selectElements)
 importFrom(kwb.utils,stopFormatted)
 importFrom(kwb.utils,stringList)
+importFrom(kwb.utils,substSpecialChars)
+importFrom(kwb.utils,toLookupList)
 importFrom(magrittr,"%>%")
-importFrom(methods,formalArgs)
 importFrom(parallel,detectCores)
 importFrom(parallel,makeCluster)
 importFrom(parallel,parLapply)
 importFrom(parallel,stopCluster)
+importFrom(rlang,.data)
+importFrom(stats,approx)
+importFrom(stats,setNames)
+importFrom(utils,globalVariables)

R/abimo_config_to_config.R

@@ -1,100 +1,92 @@
 #' Convert Abimo Configuration to List
 #'
-#' @param abimo_config as returned by \code{kwb.abimo:::read_config}
-#' @return list with elements \code{"potential_evaporation"},
-#'   \code{"runoff_factors"}, \code{"bagrov_values"}, \code{"diverse"},
-#'   \code{"result_digits"}
+#' @param abimo_config as returned by \code{kwb.abimo::read_config}
+#' @param add_class_5 logical indicating whether or not to add fields for a
+#'   fifth surface class. The default is \code{FALSE}.
+#' @return list with elements
+#'   \code{"potential_evaporation"},
+#'   \code{"runoff_factors"},
+#'   \code{"bagrov_values"},
+#'   \code{"result_digits"},
+#'   \code{"precipitation_correction_factor"},
+#'   \code{"irrigation_to_zero"}
 #' @export
-abimo_config_to_config <- function(abimo_config)
+#' @examples
+#' str(kwb.rabimo::abimo_config_to_config(kwb.abimo::read_config()))
+abimo_config_to_config <- function(abimo_config, add_class_5 = FALSE)
 {
-  # abimo_config <- kwb.abimo:::read_config()
+  #abimo_config <- kwb.abimo::read_config()
   #`%>%` <- magrittr::`%>%`
+  #kwb.utils::assignPackageObjects("kwb.rabimo")
+
+  prefix <- "section_"
+  result <- abimo_config[startsWith(names(abimo_config), prefix)] %>%
+    set_names(remove_left(names(.), nchar(prefix))) %>%
+    lapply(function(x) {
+      filter_elements(x, "^item_") %>%
+        lapply(function(y) {
+          do.call(data.frame, as.list(xml2::xml_attrs(y)))
+        }) %>%
+        list_to_data_frame_with_keys("item", "item_(.*)")
+    })
+
+  epot_water <- "Gewaesserverdunstung"
+  epot_else <- "PotentielleVerdunstung"
+
+  extract_epot <- function(element, is_waterbody, renamings = NULL, ...) {
+    result %>%
+      select_elements(element) %>%
+      expand_district_ranges() %>%
+      lapply(as.integer) %>%
+      as.data.frame() %>%
+      rename_columns(renamings) %>%
+      {cbind.data.frame(is_waterbody = is_waterbody, ., ...)}
+  }
 
-  section_pattern <- "^section_"
-
-  result <- abimo_config %>%
-    filter_elements(section_pattern) %>%
-    lapply(get_all_item_data)
-
-  names(result) <- gsub(section_pattern, "", names(result))
-
-  element_water <- "Gewaesserverdunstung"
-  element_else <- "PotentielleVerdunstung"
-
-  all_columns_to_int <- function(x) as.data.frame(lapply(x, as.integer))
-
-  evap_water <- result %>%
-    select_elements(element_water) %>%
-    expand_district_ranges() %>%
-    all_columns_to_int() %>%
-    rename_columns(list(eg = "etp")) %>%
-    cbind(etps = 0, is_waterbody = TRUE)
-
-  evap_else <- result %>%
-    select_elements(element_else) %>%
-    expand_district_ranges() %>%
-    all_columns_to_int() %>%
-    cbind(is_waterbody = FALSE)
-
-  result[["potential_evaporation"]] <- rbind(evap_water, evap_else) %>%
-    move_columns_to_front("is_waterbody")
+  result[["potential_evaporation"]] <- rbind(
+    extract_epot(epot_water, TRUE, list(eg = "etp"), etps = 0),
+    extract_epot(epot_else, FALSE)
+  )
 
   convert_element <- function(config, from, to, convert = identity) {
     x <- select_elements(config, from)
-    config[[to]] <- stats::setNames(
-      convert(select_columns(x, "value")),
-      select_columns(x, "key")
-    )
+    value <- convert(select_columns(x, "value"))
+    key <- select_columns(x, "key")
+    config[[to]] <- set_names(value, key)
     remove_elements(config, from)
   }
 
-  result <- result %>%
-    remove_elements(c(
-      element_water,
-      element_else
-    )) %>%
-    convert_element(
-      from = "Infiltrationsfaktoren",
-      to = "runoff_factors",
-      convert = function(x) 1 - as.numeric(x)
-    ) %>%
-    convert_element(
-      from = "Bagrovwerte",
-      to = "bagrov_values",
-      convert = as.numeric
-    ) %>%
-    convert_element(
-      from = "Diverse",
-      to = "diverse"
-    ) %>%
-    convert_element(
-      from = "ErgebnisNachkommaStellen",
-      to = "result_digits",
-      convert = as.numeric
-    )
-
-  result[["precipitation_correction_factor"]] <- as.numeric(
-    select_elements(result, "diverse")[["NIEDKORRF"]]
-  )
+  complement <- function(x) 1 - as.numeric(x)
 
-  result
-}
-
-# get_all_item_data ------------------------------------------------------------
-get_all_item_data <- function(x)
-{
-  get_attribute_data <- function(x) {
-    values <- xml2::xml_attrs(x)
-    do.call(data.frame, as.list(values))
-  }
-
-  get_item_data <- function(x) {
-    list_to_data_frame_with_keys(x, "item", "item_(.*)")
+  result <- result %>%
+    remove_elements(c(epot_water, epot_else)) %>%
+    convert_element("Infiltrationsfaktoren", "runoff_factors", complement) %>%
+    convert_element("Bagrovwerte", "bagrov_values", as.numeric) %>%
+    convert_element("Diverse", "diverse") %>%
+    convert_element("ErgebnisNachkommaStellen", "result_digits", as.numeric)
+
+  # Convert types of "diverse" entries and shift them up to the main level
+  diverse <- "diverse"
+  x <- select_elements(result, diverse)
+  result[["precipitation_correction_factor"]] <- as.numeric(x[["NIEDKORRF"]])
+  result[["irrigation_to_zero"]] <- as.logical(x[["BERtoZero"]])
+  result <- remove_elements(result, diverse)
+
+  # Clean names for two sections
+  keys <- c("runoff_factors", "bagrov_values")
+  result[keys] <- lapply(result[keys], function(x) {
+    set_names(x, multi_substitute(names(x), list(
+      Dachflaechen = "roof",
+      Belaglsklasse = "surface"
+    )))
+  })
+
+  if (add_class_5) {
+    result$runoff_factors <- c(result$runoff_factors, surface5 = 0.48)
+    result$bagrov_values <- c(result$bagrov_values, surface5 = 0.25)
   }
 
-  filter_elements(x, "^item_") %>%
-    lapply(get_attribute_data) %>%
-    get_item_data()
+  result
 }
 
 # expand_district_ranges -------------------------------------------------------
@@ -110,9 +102,36 @@ expand_district_ranges <- function(
     remove_columns(c("item", range_column)) %>%
     move_columns_to_front(district_column)
 
-  stopifnot(
-    !anyDuplicated(select_columns(x, district_column))
-  )
+  stopifnot(!anyDuplicated(select_columns(x, district_column)))
 
   x
 }
+
+# expand_ranges_in_column ------------------------------------------------------
+expand_ranges_in_column <- function(x, range_column, index_column)
+{
+  # Split data frame into a list of rows
+  data_rows <- unname(split(x, seq_len(nrow(x))))
+
+  # Expand each row with a range string in column according to the ranges
+  do.call(rbind, unname(lapply(data_rows, function(data_row) {
+
+    range_string <- select_columns(data_row, range_column)
+
+    # Determine the indices that are described by the range string
+    indices <- if (is.na(range_string)) {
+      NA
+    } else {
+      index_string_to_integers(range_string)
+    }
+
+    # Repeat the current row for each of these indices
+    result <- data_row[rep.int(1L, length(indices)), ]
+
+    # Append a column with these indices
+    result[[index_column]] <- indices
+
+    # Return the data frame
+    result
+  })))
+}