Merge branch 'dev' of github.com:KWB-R/qsimVis into dev

Author: daniel-wicke

R/add_qsimVis_id.R

@@ -18,6 +18,10 @@
 #' * "section_name": The project specific ID of the whole river or a river
 #'  section. Can be multiple IDs per waterbody, separated by ",", however, must
 #'  be unique.
+#' @param id_source A string defining the part of the site name which is used
+#' to find the river name in the database. This must be the ID that is given in
+#' the "section_name" column of the translation table. Usually this
+#' is "river_name" but it can be changed to "section_name" instead.
 #'
 #' @details
 #' The Verknet data is available here: https://www.gdws.wsv.bund.de/DE/service/karten/03_VerkNet-BWaStr/VerkNet-BWaStr_node.html
@@ -28,7 +32,7 @@
 #' @export
 #'
 add_qsimVis_id <- function(
-    aggregated_data, translation_table
+    aggregated_data, translation_table, id_source = "river_name"
 ){
   separate_project_ids <- strsplit(x = translation_table$section_name, ",")
   project_ids <- unlist(separate_project_ids)
@@ -54,7 +58,7 @@ add_qsimVis_id <- function(
 
     section_rows <- grep(
       pattern = paste0("^", project_id, "$") ,
-      x = aggregated_data$section_name
+      x = aggregated_data[[id_source]]
     )
     aggregated_data$qsimVis_river[section_rows] <- qsimVis_id
     aggregated_data$qsimVis_source[section_rows] <- qsimVis_source

R/qsim_prepare.R

@@ -5,7 +5,13 @@
 #' time column and several parameter columns (one per site)
 #'
 #' @param qsim_output_file filename (including path) in which the output from
-#' Gsim is listed
+#' Qsim is listed. The format of the output file needs to be a ; - seperated
+#' csv. Columns must contain:
+#' * "ID": Character - project specific ID of the river
+#' * "Section": Character - project specific ID of the section (can be an empty column)
+#' * "Km": Numeric - kilometer of the simulated value
+#' * "Date": Character - Datetime of the simulated value (format "%d.%m.%Y %H:%M)
+#' * "Q": Numeric - Flow in m³/s (can be an empty column)
 #' @param parameter_name A String defining the column name of the parameter to
 #' be visualized. "VO2" is the default (Oxygen concentration).
 #'
@@ -36,7 +42,7 @@ QSIM_prepare <-function(
                              header = TRUE
                              )
 
-  df_in$site <- paste(df_in[[1]], df_in[[2]], df_in[[3]], sep = "_")
+  df_in$site <- paste(df_in[[1]], df_in[[2]], df_in[[3]], sep = "__")
   df_in$para <- df_in[[parameter_name]]
 
   if(!("Q" %in% colnames(df_in))){

R/site_info_qsim_ID.R

@@ -14,14 +14,8 @@
 #' @export
 #'
 site_info_from_qsimID<- function(qsim_id){
-  s1 <- strsplit(qsim_id, split = "_")[[1]]
-  if(length(s1) != 3L){
-    warning(qsim_id, " is not in the correct Qsim ID format.")
-  }
+  s1 <- strsplit(qsim_id, split = "__")[[1]]
   s2 <- strsplit(s1[2], "\\.")[[1]]
-  if(length(s2) != 2L){
-    warning(qsim_id, " is not in the correct Qsim ID format.")
-  }
   list("river_name" = s1[1],
        "section_id" = s2[1],
        "section_name" = s2[2],

inst/extdata/manually_added_rivers/Fredersdorfer Muehlenfliess.csv inst/extdata/manually_added_rivers/Fredersdorfer_Muehlenfliess.csv

@@ -0,0 +1,32 @@
+"ID";"verknet_BWaStrIdNr";"Bezeichnung";"section_name"
+"BSK";"5401";"Berlin-Spandauer (Schifffahrts)kanal";"BSK"
+"WHK";"5403";"Westhafenkanal";"WHK"
+"CVK";"5404";"Charlottenburger Verbindungskanal (zur Spree)";"CVK"
+"DaW";"5501";"Dahme-Wasserstraße";"DaW"
+"WdS";"5524";"Wernsdorfer Seenkette";"WdS"
+"HOW";"5801";"Havel-Oder-Wasserstraße";"HOW"
+"TgS";"5809";"Tegeler See";"TgS"
+"RüG";"6301";"Rüdersdorfer Gewässer";"RüG"
+"SOW";"6501";"Spree-Oder-Wasserstraße";"SOW"
+"LWK";"6504";"Landwehrkanal";"LWK"
+"RmS";"6510";"Rummelsburger See";"RmS"
+"MgS";"6513";"Müggelspree";"MgS"
+"GKr";"6527";"Große Krampe";"GKr"
+"GoK";"6528";"Gosener Kanal und Seddiner See";"GoK"
+"GoG";"6532";"Gosener Graben";"GoG"
+"TeK";"6601";"Teltowkanal";"TeK"
+"GrK";"6602";"Griebnitzkanal";"GrK"
+"BVK";"6604";"Britzer Verbindungskanal (zur Spree)";"BVK"
+"UHW";"6701";"Untere Havel-Wasserstraße (Spandau - Plaue)";"UHW"
+"GWS";"6707";"Großer Wannsee";"GWS"
+"PHv";"6712";"Potsdamer Havel";"PHv"
+"Neukoellner_Schifffahrtskanal";"NA";"Neuköllner Schifffahrts-Kanal";"NSK"
+"Baeke";"NA";"Bäke";"Bae"
+"SpK";"6507";"Spreekanal";"SpK,Spk"
+"Stoe";"NA";"???";"Stoe"
+"Marzahn_Hohenschoenhauser_Grenzgraben";"NA";"Marzahn Hohenschönhause Grenzgraben";"MHGG"
+"Tegeler_Fliess";"NA";"Tegeler_Fließ";"Tegeler_Fliess"
+"Erpe";"NA";"Erpe";"Erpe"
+"Nordgraben";"NA";"Nordgraben";"Nordgraben"
+"Panke";"NA";"Panke";"Panke"
+"Wuhle";"NA";"Wuhle";"Wuhle"

inst/extdata/manually_added_rivers/MHGG.csv inst/extdata/manually_added_rivers/Marzahn_Hohenschoenhauser_Grenzgraben.csv

@@ -6,15 +6,16 @@ ag_table <- readxl::read_xlsx(
 # translation between Qsim ID and verknet ID
 t_table <- read.table(
   file = system.file(package = "qsimVis",
-                     "extdata/scripts/impetus/river_id_table.csv"),
+                     "extdata/scripts/impetus/BelinWaterModel_id_table.csv"),
   header = TRUE,
   sep = ";")
 
 # der zweite Teil der Bezeichnung des Strangs (section) sollte in die Übersetzungstabelle eingehen
 # sonst wird zum Beispiel ein Teil des WHK nicht geplotted, weil er als BSK erkannt wird
 aggregated_data <- qsimVis::add_qsimVis_id(
   aggregated_data = ag_table,
-  translation_table = t_table
+  translation_table = t_table,
+  id_source = "river_name"
 )
 
 # hier sollte nur "section_name" und "km" ausgegeben werden
@@ -25,10 +26,10 @@ rivers <- qsimVis::load_rivers(
 )
 
 # prepare plot
-sixBreaks = c(0,0.05, 0.1, 0.2, 0.4, 0.7, 0.9)
+sixBreaks = c(0, 0.05, 0.1, 0.2, 0.4, 0.7,0.9)
 
 ####### Example: Difference between "interpolation" and "steps" ################
-example_river <- "Neukoellner Schifffahrtskanal"
+example_river <- "Neukoellner_Schifffahrtskanal"
 
 qsimVis::extend_riverTable(
   rivers = rivers,
@@ -54,7 +55,7 @@ rivers_ext <- lapply(
   aggregated_data = aggregated_data,
   varName = "adverse_dev",
   sixBreaks = sixBreaks,
-  NA_processing = "interpolation")
+  NA_processing = "steps")
 names(rivers_ext) <- names(rivers)
 
 # plot empty map
@@ -74,7 +75,7 @@ qsimVis::add_coloredRivers(
   aggregated_data = aggregated_data,
   sixBreaks = sixBreaks,
   dataType = "time",
-  LegendTitle = "Durchschnittlicher \nAbwassergehalt in %"
+  LegendTitle = "Durchschnittlicher \nAbwassergehalt"
 )