read_prms_map: Read a PRMS Map Results output file

In cneyens/prms: Reading and writing PRMS files

Description

read_prms_map reads in a PRMS Map Results output file which maps selected PRMS variables to specified spatial and temporal distributions and returns it as an 3D array of dimensions nrow x ncol x nstp. Additionally, the start dates, end dates and number of days of each time step and the means of the variable averaged over the time step are returned as well.

Usage

read_prms_map(path = NULL, nrow = NULL, ncol = NULL, start_date = NULL)

Arguments

path	path to the output file
nrow	number of rows in the mapped spatial resolution
ncol	number of columns in the mapped spatial resolution
start_date	Date object specifying the start date of the output

Value

a list with (1) a 3D array of dimensions nrow x ncol x nstp with nstp the amount of time steps, (2) vectors of start and end dates of each time step, (3) number of days in each time step and (4) means of the variable averaged over each time step

References

Markstrom, S.L., Regan, R.S., Hay, L.E., Viger, R.J., Webb, R.M.T., Payn, R.A., and LaFontaine, J.H., 2015, PRMS-IV, the precipitation-runoff modeling system, version 4: U.S. Geological Survey Techniques and Methods, book 6, chap. B7, 158 p., https://dx.doi.org/10.3133/tm6B7, https://pubs.usgs.gov/tm/6b7/pdf/tm6-b7.pdf

cneyens/prms documentation built on May 19, 2019, 1:42 a.m.