Nothing
hyd1d - Vignette
In hyd1d: 1d Water Level Interpolation along the Rivers Elbe and Rhine
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.align="center",
fig.width = 7,
fig.height = 4,
root.dir = "vignettes"
)
library(hyd1d)
library(stringr)
library(yaml)
library(desc)
# set english locale to produce english plot labels
Sys.setlocale(category = "LC_MESSAGES", locale = "en_US.utf8")
# Determine the output format of the document
outputFormat <- knitr::opts_knit$get("rmarkdown.pandoc.to")
if (outputFormat == "html") {
is_html <- TRUE
} else {
is_html <- FALSE
}
# Figure and Table Caption Numbering, for HTML do it manually
capTabNo <- 1
capFigNo <- 1
# Function to add the Table Number
capTab <- function(x){
if(outputFormat == 'html'){
x <- paste0("**Tab. ", capTabNo, "**: ", x)
capTabNo <<- capTabNo + 1
} else if (outputFormat == 'latex'){
y <- str_replace_all(x, '(^.*)(\\[.*\\])(\\(.*\\))(.*$)',
'\\1\\\\href{\\3}{\\2}\\4')
y <- gsub("{(", "{", y, fixed = TRUE, useBytes = TRUE)
y <- gsub("{[", "{", y, fixed = TRUE, useBytes = TRUE)
y <- gsub(")}", "}", y, fixed = TRUE, useBytes = TRUE)
y <- gsub("]}", "}", y, fixed = TRUE, useBytes = TRUE)
x <- gsub("_", "\\_", y, fixed = TRUE, useBytes = TRUE)
}
return(x)
}
# Function to add the Figure Number
capFig <- function(x){
if(outputFormat == 'html'){
x <- paste0("**Fig. ", capFigNo, "**: ", x)
capFigNo <<- capFigNo + 1
} else if (outputFormat == 'latex'){
y <- str_replace_all(x, '(^.*)(\\[.*\\])(\\(.*\\))(.*$)',
'\\1\\\\href{\\3}{\\2}\\4')
y <- gsub("{(", "{", y, fixed = TRUE, useBytes = TRUE)
y <- gsub("{[", "{", y, fixed = TRUE, useBytes = TRUE)
y <- gsub(")}", "}", y, fixed = TRUE, useBytes = TRUE)
y <- gsub("]}", "}", y, fixed = TRUE, useBytes = TRUE)
x <- gsub("_", "\\_", y, fixed = TRUE, useBytes = TRUE)
}
return(x)
}
href <- function(x, y) {
if (outputFormat == 'html') {
x <- paste0("[", x, "](", y, ")")
} else if (outputFormat == 'latex') {
x <- paste0("\\href{", y, "}{", x, "}")
}
return(x)
}
bf <- function(x) {
if (outputFormat == 'html') {
x <- paste0("**", x, "**")
} else if (outputFormat == 'latex') {
x <- paste0("\\textbf{", x, "}")
}
return(x)
}
# Function to simplify linking to references/rd
lrd <- function(x, y) {
# standard url
url <- "https://hyd1d.bafg.de"
# url from DESCRIPTION file
if (file.exists("DESCRIPTION")) {
url_desc <- description$new("DESCRIPTION")$get_urls()[1]
}
# url from pkgdown/_pkgdown.yml
pwd <- Sys.getenv("PWD")
if (pwd != "") {
if (file.exists(paste0(pwd, "/pkgdown/_pkgdown.yml"))) {
url_pkgdown <- yaml.load_file(
paste0(pwd, "/pkgdown/_pkgdown.yml"))$url
}
}
if (exists("url_desc")) {
url <- url_desc
if (exists("url_pkgdown")) {
url <- url_pkgdown
}
}
# outputformat latex
if (knitr::is_latex_output()) {
if (missing(y)) {
if (endsWith(x, "()")) {
x1 <- gsub("()", "", x, fixed = TRUE)
str <- paste0("[", x, "](", url, "/reference/", x1, ".html)")
} else {
str <- paste0("[", x, "](", url, "/reference/", x, ".html)")
}
} else {
str <- paste0("[", x, "](", url, "/reference/", y, ")")
}
return(str)
}
# outputformat html
if (missing(y)) {
if (endsWith(x, "()")) {
# x1 <- gsub("()", "", x, fixed = TRUE)
str <- paste0("`", x, "`")
} else {
str <- paste0("<code>[", x, "](", url, "/reference/", x, ".html)</",
"code>")
}
} else {
str <- paste0("<code>[", x, "](", url, "/reference/", y, ")</code>")
}
return(str)
}
Purpose
hyd1d is an R package that provides an S4-class and several functions to
compute 1-dimensional water levels along the German federal waterways Elbe and
Rhine.
Use
Installation
The package hyd1d is available from CRAN. To install it run:
install.packages("hyd1d")
To install the recent developmental version from Github execute the following
commands:
install.packages("devtools")
library(devtools)
devtools::install_github("bafg-bund/hyd1d")
Afterwards hyd1d can be loaded like every other R package with the following
command:
library(hyd1d)
S4-class WaterLevelDataFrame
All water level computations with hyd1d are based on the S4-class
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html"). To compute
water levels with one of the
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions,
a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html")
has to be initialized with the homonymous r lrd("WaterLevelDataFrame()")-function:
wldf <- WaterLevelDataFrame(river = "Elbe",
time = as.POSIXct("2016-12-21"),
station = seq(257, 262, 0.1))
The required information to initialize a
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") are
the function arguments river, time and at least one of the two possible
station arguments (station or station_int). With this information an object
of class r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") can be
created, which has the following structure:
str(wldf)
summary(wldf)
The actual water level information is stored in the S4-slot .Data, which is in
fact a data.frame with the columns station, station_int and w. The
columns station and station_int contain a stationing information, which
corresponds to the official stationing of the German Waterways and Shipping Administration
(Wasserstraßen- und Schifffahrtsverwaltung (WSV)). The stationing information is
duplicated to enable database joins with GIS data through the integer-type
column station_int. The column w contains the actual
water level in the height reference system DHHN92 (1992 German height reference
system), but is usually empty after initialization and gets filled
throught the application of one of the
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions.
For the application of
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions
information stored in the S4-slots river and where appropriate time is
essential. They enable a distinct localization of the stationing along the
rivers Elbe and Rhine and a determination of the time of water level
computation. The other slots of an object of class
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") are filled
during the water level computation and contain partial results needed to
visualize the results (gauging_station) or serve information purposes (
gauging_stations_missing, comment).
Computation of water levels
waterLevel
The most advanced function to interpolate
FLYS3
water levels [@bundesanstalt_fur_gewasserkunde_flys_2013; @bundesanstalt_fur_gewasserkunde_flys_2016] with local gauging
data is implemented in the r lrd("waterLevel()")-function. This function uses
package-internal gauging data from the dataset r lrd("df.gauging_data"), which
contains daily-averaged gauging data since 1960-01-01. Therefore
r lrd("waterLevel()") can be applied for the time period between 1960-01-01
and yesterday.
After the initialization of
a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") the
application is very simple:
wldf <- waterLevel(wldf)
summary(wldf)
And if you want to visualize the results using r lrd("plotShiny()") the additional
argument shiny = TRUE has to be used. Thereby the columns section,
weight_x and weight_y get created in the .Data-Slot, which are required
for visualization.
wldf <- waterLevel(wldf, shiny = TRUE)
summary(wldf)
xlim_min <- 257
xlim_max <- 263
{
plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max),
xlab = "river station (km)",
ylab = "elevation (m a.s.l. (DHHN92))")
legend("topright",
col = c("darkblue", "darkblue", "darkblue", "red", "black"),
pch = c(21, NA, NA, NA, NA),
pt.bg = c("darkblue", NA, NA, NA, NA),
pt.cex = c(1, NA, NA, NA, NA),
lty = c(0, 0, 1, 1, 1),
lwd = c(0, 0, 1, 0.6, 0.6),
legend = c("gauge height", "gauge weight", "waterLevel",
"upper FLYS w.l.", "lower FLYS w.l."),
text.col = c(1, "darkblue", 1, 1, 1),
cex = 0.7, bty = "n")
}
waterLevelPegelonline
The way how the r lrd("waterLevelPegelonline()")-function
computes a water level is equivalent to the r lrd("waterLevel()")-function.
Just the data source of the gauging data is different, since it does not use
package-internal data, but online data provided by
https://pegelonline.wsv.de/gast/start [@wsv_pegelonline_2018]. Because data
provided by PEGELONLINE are only
available for the past 30 days, the application of this function is limited to
recent time periods, but with a high temporal resolution.
# one hour ago
time <- as.POSIXct(Sys.time() - 3600)
# initialize a WaterLevelDataFrame
wldf <- WaterLevelDataFrame(river = "Elbe",
time = time,
station = seq(257, 262, 0.1))
# compute w
wldf <- waterLevelPegelonline(wldf, shiny = TRUE)
summary(wldf)
# and plot the results
{
plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max),
xlab = "river station (km)",
ylab = "elevation (m a.s.l. (DHHN92))")
legend("topright",
col = c("darkblue", "darkblue", "darkblue", "red", "black"),
pch = c(21, NA, NA, NA, NA),
pt.bg = c("darkblue", NA, NA, NA, NA),
pt.cex = c(1, NA, NA, NA, NA),
lty = c(0, 0, 1, 1, 1),
lwd = c(0, 0, 1, 0.6, 0.6),
legend = c("gauge height", "gauge weight", "waterLevel",
"upper FLYS w.l.", "lower FLYS w.l."),
text.col = c(1, "darkblue", 1, 1, 1),
cex = 0.7, bty = "n")
}
waterLevelFlood1 & waterLevelFlood2
To compare the newly developed functions r lrd("waterLevel()") and
r lrd("waterLevelPegelonline()") to existing computation methods,
the functions r lrd("waterLevelFlood1()") and r lrd("waterLevelFlood2()")
have been implemented. These functions compute water levels according to the
Flood1- and Flood2-methods of the modelling environment
INFORM
[@rosenzweig_inform_2011]. They either shift the reference water level MQ
vertically, so that it intersects with the gauge height at a selected reference
gauging station, or linearly interpolate water levels with neighboring gauging
stations.
wldf <- WaterLevelDataFrame(river = "Elbe",
time = as.POSIXct("2016-12-21"),
station = seq(257, 262, 0.1))
wldf1 <- waterLevelFlood1(wldf, "ROSSLAU", shiny = TRUE)
summary(wldf1)
wldf2 <- waterLevelFlood1(wldf, "DESSAU", shiny = TRUE)
summary(wldf2)
wldf3 <- waterLevelFlood2(wldf)
summary(wldf3)
df.gs2 <- getGaugingStations(wldf2)
{
plotShiny(wldf1, FALSE, FALSE, FALSE, xlim = c(xlim_min, xlim_max),
xlab = "river station (km)",
ylab = "elevation (m a.s.l. (DHHN92))")
lines(wldf2$station, wldf2$w, col = "darkblue", lty = 2)
lines(wldf3$station, wldf3$w, col = "red", lty = 2)
abline(v = df.gs2$km_qps, lty = 3, lwd = 0.5)
points(df.gs2$km_qps, df.gs2$wl, pch=21, col="darkblue", bg="darkblue")
hyd1d:::.boxed.labels(df.gs2$km_qps, 55.4, df.gs2$gauging_station,
bg="white", srt = 90, border = FALSE, xpad = 4,
ypad = 0.7, cex = 0.7)
legend("topright",
col = c("darkblue", "darkblue", "darkblue", "red"),
pch = c(21, NA, NA, NA),
pt.bg = c("darkblue", NA, NA, NA),
pt.cex = c(1, NA, NA, NA),
lty = c(0, 1, 2, 2),
lwd = c(0, 1, 1, 1),
legend = c("gauge height", "wldf1", "wldf2", "wldf3"),
cex = 0.7, bty = "n")
}
waterLevelFlys3InterpolateY
To compare the newly developed functions r lrd("waterLevel()") and
r lrd("waterLevelPegelonline", "waterLevel.html") to existing computation
methods of
FLYS3,
the function r lrd("waterLevelFlys3InterpolateY()") has been implemented. This
function computes a water level according to the method implemented in the
W-INFO-module of FLYS3.
This function determines the relative position of the gauge height at a
reference gauge to the two surrounding FLYS3
water levels and uses this weight for a longitudinal interpolation between both
water levels.
wldf <- waterLevelFlys3InterpolateY(wldf, "ROSSLAU", shiny = TRUE)
summary(wldf)
{
plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max),
xlab = "river station (km)",
ylab = "elevation (m a.s.l. (DHHN92))")
abline(v = df.gs2$km_qps, lty = 3, lwd = 0.5)
points(df.gs2$km_qps, df.gs2$wl, pch=21, col="darkblue", bg="darkblue")
hyd1d:::.boxed.labels(df.gs2$km_qps, 55.4, df.gs2$gauging_station,
bg="white", srt = 90, border = FALSE, xpad = 4,
ypad = 0.7, cex = 0.7)
legend("topright",
col = c("darkblue", "darkblue", "darkblue", "red", "black"),
pch = c(21, NA, NA, NA, NA),
pt.bg = c("darkblue", NA, NA, NA, NA),
pt.cex = c(1, NA, NA, NA, NA),
lty = c(0, 0, 1, 1, 1),
lwd = c(0, 0, 1, 0.6, 0.6),
legend = c("gauge height", "gauge weight", "waterLevel",
"upper FLYS w.l.", "lower FLYS w.l."),
text.col = c(1, "darkblue", 1, 1, 1),
cex = 0.7, bty = "n")
}
waterLevelFlys3...
All other waterLevelFlys3...()-functions (r lrd("waterLevelFlys3()"),
r lrd("waterLevelFlys3Seq()") and r lrd("waterLevelFlys3InterpolateX()"))
serve exclusively for the preparation and querying of stationary
FLYS3
water levels. They can be used to extract water levels from the dataset
r lrd("df.flys")
and interpolate the water levels linearly along the x-axis, but without
modifying the dataset contents. These functionalities are needed for all
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions
described in this vignette and are mentioned here for completeness.
Products
waterLevel
The r lrd("waterLevel()") function is the central function of the package
hyd1d. To apply it only three input parameters, that are needed to
initialize a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html"),
are required. That predestines this function to embed it into an interactive
Shiny Application:
\begin{center}
\url{https://shiny.bafg.de/waterlevel/}
\end{center}
``` {r link_waterlevel, eval = is_html, echo = FALSE, results = 'asis'}
cat('
https://shiny.bafg.de/waterlevel/
')
```r
knitr::include_graphics('screenshot_waterLevel.png')
waterLevelPegelonline
The same is true for the function r lrd("waterLevelPegelonline()", "waterLevel.html").
Since this function queries gauging data through the internet and not from
package-internal datasets, the resulting shiny application is well suited to
generate up-to-date water level information.
\begin{center}
\url{https://shiny.bafg.de/waterlevelpegelonline/}
\end{center}
``` {r link_waterlevelpegelonline, eval = is_html, echo = FALSE, results = 'asis'}
cat('
https://shiny.bafg.de/waterlevelpegelonline/
')
```r
knitr::include_graphics('screenshot_waterLevelPegelonline.png')
hydflood (flood extents and durations)
The R package hydflood enables the modelling of flood extents and durations
through an extrapolation of water levels computed along the river axis with
functions provided within R package hyd1d to cross section areas and GIS
operations comparing these water levels to digital elevation models. Daily flood
extents can be aggregated over longer time periods to flood durations
(e.g. days/year). More details to this method can be found on the corresponding
package documentation of hydflood:
\begin{center}
\url{https://hydflood.bafg.de}
\end{center}
{r link_hydflood, eval = is_html, echo = FALSE, results = 'asis'}
cat('<p style="text-align: center;"><a href="https://hydflood.bafg.de" target="_blank">https://hydflood.bafg.de</a></p>')
References
Try the hyd1d package in your browser
Any scripts or data that you put into this service are public.
hyd1d documentation built on April 3, 2025, 11:55 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.align="center", fig.width = 7, fig.height = 4, root.dir = "vignettes" )
library(hyd1d) library(stringr) library(yaml) library(desc) # set english locale to produce english plot labels Sys.setlocale(category = "LC_MESSAGES", locale = "en_US.utf8") # Determine the output format of the document outputFormat <- knitr::opts_knit$get("rmarkdown.pandoc.to") if (outputFormat == "html") { is_html <- TRUE } else { is_html <- FALSE } # Figure and Table Caption Numbering, for HTML do it manually capTabNo <- 1 capFigNo <- 1 # Function to add the Table Number capTab <- function(x){ if(outputFormat == 'html'){ x <- paste0("**Tab. ", capTabNo, "**: ", x) capTabNo <<- capTabNo + 1 } else if (outputFormat == 'latex'){ y <- str_replace_all(x, '(^.*)(\\[.*\\])(\\(.*\\))(.*$)', '\\1\\\\href{\\3}{\\2}\\4') y <- gsub("{(", "{", y, fixed = TRUE, useBytes = TRUE) y <- gsub("{[", "{", y, fixed = TRUE, useBytes = TRUE) y <- gsub(")}", "}", y, fixed = TRUE, useBytes = TRUE) y <- gsub("]}", "}", y, fixed = TRUE, useBytes = TRUE) x <- gsub("_", "\\_", y, fixed = TRUE, useBytes = TRUE) } return(x) } # Function to add the Figure Number capFig <- function(x){ if(outputFormat == 'html'){ x <- paste0("**Fig. ", capFigNo, "**: ", x) capFigNo <<- capFigNo + 1 } else if (outputFormat == 'latex'){ y <- str_replace_all(x, '(^.*)(\\[.*\\])(\\(.*\\))(.*$)', '\\1\\\\href{\\3}{\\2}\\4') y <- gsub("{(", "{", y, fixed = TRUE, useBytes = TRUE) y <- gsub("{[", "{", y, fixed = TRUE, useBytes = TRUE) y <- gsub(")}", "}", y, fixed = TRUE, useBytes = TRUE) y <- gsub("]}", "}", y, fixed = TRUE, useBytes = TRUE) x <- gsub("_", "\\_", y, fixed = TRUE, useBytes = TRUE) } return(x) } href <- function(x, y) { if (outputFormat == 'html') { x <- paste0("[", x, "](", y, ")") } else if (outputFormat == 'latex') { x <- paste0("\\href{", y, "}{", x, "}") } return(x) } bf <- function(x) { if (outputFormat == 'html') { x <- paste0("**", x, "**") } else if (outputFormat == 'latex') { x <- paste0("\\textbf{", x, "}") } return(x) } # Function to simplify linking to references/rd lrd <- function(x, y) { # standard url url <- "https://hyd1d.bafg.de" # url from DESCRIPTION file if (file.exists("DESCRIPTION")) { url_desc <- description$new("DESCRIPTION")$get_urls()[1] } # url from pkgdown/_pkgdown.yml pwd <- Sys.getenv("PWD") if (pwd != "") { if (file.exists(paste0(pwd, "/pkgdown/_pkgdown.yml"))) { url_pkgdown <- yaml.load_file( paste0(pwd, "/pkgdown/_pkgdown.yml"))$url } } if (exists("url_desc")) { url <- url_desc if (exists("url_pkgdown")) { url <- url_pkgdown } } # outputformat latex if (knitr::is_latex_output()) { if (missing(y)) { if (endsWith(x, "()")) { x1 <- gsub("()", "", x, fixed = TRUE) str <- paste0("[", x, "](", url, "/reference/", x1, ".html)") } else { str <- paste0("[", x, "](", url, "/reference/", x, ".html)") } } else { str <- paste0("[", x, "](", url, "/reference/", y, ")") } return(str) } # outputformat html if (missing(y)) { if (endsWith(x, "()")) { # x1 <- gsub("()", "", x, fixed = TRUE) str <- paste0("`", x, "`") } else { str <- paste0("<code>[", x, "](", url, "/reference/", x, ".html)</", "code>") } } else { str <- paste0("<code>[", x, "](", url, "/reference/", y, ")</code>") } return(str) }
Purpose
hyd1d is an R package that provides an S4-class and several functions to compute 1-dimensional water levels along the German federal waterways Elbe and Rhine.
Use
Installation
The package hyd1d is available from CRAN. To install it run:
install.packages("hyd1d")
To install the recent developmental version from Github execute the following commands:
install.packages("devtools") library(devtools) devtools::install_github("bafg-bund/hyd1d")
Afterwards hyd1d can be loaded like every other R package with the following command:
library(hyd1d)
S4-class WaterLevelDataFrame
All water level computations with hyd1d are based on the S4-class
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html"). To compute
water levels with one of the
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions,
a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html")
has to be initialized with the homonymous r lrd("WaterLevelDataFrame()")-function:
wldf <- WaterLevelDataFrame(river = "Elbe", time = as.POSIXct("2016-12-21"), station = seq(257, 262, 0.1))
The required information to initialize a
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") are
the function arguments river, time and at least one of the two possible
station arguments (station or station_int). With this information an object
of class r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") can be
created, which has the following structure:
str(wldf) summary(wldf)
The actual water level information is stored in the S4-slot .Data, which is in
fact a data.frame with the columns station, station_int and w. The
columns station and station_int contain a stationing information, which
corresponds to the official stationing of the German Waterways and Shipping Administration
(Wasserstraßen- und Schifffahrtsverwaltung (WSV)). The stationing information is
duplicated to enable database joins with GIS data through the integer-type
column station_int. The column w contains the actual
water level in the height reference system DHHN92 (1992 German height reference
system), but is usually empty after initialization and gets filled
throught the application of one of the
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions.
For the application of
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions
information stored in the S4-slots river and where appropriate time is
essential. They enable a distinct localization of the stationing along the
rivers Elbe and Rhine and a determination of the time of water level
computation. The other slots of an object of class
r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") are filled
during the water level computation and contain partial results needed to
visualize the results (gauging_station) or serve information purposes (
gauging_stations_missing, comment).
Computation of water levels
waterLevel
The most advanced function to interpolate
FLYS3
water levels [@bundesanstalt_fur_gewasserkunde_flys_2013; @bundesanstalt_fur_gewasserkunde_flys_2016] with local gauging
data is implemented in the r lrd("waterLevel()")-function. This function uses
package-internal gauging data from the dataset r lrd("df.gauging_data"), which
contains daily-averaged gauging data since 1960-01-01. Therefore
r lrd("waterLevel()") can be applied for the time period between 1960-01-01
and yesterday.
After the initialization of
a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html") the
application is very simple:
wldf <- waterLevel(wldf) summary(wldf)
And if you want to visualize the results using r lrd("plotShiny()") the additional
argument shiny = TRUE has to be used. Thereby the columns section,
weight_x and weight_y get created in the .Data-Slot, which are required
for visualization.
wldf <- waterLevel(wldf, shiny = TRUE) summary(wldf) xlim_min <- 257 xlim_max <- 263 { plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max), xlab = "river station (km)", ylab = "elevation (m a.s.l. (DHHN92))") legend("topright", col = c("darkblue", "darkblue", "darkblue", "red", "black"), pch = c(21, NA, NA, NA, NA), pt.bg = c("darkblue", NA, NA, NA, NA), pt.cex = c(1, NA, NA, NA, NA), lty = c(0, 0, 1, 1, 1), lwd = c(0, 0, 1, 0.6, 0.6), legend = c("gauge height", "gauge weight", "waterLevel", "upper FLYS w.l.", "lower FLYS w.l."), text.col = c(1, "darkblue", 1, 1, 1), cex = 0.7, bty = "n") }
waterLevelPegelonline
The way how the r lrd("waterLevelPegelonline()")-function
computes a water level is equivalent to the r lrd("waterLevel()")-function.
Just the data source of the gauging data is different, since it does not use
package-internal data, but online data provided by
https://pegelonline.wsv.de/gast/start [@wsv_pegelonline_2018]. Because data
provided by PEGELONLINE are only
available for the past 30 days, the application of this function is limited to
recent time periods, but with a high temporal resolution.
# one hour ago time <- as.POSIXct(Sys.time() - 3600) # initialize a WaterLevelDataFrame wldf <- WaterLevelDataFrame(river = "Elbe", time = time, station = seq(257, 262, 0.1)) # compute w wldf <- waterLevelPegelonline(wldf, shiny = TRUE) summary(wldf) # and plot the results { plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max), xlab = "river station (km)", ylab = "elevation (m a.s.l. (DHHN92))") legend("topright", col = c("darkblue", "darkblue", "darkblue", "red", "black"), pch = c(21, NA, NA, NA, NA), pt.bg = c("darkblue", NA, NA, NA, NA), pt.cex = c(1, NA, NA, NA, NA), lty = c(0, 0, 1, 1, 1), lwd = c(0, 0, 1, 0.6, 0.6), legend = c("gauge height", "gauge weight", "waterLevel", "upper FLYS w.l.", "lower FLYS w.l."), text.col = c(1, "darkblue", 1, 1, 1), cex = 0.7, bty = "n") }
waterLevelFlood1 & waterLevelFlood2
To compare the newly developed functions r lrd("waterLevel()") and
r lrd("waterLevelPegelonline()") to existing computation methods,
the functions r lrd("waterLevelFlood1()") and r lrd("waterLevelFlood2()")
have been implemented. These functions compute water levels according to the
Flood1- and Flood2-methods of the modelling environment
INFORM
[@rosenzweig_inform_2011]. They either shift the reference water level MQ
vertically, so that it intersects with the gauge height at a selected reference
gauging station, or linearly interpolate water levels with neighboring gauging
stations.
wldf <- WaterLevelDataFrame(river = "Elbe", time = as.POSIXct("2016-12-21"), station = seq(257, 262, 0.1)) wldf1 <- waterLevelFlood1(wldf, "ROSSLAU", shiny = TRUE) summary(wldf1) wldf2 <- waterLevelFlood1(wldf, "DESSAU", shiny = TRUE) summary(wldf2) wldf3 <- waterLevelFlood2(wldf) summary(wldf3)
df.gs2 <- getGaugingStations(wldf2) { plotShiny(wldf1, FALSE, FALSE, FALSE, xlim = c(xlim_min, xlim_max), xlab = "river station (km)", ylab = "elevation (m a.s.l. (DHHN92))") lines(wldf2$station, wldf2$w, col = "darkblue", lty = 2) lines(wldf3$station, wldf3$w, col = "red", lty = 2) abline(v = df.gs2$km_qps, lty = 3, lwd = 0.5) points(df.gs2$km_qps, df.gs2$wl, pch=21, col="darkblue", bg="darkblue") hyd1d:::.boxed.labels(df.gs2$km_qps, 55.4, df.gs2$gauging_station, bg="white", srt = 90, border = FALSE, xpad = 4, ypad = 0.7, cex = 0.7) legend("topright", col = c("darkblue", "darkblue", "darkblue", "red"), pch = c(21, NA, NA, NA), pt.bg = c("darkblue", NA, NA, NA), pt.cex = c(1, NA, NA, NA), lty = c(0, 1, 2, 2), lwd = c(0, 1, 1, 1), legend = c("gauge height", "wldf1", "wldf2", "wldf3"), cex = 0.7, bty = "n") }
waterLevelFlys3InterpolateY
To compare the newly developed functions r lrd("waterLevel()") and
r lrd("waterLevelPegelonline", "waterLevel.html") to existing computation
methods of
FLYS3,
the function r lrd("waterLevelFlys3InterpolateY()") has been implemented. This
function computes a water level according to the method implemented in the
W-INFO-module of FLYS3.
This function determines the relative position of the gauge height at a
reference gauge to the two surrounding FLYS3
water levels and uses this weight for a longitudinal interpolation between both
water levels.
wldf <- waterLevelFlys3InterpolateY(wldf, "ROSSLAU", shiny = TRUE) summary(wldf)
{
plotShiny(wldf, TRUE, TRUE, TRUE, xlim = c(xlim_min, xlim_max),
xlab = "river station (km)",
ylab = "elevation (m a.s.l. (DHHN92))")
abline(v = df.gs2$km_qps, lty = 3, lwd = 0.5)
points(df.gs2$km_qps, df.gs2$wl, pch=21, col="darkblue", bg="darkblue")
hyd1d:::.boxed.labels(df.gs2$km_qps, 55.4, df.gs2$gauging_station,
bg="white", srt = 90, border = FALSE, xpad = 4,
ypad = 0.7, cex = 0.7)
legend("topright",
col = c("darkblue", "darkblue", "darkblue", "red", "black"),
pch = c(21, NA, NA, NA, NA),
pt.bg = c("darkblue", NA, NA, NA, NA),
pt.cex = c(1, NA, NA, NA, NA),
lty = c(0, 0, 1, 1, 1),
lwd = c(0, 0, 1, 0.6, 0.6),
legend = c("gauge height", "gauge weight", "waterLevel",
"upper FLYS w.l.", "lower FLYS w.l."),
text.col = c(1, "darkblue", 1, 1, 1),
cex = 0.7, bty = "n")
}
waterLevelFlys3...
All other waterLevelFlys3...()-functions (r lrd("waterLevelFlys3()"),
r lrd("waterLevelFlys3Seq()") and r lrd("waterLevelFlys3InterpolateX()"))
serve exclusively for the preparation and querying of stationary
FLYS3
water levels. They can be used to extract water levels from the dataset
r lrd("df.flys")
and interpolate the water levels linearly along the x-axis, but without
modifying the dataset contents. These functionalities are needed for all
r lrd("waterLevel...()", "index.html#section-waterlevel-functions")-functions
described in this vignette and are mentioned here for completeness.
Products
waterLevel
The r lrd("waterLevel()") function is the central function of the package
hyd1d. To apply it only three input parameters, that are needed to
initialize a r lrd("WaterLevelDataFrame", "WaterLevelDataFrame-class.html"),
are required. That predestines this function to embed it into an interactive
Shiny Application:
\begin{center} \url{https://shiny.bafg.de/waterlevel/} \end{center}
``` {r link_waterlevel, eval = is_html, echo = FALSE, results = 'asis'} cat('
https://shiny.bafg.de/waterlevel/
')```r
knitr::include_graphics('screenshot_waterLevel.png')
waterLevelPegelonline
The same is true for the function r lrd("waterLevelPegelonline()", "waterLevel.html").
Since this function queries gauging data through the internet and not from
package-internal datasets, the resulting shiny application is well suited to
generate up-to-date water level information.
\begin{center} \url{https://shiny.bafg.de/waterlevelpegelonline/} \end{center}
``` {r link_waterlevelpegelonline, eval = is_html, echo = FALSE, results = 'asis'} cat('
https://shiny.bafg.de/waterlevelpegelonline/
')```r
knitr::include_graphics('screenshot_waterLevelPegelonline.png')
hydflood (flood extents and durations)
The R package hydflood enables the modelling of flood extents and durations through an extrapolation of water levels computed along the river axis with functions provided within R package hyd1d to cross section areas and GIS operations comparing these water levels to digital elevation models. Daily flood extents can be aggregated over longer time periods to flood durations (e.g. days/year). More details to this method can be found on the corresponding package documentation of hydflood:
\begin{center} \url{https://hydflood.bafg.de} \end{center}
{r link_hydflood, eval = is_html, echo = FALSE, results = 'asis'}
cat('<p style="text-align: center;"><a href="https://hydflood.bafg.de" target="_blank">https://hydflood.bafg.de</a></p>')
References
Try the hyd1d package in your browser
Any scripts or data that you put into this service are public.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.