RMintensity: RMintensity

View source: R/RMintensity.R

RMintensityR Documentation

RMintensity

Description

Function to compute maximum x-minute rainfall intensities in units of depth/hr

Usage

RMintensity(
  df,
  date = "r.date",
  rain = "rain",
  df.events,
  sdate = "StartDate",
  edate = "EndDate",
  depth = "depth",
  xmin = c(60, 180, 360)
)

Arguments

df

dataframe

date

string Date column name in df as POSIX

rain

string Column name in df with instantaneous rain values

df.events

dateframe with start and end dates/times for events

sdate

string Start date column in df.events rain file as POSIX

edate

string End date column in df.events rain file as POSIX

depth

string rain depth in event file, defaults to "depth",

xmin

vector vector of values representing X-minute max rainfall requested

Value

df.events dataframe, X-hour maximum rainfall intensities

Examples

RDB <- CedarRRain
RDB2 <- RMprep(RDB,
               prep.type=1,
               date.type=1,
               dates.in="CST.Time",tz="CST6CDT")
RDB3 <- subset(RDB2,
upload.ph3_site_basin_cedar_creek.Id.0....Geographical.Mean.kg.m.2.>-1)
event.list <- RMevents(df=RDB3,
                       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
intensities <- RMintensity(RDB3,date="pdate",
rain="upload.ph3_site_basin_cedar_creek.Id.0....Geographical.Mean.kg.m.2.",
events.0.2,sdate="StartDate",edate="EndDate",depth="rain",xmin=c(5,15,30))

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