Clean code and/or update documentation

Author: ma-z-am

R/add_logo.R

@@ -73,10 +73,6 @@ add_logo <- function(
   y_logo_inch_range <- x_logo_inch_range * logo_y_ratio
   y_logo_value_range <- y_logo_inch_range * y_values_per_inch
 
-  # x_logo_value_share <- x_logo_value_range / x_total_value_range
-  # y_logo_value_share <- x_logo_value_share * logo_y_scale / device_y_scale
-  # y_logo_value_range <- y_logo_value_share  * y_total_value_range
-
   if(position %in% c("bottomleft", "bottom", "bottomright")){
     ybottom <-  par("usr")[3] + y_plot_value_range / 10 * indent
     ytop <- ybottom + y_logo_value_range

R/plot_empty_map.R

@@ -6,17 +6,17 @@
 #' @param rivers List of data frames containing a river stretch (longitude and
 #' latitude) and values to be plotted. Created by functions [load_rivers()] and
 #' [extend_riverTable()]
+#' @param plot_map If TRUE a toner map is used as background
 #'
-#' @param plot_toner If TRUE a toner map is used as background
 #' @importFrom grDevices png dev.off dev.new
-#'
 #' @importFrom graphics par
 #' @import ggmap
 #' @export
 #'
 plot_empty_map <- function(
-    bbox = NULL, rivers = NULL, plot_toner = FALSE
+    bbox = NULL, rivers = NULL, plot_map = FALSE
 ){
+  nTypes(reset = TRUE)
   if(is.null(bbox)){
     if(is.null(rivers)){
       stop("One of 'bbox' or 'rivers' must be passed to the function.")
@@ -45,7 +45,7 @@ plot_empty_map <- function(
        xlab = "", ylab = "",
        xlim = xlim, ylim = ylim)
 
-  if(plot_toner){
+  if(plot_map){
     relWidth <- diff(par("plt")[c(1,2)])
     relHeight <- diff(par("plt")[c(3,4)])
     add_left <- par("plt")[1] / relWidth * par("cxy")[1]
@@ -57,12 +57,9 @@ plot_empty_map <- function(
               top = ylim[2] + add_top , bottom = ylim[1] - add_bottom)
     dev.new(noRStudioGD = TRUE, height = 6, width = 6 * width_factor,
             units = "in")
-    t_map <- ggmap::get_stamenmap(bbox,maptype = "toner", zoom = 12)
+    t_map <- ggmap::get_stadiamap(bbox, maptype = "stamen_toner", zoom = 12)
     ggmap::ggmap(ggmap = t_map, extent = "device")
 
-    # rect(xleft = xlim[2], xright = xlim[2] + add_right,
-    #      ybottom = ylim[1] - add_bottom, ytop = ylim[2] + add_top,
-    #      col = "white", xpd = TRUE)
   }
 }
 

R/qsim_prepare.R

@@ -14,6 +14,7 @@
 #' @param flow_column_name,section_column_name String defining the column names.
 #' If NULL, the columns will be filled by NA values (flow column) or empty
 #' chracaters (section column)
+#' @param dec The decimal separator. If not "," (default) then usually ".".
 #'
 #' @details
 #' The flow column needs to be in m³/s
@@ -40,13 +41,14 @@ QSIM_prepare <-function(
     id_column_name = "ID",
     km_column_name = "km",
     flow_column_name = "Q",
-    section_column_name = NULL
+    section_column_name = NULL,
+    dec = ","
 ){
 
   df_in <- data.table::fread(
     file = qsim_output_file,
     sep = ";",
-    dec = ",",
+    dec = dec,
     header = TRUE,
     colClasses = list(
       character = c(date_column_name, id_column_name)