readOutputFile: Reads CRHM model output into a data frame

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

Reads CRHM model output into a data frame

Description

Reads a file containing output from a CRHM model into a CRHMr data frame. Note that because of the way that R reads in files, the variable names will have appended periods, e.g. t.1. This version reads in both old CRHM output (without units) and new CRHM output which contains the variable units in the second line.

Usage

readOutputFile(outputFile, timezone = "", quiet = TRUE, logfile = "")

Arguments

outputFile	Required. The name of the CRHM output file to be read in.
timezone	Required. The name of the timezone of the data as a character string. This should be the timezone of your data, but omitting daylight savings time. Note that the timezone code is specific to your OS. To avoid problems, you should use a timezone without daylight savings time. Under Linux, you can use CST and MST for Central Standard or Mountain Standard time, respectively. Under Windows or OSX, you can use etc/GMT+6 or etc/GMT+7 for Central Standard and Mountain Standard time. DO NOT use America/Regina as the time zone, as it includes historical changes between standard and daylight savings time.
quiet	Optional. Suppresses display of messages, except for errors. If you are calling this function in an R script, you will usually leave quiet=TRUE (i.e. the default). If you are working interactively, you will probably want to set quiet=FALSE.
logfile	Optional. Name of the file to be used for logging the action. Normally not used.

Value

If successful, returns a CRHMr data frame. If unsuccessful, returns the value FALSE.

Author(s)

Kevin Shook

See Also

readExportFile readObsFile readOutputUnits

Examples

## Not run: 
stoon <- readOutputFile('CRHM_output_1.txt', 'etc/GMT+6')
## End(Not run)

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