region_to_volume: Region Area to Volume

In mkoohafkan/RAStestR: Functions for testing RAS outputs

Description

Compute cross section volumes by region.

Usage

region_to_volume(d, time.col = "Time", region.col = "Region",
  station.lengths = NULL)

Arguments

d	The area data, e.g. output of xs_area.
time.col	The time column name.
region.col	The name of the column containing the Region identifier.
station.lengths	The cross section length values.

Value

A wide-format table of cross section region volumes.

Examples

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

quasi.xs = read_xs(simple.quasi)
quasi.banks = read_bank_stations(simple.quasi)
quasi.extents = xs_extents(quasi.xs)
quasi.lengths = xs_lengths(read_station_lengths(simple.quasi))

quasi.regions = xs_regions(quasi.xs, bank.stations = quasi.banks, 
 extent.stations = quasi.extents)
region_to_volume(quasi.regions, station.lengths = quasi.lengths)

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