summariseObsFiles: Summarises all obs files in a directory

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

Summarises all obs files in a directory

Description

This function summarises all of the obs files in specified directory, optionally plotting the values in each obs file in a separate graph.

Usage

summariseObsFiles(
  file.dir = "",
  timezone = "",
  summaryFile = "obsSummary.csv",
  plot = FALSE
)

Arguments

file.dir	Optional Directory containing .obs files. If not specified, defaults to current directory. Note that this is an R path, which uses the '/' symbol on ALL operating systems.
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.
summaryFile	Optional. File to contain summary. Defaults to obsSummary.csv in the same directory as the obs files.
plot	Optional. Logical. Do you want to plot graphs of each obs file? Defaults to FALSE.

Value

If successful returns no value. If unsuccessful, returns FALSE.

Author(s)

Kevin Shook

See Also

plotObs

Examples

## Not run: 
summariseObsFiles('c:/data/BadLake/MSC', timezone='etc/GMT+6', plot=TRUE)
## End(Not run)

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