Function reference • hyd1d

S4 class WaterLevelDataFrame and methods

Class definition and functions to initialize or modify a WaterLevelDataFrame

WaterLevelDataFrame-class: S4 class for 1d water level data

WaterLevelDataFrame(): Initialize a WaterLevelDataFrame

getGaugingStations(): Extract a WaterLevelDataFrame's slot gauging_stations

getGaugingStationsMissing(): Extract a WaterLevelDataFrame's slot gauging_stations_missing

getRiver(): Extract a WaterLevelDataFrame's slot river

getTime(): Extract a WaterLevelDataFrame's slot time

`setGaugingStations<-`(): Set a WaterLevelDataFrame's slot gauging_stations

`setGaugingStationsMissing<-`(): Set a WaterLevelDataFrame's slot gauging_stations_missing

`setRiver<-`(): Set a WaterLevelDataFrame's slot river

`setTime<-`(): Set a WaterLevelDataFrame's slot time

Utility functions

Functions to handle, modify, im- and export WaterLevelDataFrame’s

as.data.frame(<WaterLevelDataFrame>): Coerce a WaterLevelDataFrame to a data.frame

`names<-`(<WaterLevelDataFrame>,<character>): Set names of a WaterLevelDataFrame

plotShiny(): Plot a WaterLevelDataFrame in Shiny

rbind(<WaterLevelDataFrame>): Combine WaterLevelDataFrames by Rows

subset(<WaterLevelDataFrame>): Subsetting WaterLevelDataFrames

summary(<WaterLevelDataFrame>): WaterLevelDataFrame summary

`[`(<WaterLevelDataFrame>) `[<-`(<WaterLevelDataFrame>,<ANY>,<ANY>,<data.frame>): Extract or replace parts of a WaterLevelDataFrame

Datasets

Datasets included in hyd1d and a function to update df.gauging_data

df.flys: Stationary water levels from the FLYS 3-database

df.flys_sections: Reference gauging stations according to FLYS3

df.gauging_data: Gauging data for all WSV-run gauging stations along Elbe and Rhine

df.gauging_station_data: Gauging station data for all WSV-run gauging stations along Elbe and Rhine

updateGaugingData(): Update local copy of df.gauging data

W functions

Functions to obtain gauging data

getGaugingDataW(): Get W from internal dataset df.gauging_data for the specified gauging station and time

getPegelonlineW(): Get W from pegelonline.wsv.de for the specified gauging station and time

waterLevel functions

Functions to compute 1-dimensional water levels

waterLevel() waterLevelPegelonline(): Compute a 1d water level dataset

waterLevelFlood1(): Compute 1d water level data from the FLYS3 water level MQ and a gauging station according to the INFORM 3-method Flood1 (Flut1)

waterLevelFlood2(): Compute 1d water level data through linear interpolation with neighboring gauging stations according to the INFORM 3-method Flood2 (Flut2)

waterLevelFlys3() waterLevelFlys3Seq(): Obtain 1d water level data from the FLYS3 database

waterLevelFlys3InterpolateX(): Interpolate FLYS3 water levels for given stations

waterLevelFlys3InterpolateY(): Compute a 1d water level dataset based on the FLYS3 algorythms