logAction: Writes a comment to the 'CRHMr' log file

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

Writes a comment to the CRHMr log file

Description

This is an internal CRHMr function and should normally not need to be called directly. This function is called by almost all CRHMr functions, and writes the comment, and the date and time to the logfile.

Usage

logAction(comment = "", logfile = "")

Arguments

comment	Required. Comment string to be written. This normally includes the function name, as well as the obs file being processed.
logfile	Optional. Name of the file to be used for logging the action. Normally not used. If not specified, then 'CRHMr.log' in the current working directory will be used.

Value

If successful, returns TRUE. If unsuccessful, returns FALSE.

Author(s)

Kevin Shook

Examples

## Not run: 
 comment <- paste('tMinMaxToHourly dataframe:', obsName, sep='')
 result <- logAction(comment)
## End(Not run)

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