create_prms_parms: Create an PRMS Parameter Object

Description Usage Arguments Value References See Also

View source: R/create_prms_parms.R

Description

create_prms_parms creates an PRMS Parameter Object which can then be written to a PRMS parameter file

Usage

1
create_prms_parms(comments, dimensions, parameters)

Arguments

comments

a character vector with comments

dimensions

a list with two elements where the first element is a character vector specifying the names of the dimensions and the second element a numeric vector specifying the dimension values

parameters

a list with six elements where the first element if a character vector specifying the names of the parameters, the second element is a numeric vector specifying the number of dimensions, the third element is a list where each element is a character vector of length nr_dim[i] corresponding to the respective parameter which identifies the dimensions, the fourth element is a numeric vector specifying the number of values, the fifth element is a numeric vector specifying the parameter type and the sixth element is a list where each element is a numeric vector of length nr_values[i] for the respective parameter specifying the parameter values.

Value

an PRMS Parameter Object which is a list with 3 elements: comments (character vector), dimensions (list with names and values) and parameters (list with names, number of dimensions, dimensions, number of values, types and values)

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

See Also

read_prms_parms, write_prms_parms


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