regime: Plot flow regime

Description Usage Arguments Author(s) Examples

View source: R/regime.R

Description

This function plots the min, max, mean, and two user-defined quantiles of daily streamflow to provide visual summary of the flow regime. Area between the upper and lower quantile is shaded grey, the dark blue line represents the mean daily discharge, gray line represents the median daily discharge, and the period of record daily maximum and minimum are shown with the blue points.

Usage

1
regime(TS, q = c(0.9, 0.1), text = "d", by = "hdoy", y.lims = NA)

Arguments

TS

output from create.ts containing a data.frame of flow time series

q

Numeric vector of the upper and lower quantile values. Default is c(0.9, 0.1).

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.

by

Character string indicating whether to plot the regime by day of the hydrologic year (defined using create.ts) or by day of the calendar year. Options are "doy" (calendar year) or "hdoy" (default, hydrologic year).

y.lims

optional user-defined y-axis minimum and maximim. e.g. c(0, 500)

Author(s)

Jennifer Dierauer

Examples

1
2
3
# plot the flow regime of the Caniapiscau River
data(cania.sub.ts)
regime(cania.sub.ts)

Example output



FlowScreen documentation built on May 2, 2019, 1:09 p.m.