writeChangeLogFile: Writes information about changes to a 'CRHMr' dataframe to a...

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

Writes information about changes to a CRHMr dataframe to a file

Description

This is an internal CRHMr function and should normally not need to be called directly. This function writes a file containing the a summary of the files as well as the changed data values and a description of their source.

Usage

writeChangeLogFile(
  action,
  original.data.info,
  changed.data.info,
  changed.data.type,
  comment1 = "",
  comment2 = "",
  comment3 = "",
  comment4 = "",
  quiet
)

Arguments

action	Required. A character string indicating the action taken - usually this is the name of the function making the changes.
original.data.info	Required. Information about the original data frame from CRHM_summary.
changed.data.info	Required. Information about the changed data frame from CRHM_summary.
changed.data.type	Required. A vector indicating the type/source of data in the changed dataframe.
comment1	Optional. A comment about the data and/or changes.
comment2	Optional. A comment about the data and/or changes.
comment3	Optional. A comment about the data and/or changes.
comment4	Optional. A comment about the data and/or changes.
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.

Value

If successful, returns TRUE. If unsucessful, returns FALSE.

Author(s)

Kevin Shook

Examples

## Not run: 
writeChangeLogFile('appendObs', obs1.info, obs2.info, output.type,
'primary data: obs1', 'secondary data: obs2')
## End(Not run)

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