ch_qa_hydrograph {CSHShydRology}

R Documentation

Plots a hydrograph with the data quality symbols and returns a report on qa symbols and missing data.

Description

Plots a hydrograph of a WSC daily data file read from from ECDataExplorer (ECDE). The hydrograph shows individual days with data quality symbols [SYM] in colour and counts cases of each and reports them in the legend. The colours and symbols are those produced by ECDataExplorer.

There is an option is to provide start and end dates to show only part of the time period for which data exists and the plot is annotated to indicate this. Counts of missing observations is also provided in the legend.

Usage

ch_qa_hydrograph(
  DF,
  st_date = NULL,
  end_date = NULL,
  cts = TRUE,
  rescale = FALSE,
  sym_col = c("black", "green", "cyan", "yellow", "red", "white"),
  metadata = NULL
)

Arguments

DF	Data frame retrieved from ECDataExplorer as returned by the function ch_read_ECDE_flows.
st_date	Optional start date in the form yyyy-mm-dd. Default is NULL.
end_date	Optional end date in the form yyyy-mm-dd. Default is NULL.
cts	If TRUE (the default) shows the counts of SYM in the legend. If FALSE the counts are omitted as in ECDE.
rescale	If FALSE (the default), the y-axis scaling is determined by the time period. If TRUE then determined by the whole dataset.
sym_col	Colours used for SYM; default is those used in ECDE ("black", "green", "cyan","yellow", "red", "white"). The final "white" can be changed to highlight missing data points.
metadata	a dataframe of station metadata, default is HYDAT_list.

Value

Produces a plot and returns a list that contains:

station name or title used
st_date	starting date
end_date	ending data
n	the number of data points
sym_count	summary of the SYM counts
missing	number of missing data

Author(s)

Paul Whitfield

Examples

m_test <- ch_qa_hydrograph(CAN05AA008)
m_test <- ch_qa_hydrograph(CAN05AA008, st_date="1980-01-01", end_date="1999-12-31")

---