Hydrovol: Hydrovol

View source: R/Hydrovol.R

HydrovolR Documentation

Hydrovol

Description

Computes volumes and max discharge for hydrographs given the discharge time series and the begin and end dates and times of the hydrographs. Dates must be in POSIXct format.

Usage

Hydrovol(
  dfQ,
  Q = "Q",
  time = "pdate",
  df.dates,
  bdate = "bpdate",
  edate = "epdate",
  volume = "event.vol",
  Qmax = "Qmax",
  duration = "Eduration"
)

Arguments

dfQ

dataframe with Q and time

Q

string name of column in dfQ with Q, defaults to "Q"

time

string name of column in dfQ with POSIXct time, defaults to "pdate"

df.dates

dataframe with begin and end dates/times in POSIXct format

bdate

string begin date in POSIXct column name, defaults to "bpdate"

edate

string end date in POSIXct column name, defaults to "epdate"

volume

string name of resulting volume variable, defaults to "event.vol"

Qmax

string name of Qmax variable, defaults to "Qmax"

duration

string name of resulting duration variable, defaults to "Eduration"

Value

df.dates2 dataframe

Examples

sampleData <- sampleData
flowData <- flowData
Hydrovol(dfQ=flowData,Q="Q",time="pdate",
         df.dates=sampleData,bdate="Hbpdate",edate="Hepdate")

USGS-R/USGSHydroTools documentation built on April 17, 2023, 8:09 p.m.