ReadOptpar: Read an 'optpar.txt' file

In HYPEtools: Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE

Read an 'optpar.txt' file

Description

This function imports an 'optpar.txt' into a list.

Usage

ReadOptpar(filename = "optpar.txt", encoding = c("unknown", "UTF-8", "latin1"))

Arguments

filename	Path to and file name of the 'optpar.txt' file to import.
encoding	Character string, encoding of non-ascii characters in imported text file. Particularly relevant when importing files created under Windows (default encoding "Latin-1") in Linux (default encoding "UTF-8") and vice versa. See also argument description in scan.

Details

ReadOptpar imports HYPE 'optpar.txt' files. Optpar files contain instructions for parameter calibration/optimization and parameter value ranges, for details on the file format, see the optpar.txt online documentation.

Value

ReadOptpar returns a list object with three elements:

• comment, the file's first-row comment string.

• tasks, a two-column dataframe with row-wise key-value pairs for tasks and settings.

• pars, a list of dataframes, each containing values for one parameter. Three columns each, holding parameter range minima, maxima, and intervals. The number of rows in each dataframe corresponds to the number of soil or land use classes for class-specific parameters. Parameter names as list element names.

See Also

ReadPar

Examples

te <- ReadOptpar(filename = system.file("demo_model", "optpar.txt", package = "HYPEtools"))
te

HYPEtools documentation built on Sept. 11, 2024, 8:34 p.m.