read_sediment: Sediment By Grain Class Table

In mkoohafkan/RAStestR: Functions for testing RAS outputs

Description

Read the sediment data output for all grain classes.

Usage

read_sediment(f, table.name, which.times = NULL, which.stations = NULL,
  which.grains = NULL)

Arguments

f	The HDF5 file to read.
table.name	The table 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.
which.grains	Grain class tables to extract. Can accept either numeric grain class IDs or grain class labels. Label "ALL" or "" corresponds to the totals. If NULL, all grain classes will be returned.

Value

A dataframe with a column "Time" containing the Date Time Stamp data; columns "XS_####" where ### is the cross-section ID; and column "GrainClass".

Examples

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

read_sediment(simple.quasi, "Vol Out Cum", 
  which.grains = c("6", "7"))
read_sediment(simple.quasi, "Vol Out Cum", 
  which.grains = c("VFS", "FS"))

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