printSeries: Print annual results for a given streamflow statistic

View source: R/printSeries.R

printSeriesR Documentation

Print annual results for a given streamflow statistic

Description

Part of the flowHistory system. The index of the flow statistics is istat. These statistics are: (1) 1-day minimum, (2) 7-day minimum, (3) 30-day minimum, (4) median (5) mean, (6) 30-day maximum, (7) 7-day maximum, and (8) 1-day maximum.

Usage

printSeries(eList, istat, qUnit = 1, runoff = FALSE)

Arguments

eList

named list with at least the Daily and INFO dataframes

istat

A numeric value for the flow statistic to be graphed (possible values are 1 through 8)

qUnit

object of qUnit class printqUnitCheatSheet, or numeric represented the short code, or character representing the descriptive name. Default is 1, which is cubic feet per second.

runoff

logical variable, if TRUE the streamflow data are converted to runoff values in mm/day

Details

The smoothing algorithm is as defined in makeAnnualSeries. smoothing window is defined by the eList$INFO$window value (default = 20)

Value

data frame with:

years integer year
qActual numeric Actual flow statistic (based on istat)
qSmooth numeric Smoothed flow statistic

Examples

eList <- Choptank_eList
printReturn <- printSeries(eList, 5)

EGRET documentation built on April 18, 2023, 5:09 p.m.