plotQTimeDaily: Plot of the discharge time series

In USGS-R/EGRET: Exploration and Graphics for RivEr Trends

Plot of the discharge time series

Description

Part of flowHistory component. Allows discharge record to only show those discharges above a given threshold

Although there are a lot of optional arguments to this function, most are set to a logical default.

Data come from named list, which contains a Daily dataframe with the daily flow data, and an INFO dataframe with metadata.

Usage

plotQTimeDaily(eList, yearStart = NA, yearEnd = NA, qLower = NA,
  qUnit = 1, logScale = FALSE, tinyPlot = FALSE, printTitle = TRUE,
  usgsStyle = FALSE, lwd = 3, col = "red", cex.main = 1.2,
  cex.lab = 1.2, customPar = FALSE, prettyDate = TRUE, ...)

Arguments

eList	named list with at least the Daily and INFO dataframes
yearStart	numeric indicating the starting year for the graph
yearEnd	numeric indicating the ending year for the graph (should be a time in decimal years that is after the last observations to be plotted)
qLower	numeric specifying the lower bound on discharges that are to be plotted, must be in the units specified by qUnit, default is NA (lower bound is zero)
qUnit	object of qUnit class. printqUnitCheatSheet, or numeric represented the short code, or character representing the descriptive name. Default is qUnit=1 (cubic feet per second)
logScale	logical whether or not to use a log scale in the y axis. Default is FALSE.
tinyPlot	logical variable, if TRUE plot is designed to be short and wide, default is FALSE.
printTitle	logical variable if TRUE title is printed, if FALSE title is not printed (this is best for a multi-plot figure)
usgsStyle	logical option to use USGS style guidelines. Setting this option to TRUE does NOT guarantee USGS compliance. It will only change automatically generated labels.
lwd	line width, a positive number, defaulting to 3
col	specification for the default plotting color
cex.main	magnification to be used for main titles relative to the current setting of cex
cex.lab	magnification to be used for x and y labels relative to the current setting of cex
customPar	logical defaults to FALSE. If TRUE, par() should be set by user before calling this function (for example, adjusting margins with par(mar=c(5,5,5,5))). If customPar FALSE, EGRET chooses the best margins depending on tinyPlot.
prettyDate	logical use 'pretty' limits for date axis if TRUE, or force the yearStart/yearEnd as limits if FALSE
...	arbitrary graphical parameters that will be passed to genericEGRETDotPlot function (see ?par for options)

See Also

selectDays, genericEGRETDotPlot

Examples

eList <- Choptank_eList
# Water year:
plotQTimeDaily(eList)
plotQTimeDaily(eList, yearStart=1990, yearEnd=2000,qLower=1500)
plotQTimeDaily(eList, prettyDate=FALSE)

USGS-R/EGRET documentation built on Feb. 9, 2024, 5:30 p.m.