FlowScreen (version 2.0)

regime: Plot flow regime

Description

This function plots the min, max, mean, and two user-defined quantiles of daily streamflow to provide visual summary of the flow regime. Flow record must have at least 10 years of data to produce a plot. A visual summary is not shown for any days of the year that are missing >80 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

regime(
  TS,
  q = c(0.9, 0.1),
  title = FALSE,
  hyear.start = 10,
  y.lims = NA,
  legend = TRUE,
  change.margins = TRUE
)

Arguments

TS

data.frame of streamflow time series loaded with read.flows.

q

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

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 set.plot.titles. All values other values will be used as a custom plot title.

hyear.start

Integer indicating the start month for the regime plot. Default is 10 (October).

y.lims

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

legend

TRUE or FALSE to indicate whether a legend should be included. Default is TRUE.

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.

Author

Jennifer Dierauer

Examples

# Load example ROBIN streamflow data
robin_path <- system.file("extdata", "ROBIN_example.csv", package = "FlowScreen")

TS <- read.flows(robin_path)
TS <- set.plot.titles(TS)
regime(TS, title = TRUE)