fall: Recessions

View source: R/fall.R

fallR Documentation

Recessions

Description

Identify groundwater recessions

Usage

fall(x, Dates, Start = NULL, End = NULL, by = NULL, MPelev = NULL,
  min.duration = 10, STAID = "Unknown")

Arguments

x

the daily value data to be summarized. Missing values are not permitted within the time specified by Start and End.

Dates

the date for each x, should be of class "Date." Missing values are not permitted.

Start

the start date for the analysis, can be either a character string or class "Date."

End

the end date for the analysis, can be either a character string or class "Date."

by

the months to search for recessions, can be either month numbers or abbreviations. The default is use all months.

MPelev

the measuring point elevation. Required if x is a depth below land surface or other measuring point.

min.duration

the minimum length for a recession to be included in the output.

STAID

the station identifier for the data.

Value

an object of class "fall" containing a data frame of the selected data, a data frame of the recession information, and other information about the analysis.

Examples

## Not run: 
library(smwrData)
data(GlacialRidge)
with(GlacialRidge, fall(G12, datetime, MPelev=1126.42))

## End(Not run)

USGS-R/DVstats documentation built on Oct. 11, 2022, 6:03 a.m.