read_xs: Cross Section Table

In mkoohafkan/RAStestR: Functions for testing RAS outputs

Description

Read the cross section data output.

Usage

read_xs(f, which.times = NULL, which.stations = NULL,
  from.geometry = FALSE)

Arguments

f	The HDF5 file to read.
which.times	Character vector of timestamps to extract. If NULL, all timestamps will be returned.
which.stations	Character vector of stations to extract. If NULL, all stations will be returned.
from.geometry	if TRUE, read the station elevtion data from the plan geometry instead of from the sediment output data. This is useful for reading geometry from a hydraulics-only model or directly from the geometry data (file extension .g*.hdf). Argument which.times will be ignored.

Value

A dataframe with a column "Time" containing the Date Time Stamp data; column "Station" containing the station ID in format "XS_####" where ### is the cross-section ID; column "Distance" containing the lateral distance location; and column "Elevation" containing the elevation at the distance location.

Examples

simple.quasi = system.file("sample-data/SampleQuasiUnsteady.hdf",
  package = "RAStestR")

read_xs(simple.quasi) 
read_xs(simple.quasi, which.times = "02DEC1990 01:00:00",
  which.stations = c("XS_800", "XS_796.00*"))
read_xs(simple.quasi, which.times = 2:4, which.stations = 1:3)

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