RMevents: RMevents

View source: R/RMevents.R

RMeventsR Documentation

RMevents

Description

Compute rainfall event variables based on time series of rain data with only one rain gage or one mean radar rain column.

Usage

RMevents(df, ieHr = 6, rainthresh = 5.1, rain = "rain", time = "pdate")

Arguments

df

dataframe with rainfall

ieHr

numeric Interevent period in hours, defaults to 6,

rainthresh

numeric Minimum event depth in units of the rain column, default is given as 5.1 assuming millimeters (0.2")

rain

string Column name of rainfall unit values, defaults to "rain"

time

string column with as.POSIXctdate, defaults to "pdate"

Details

Rainfall event determination

Value

list of all rain events that surpass rainthresh (storms2) and all rain events (storms). Also returns all a data frame of all rain observations > 0 with the associated date/time and assigned event number (tipsbystorm) and the minimum time difference between observations (timeInterval)

Examples

RDB <- CedarRRain
RDB2 <- RMprep(RDB,
               prep.type = 1,
               date.type = 1,
               dates.in = "CST.Time",
               tz = "CST6CDT")
event.list <- RMevents(df = RDB2,
                       ieHr = 6,
                       rainthresh = 0.2,
                       rain = "upload.ph3_site_basin_cedar_creek.Id.0....Geographical.Mean.kg.m.2.")
events.0.2 <- event.list$storms2

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