flowDuration: Computes several values of the flow duration curve for...

View source: R/flowDuration.R

flowDurationR Documentation

Computes several values of the flow duration curve for streamflow centered on a specific date of the year

Description

This function is useful for helping the analyst determine the empirical probability distribution of streamflow for a particular part of the year or for the whole year. This is particularly useful in setting up discharge scales for various other plots in this package.

Usage

flowDuration(eList, centerDate = "09-30", qUnit = 2, span = 365,
  monthLab = 1)

Arguments

eList

named list with at least Daily and INFO dataframes

centerDate

character specifying the center date of the part of the year for which the flow duration is to be calculated, it is in the form "mm-dd" (it must be in quotes). Default is "09-30"

qUnit

object of qUnit class printqUnitCheatSheet, or numeric represented the short code, or character representing the descriptive name. Default is qUnit = 2, which corresponds to cubic meters per second.

span

number this is the half-width of the window over which the discharge values are to be used in constructing the flow-duration curve. If the full year is desired any value greater than 182 will. Note that for a window of about 2-months width, a span value should be about 30. Default is 365.

monthLab

object of monthLabel class, or numeric represented the short code, or character representing the descriptive name.

Value

qDuration A named vector with flow duration information.

Examples

eList <- Choptank_eList
# for a window of 30 days either side of June 25 expressed in units
# of cfs:
flowDuration(eList, "06-25", qUnit = 1, span = 30) 
# for a flow-duration curve covering the whole year, 
# expressed in units of cms, and returning a data frame of results: 
qDuration <- flowDuration(eList, qUnit = 2) 

USGS-R/EGRET documentation built on Nov. 20, 2024, 7:45 p.m.