screen.cpts {FlowScreen}

Change point time series plot

Description

Compiles change point information for all metrics and outputs a daily flow time series plot overlain with a bar plot of changepoint counts by year.

Usage

screen.cpts(metrics, type = "a", text = NULL)

Arguments

metrics

output from metrics.all

type

character indicating which type of metric to compile change points for. Options are "h" for high flow metrics, "l" for low flow metrics, "b" for baseflow metrics, or "a" for all 30 metrics (10 high, 10 low, 10 baseflow).

text

optional character string for margin text, e.g. for station name, location, or other notes. Set to NULL if no margin text is wanted, or set to "d" to use default text containing the station ID, station name, and province/state returned from station.info.

Value

When type="a", returns a data.frame of changepoint counts by metric type and year.

Author(s)

Jennifer Dierauer

See Also

metrics.all

Examples

# load results from metrics.all function for the Caniapiscau River
data(caniapiscau.res)

# plot changepoints for all metrics
screen.cpts(caniapiscau.res, type="l")