readPrjOutputVariables: Reads output variables from a CRHM model '.prj' file

In CentreForHydrology/CRHMr: Pre- and post- processing for CRHM

Reads output variables from a CRHM model .prj file

Description

Reads output variables from a CRHM model .prj file

Usage

readPrjOutputVariables(prjFile, asDataframe = FALSE, logfile = "")

Arguments

prjFile	Required. Name of CRHM .prj file to read.
asDataframe	Optional. If FALSE (the default), returns the set of output variables as a vector. If TRUE, returns a data frame containing the module, variable and HRUs as a string. The vector formis useful if you want to delete some variables. The data frame is more useful if you want to change the variable or its HRUs.
logfile	Optional. Name of the file to be used for logging the action. Normally not used.

Value

If successful, returns the output variables. If unsuccessful, returns FALSE.

Author(s)

Kevin Shook

See Also

setPrjOutputVariables

Examples

## Not run: 
# read in as a vector
variables <- readPrjOutputVariables('Bad_Lake_1974-1975.prj')

# read in as a data frame
variables <- readPrjOutputVariables('Bad_Lake_1974-1975.prj', asDataframe=TRUE)
# change value
variables$HRUs[1] <- '1 2'
## End(Not run)

CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.