setPA: Sets up the period of analysis (the portion of the year being...

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

Sets up the period of analysis (the portion of the year being evaluated).

Description

Period of analysis is defined by the starting month (paStart) and length in months (paLong). paStart and paLong are constrained to be integers from 1 to 12. For example, a water year would be paStart = 10 and paLong = 12. For example, the winter season, defined by Dec,Jan,Feb would be paStart = 12 and paLong = 3.

Usage

setPA(eList, paStart = 10, paLong = 12, window = 20)

Arguments

eList	named list with at least the INFO dataframe
paStart	A numeric value for the starting month of the Period of Analysis, default is 10
paLong	A numeric value for the length of the Period of Analysis in months, default is 12
window	A numeric value for the half-width of a smoothing window for annual streamflow values, default is 20

Value

eList named list with at least the INFO dataframe. Any of these values can be NA, but not all EGRET functions will work with missing parts of the named list eList.

Examples

eList <- Choptank_eList
eList <- setPA(eList, paStart = 12, paLong = 3)

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