read_bed_limits_elev: Read Bed Limit Elevations

Description Usage Arguments Details Value Examples

View source: R/xs.r

Description

Read the elevations of the moveable bed limit stations.

Usage

1
read_bed_limits_elev(f, which.stations = NULL, which.times = NULL)

Arguments

f

The HDF5 file to read.

which.stations

Character vector of stations to extract. If NULL, all stations will be returned.

which.times

Character vector of timestamps to extract. If NULL, all timestamps will be returned.

Details

The moveable bed limit elevations will change over time, both due to channel change and due to lateral movement in models that use BSTEM.

Value

a dataframe with columns "Time", "Station", "LOB" and "ROB", where columns "LOB" and "ROB" list the left and right moveable bed limit elevations, respectively.

Examples

1
2
3
4
5
6
7
8
simple.quasi = system.file("sample-data/SampleQuasiUnsteady.hdf",
  package = "RAStestR")

read_bed_limits_elev(simple.quasi)
read_bed_limits_elev(simple.quasi, which.times = "11DEC1990 01:00:00",
  which.stations = "XS_800")
read_bed_limits_elev(simple.quasi, which.times = 1:4,
  which.stations = 1:2)

mkoohafkan/RAStestR documentation built on July 14, 2019, 11:41 p.m.