screen.cpts {FlowScreen} | R Documentation |
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", title = FALSE, change.margins = TRUE)
Arguments
metrics |
output from |
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). |
title |
optional plot title. Default is FALSE indicating no plot title is wanted.
Set to TRUE to use the the default plot title, which will
look for 'plot title' attribute of the data.frame set by
|
change.margins |
TRUE or FALSE to indicate whether the user's current margin settings should be used, or if the margins should be set within the function. Default is TRUE, to set margins to the minimal amount. |
Value
When type="a", returns a data.frame of changepoint counts by metric type and year.
Author(s)
Jennifer Dierauer
See Also
Examples
# load results from metrics.all function for the Caniapiscau River
data(caniapiscau.res)
# plot changepoints for all groups of metrics
screen.cpts(caniapiscau.res, type="l")
screen.cpts(caniapiscau.res, type="h")
screen.cpts(caniapiscau.res, type="b")