marsFetchRainEventData: Fetch rain event data for an SMP

In taywater/pwdgsi: Philadelphia Water Department Green Stormwater Infrastructure

Fetch rain event data for an SMP

Description

Returns a data frame with rain event data from the rain gage closest to the request SMP

Usage

marsFetchRainEventData(
  con,
  target_id,
  source = c("gage", "radar"),
  start_date,
  end_date
)

Arguments

con	An ODBC connection to the MARS Analysis database returned by odbc::dbConnect
target_id	vector of chr, SMP ID, where the user has requested data
source	string, one of "gage" or "radar" to select rain gage events or radar rainfall events
start_date	string, format: "YYYY-MM-DD", start of data request range
end_date	string, format: "YYYY-MM-DD", end of data request range

Value

Output will be a dataframe with the following columns:

rainfall_gage_event_uid	int
gage_uid OR radar_uid	int, unique identifier for rain source, depending on value of source argument
eventdatastart_edt	POSIXct datetime
eventdataend_edt	POSIXct datetime
eventduration_hr	num, duration of event
eventpeakintensity_inhr	num, peak intensity of rain event
eventavgintensity_inhr	num, average intensity of rain event
eventdepth_in	num, average intensity of rain event

See Also

marsFetchRainfallData, marsFetchLevelData, marsFetchMonitoringData

taywater/pwdgsi documentation built on May 9, 2024, 8:21 p.m.