nfd_get_: Get data from 'nfd' objects.

In BoulderCodeHub/CRSSIO: Package to Manage the Input and Output of CRSS Data

Get data from nfd objects.

Description

⁠nfd_get_*()⁠ functions get data from an nfd object in matrix form. If there is a time component, then the data are returned as an xts matrix. To extract the data, but keep as an nfd object, see nfd_extract().

Usage

nfd_get_site(x, site, flow_space, time_step)

nfd_get_trace(x, trace, flow_space, time_step)

nfd_get_time(x, time, flow_space, time_step)

Arguments

x	An nfd object.
site	Site name or index.
flow_space	"total" or "intervening"
time_step	"annual" or "monthly"
trace	Trace number (numeric scalar)
time	Time to extract as yearmon or character.

Details

nfd_get_site() returns the data for all traces for one specified site.

nfd_get_trace() returns the data for all sites for one specified trace.

nfd_get_time() returns the data for all sites and all traces for the specified time. To get annual data, must specify December or September of the desired year for calendar year or water year data, respectively.

Value

nfd_get_site() returns an xts object with columns representing different traces.

nfd_get_trace() returns an xts object with columns representing different sites.

nfd_get_time() returns a matrix with columns representing different sites and rows representing different traces.

See Also

nfd_extract(), nfd

BoulderCodeHub/CRSSIO documentation built on July 2, 2023, 5:15 p.m.