Dev

R/rabimo_inputs_2020.R

@@ -47,17 +47,44 @@
 #'   \item{`block_type`}{Block type identifier of the form "usage-type-id_block-type-id_usage-type-description_block-type-description" (character)}
 #' }
 #'
-#' Note 1: The sum of surface class fractions `srf1_pvd`, `srf2_pvd`, `srf3_pvd`, `srf4_pvd`, `srf5_pvd` should be 1.0 within each block area.
+#' Note 1: The sum of surface class fractions `srf1_pvd`, `srf2_pvd`, `srf3_pvd`, `srf4_pvd`, `srf5_pvd` should be 1.0 within each block area. For the meaning of the five different surface classes in Berlin, see the table in the Details section below.
 #'
 #' Note 2: The fields with suffix "_r" are all zero because rows are modelled as their own blocks. In an earlier version of the dataset, roads were modelled as parts of the block area.
 #'
 #' @format ## `rabimo_inputs_2020$config`
 #' A list with 5 named elements:
 #' \describe{
-#'   \item{`runoff_factors`}{vector of num with names `roof`, `surface1`, `surface2`, `surface3`, `surface4`, `surface5`}
-#'   \item{`bagrov_values`}{vector of num with names `roof`, `green_roof`, `surface1`, `surface2`, `surface3`, `surface4`, `surface5`}
-#'   \item{`result_digits`}{vector of num with names `R`, `ROW`, `RI`, `RVOL`, `ROWVOL`, `RIVOL`, `FLAECHE`, `VERDUNSTUNG`}
-#'   \item{`irrigation_to_zero`}{not used!}
-#'   \item{`swale`}{vector of num with names `swale_evaporation_factor`}
+#'   \item{`runoff_factors`}{Runoff factors for roofs and five different surface 
+#'   types, given as a vector of numeric with element names `roof`, `surface1`, 
+#'   `surface2`, `surface3`, `surface4`, `surface5`. A runoff factor determines 
+#'   the proportion of precipitation that, after subtraction of 
+#'   evapotranspiration, becomes surface runoff from a paved area. The higher 
+#'   the factor, the less permeable is the surface. See the table in the Details section below.}
+#'   \item{`bagrov_values`}{Bagrov values to calculate evapotranspiration from 
+#'   paved surfaces, given as a vector of numeric with element names `roof`, 
+#'   `green_roof`, `surface1`, `surface2`, `surface3`, `surface4`, `surface5`.
+#'   The higher the Bagrov value, the more evapotranspiration is generated by 
+#'   the model, see the table in the Details section below. For a description of the evapotranspiration model and for a 
+#'   figure that shows the influence of the Bagrov values (n) on the 
+#'   evapotranspiration (in German), see \url{https://www.berlin.de/umweltatlas/wasser/wasserhaushalt/2001/methode/}}
+#'   \item{`result_digits`}{relict of the original ABIMO model, not used in R-Abimo!}
+#'   \item{`irrigation_to_zero`}{relict of the original ABIMO model, not used in R-Abimo!}
+#'   \item{`swale`}{Model parameter(s) related to the 'swale' measure, given as a 
+#'   vector of numeric with currently one value, named 
+#'   `swale_evaporation_factor`. The swale evaporation factor determines which 
+#'   fraction of the water going into a swale becomes evapotranspiration (the 
+#'   rest becomes infiltration).}
 #' }
+#' @details
+#' See the following table for the meaning of the surface classes and their Bagrov values and runoff factors used for Berlin.
+#' |**Surface Class**|**Surface Type**                                                                                                      |**Bagrov Value**|**Runoff Factor**|
+#' |:------------:|:------------------------------------------------------------------------------------------------------------------------|------------:|-------------:|
+#' |-             |Roof surfaces                                                                                                            |         0.05|          1.00|
+#' |-             |Extensive vegetated roofs                                                                                                |         0.65|          1.00|
+#' |1             |Asphalt, concrete, paving with joint sealing or concrete base, synthetic surfaces                                        |         0.11|          0.90|
+#' |2             |Artificial stone and slab coverings (side length > 8 cm), concrete interlocking pavers, clinker, medium and large pavers |         0.11|          0.70|
+#' |3             |Small and mosaic pavers (side length < 8 cm)                                                                             |         0.25|          0.40|
+#' |4             |Grass pavers, bound gravel surfaces, gravel lawns                                                                        |         0.40|          0.10|
+#' |5             |Unknown type (average parameters)                                                                                        |         0.25|          0.48|
+#' @md
 "rabimo_inputs_2020"

R/rabimo_inputs_2025.R

@@ -43,7 +43,7 @@
 #'   \item{`Shape`}{List structure containing geometry information on the different block areas. This column is optional. If provided, it will be appended to the model output so that model results can be plotted in the form of maps.}
 #' }
 #' 
-#' Note 1: The sum of surface class fractions `srf1_pvd`, `srf2_pvd`, `srf3_pvd`, `srf4_pvd`, `srf5_pvd` should be 1.0 within each block area.
+#' Note 1: The sum of surface class fractions `srf1_pvd`, `srf2_pvd`, `srf3_pvd`, `srf4_pvd`, `srf5_pvd` should be 1.0 within each block area. For the meaning of the five different surface classes in Berlin, see the table in the Details section below.
 #' 
 #' @format ## `rabimo_inputs_2025$config`
 #' A list with 3 named elements:
@@ -53,12 +53,12 @@
 #'   `surface2`, `surface3`, `surface4`, `surface5`. A runoff factor determines 
 #'   the proportion of precipitation that, after subtraction of 
 #'   evapotranspiration, becomes surface runoff from a paved area. The higher 
-#'   the factor, the less permeable is the surface.}
+#'   the factor, the less permeable is the surface. See the table in the Details section below.}
 #'   \item{bagrov_values}{Bagrov values to calculate evapotranspiration from 
 #'   paved surfaces, given as a vector of numeric with element names `roof`, 
 #'   `green_roof`, `surface1`, `surface2`, `surface3`, `surface4`, `surface5`.
 #'   The higher the Bagrov value, the more evapotranspiration is generated by 
-#'   the model. For a description of the evapotranspiration model and for a 
+#'   the model, see the table in the Details section below. For a description of the evapotranspiration model and for a 
 #'   figure that shows the influence of the Bagrov values (n) on the 
 #'   evapotranspiration (in German), see \url{https://www.berlin.de/umweltatlas/wasser/wasserhaushalt/2001/methode/}}
 #'   \item{swale}{Model parameter(s) related to the 'swale' measure, given as a 
@@ -69,5 +69,16 @@
 #' }
 #' @source <https://www.berlin.de/umweltatlas/en/general/contact/>
 #' @source <https://gdi.berlin.de/services/wfs/ua_gruendaecher_2020?REQUEST=GetCapabilities&SERVICE=wfs>
-#'
+#' @details
+#' See the following table for the meaning of the surface classes and their Bagrov values and runoff factors used for Berlin.
+#' |**Surface Class**|**Surface Type**                                                                                                      |**Bagrov Value**|**Runoff Factor**|
+#' |:------------:|:------------------------------------------------------------------------------------------------------------------------|------------:|-------------:|
+#' |-             |Roof surfaces                                                                                                            |         0.05|          1.00|
+#' |-             |Extensive vegetated roofs                                                                                                |         0.65|          1.00|
+#' |1             |Asphalt, concrete, paving with joint sealing or concrete base, synthetic surfaces                                        |         0.11|          0.90|
+#' |2             |Artificial stone and slab coverings (side length > 8 cm), concrete interlocking pavers, clinker, medium and large pavers |         0.11|          0.70|
+#' |3             |Small and mosaic pavers (side length < 8 cm)                                                                             |         0.25|          0.40|
+#' |4             |Grass pavers, bound gravel surfaces, gravel lawns                                                                        |         0.40|          0.10|
+#' |5             |Unknown type (average parameters)                                                                                        |         0.25|          0.48|
+#' @md
 "rabimo_inputs_2025"