summary.deficit: Object Summaries

In lfstat: Calculation of Low Flow Statistics for Daily Stream Flow Data

Description

Summarizes an object of class deficit. For every drought event the start, end as well as the drought volume and duration is listed.

Usage

## S3 method for class 'deficit'
summary(object, drop_minor = c(volume = "0.5%", duration = 5), ...)

Arguments

object	an object of class deficit, as produced by find_droughts.
drop_minor	a vector of length one or two, determining the filtering of minor droughts. If drop_minor is of length one and its value is zero, no filtering is applied. Also a numeric of character vector of length two with the named elements volume and duration is accepted. If a value contains the percentage (%) sign this percentage of the maximum duration or volume is used a the filter criterion.
...	currently ignored.

Value

a data.frame where each row corresponds to an event. There are summarizing columns

event.no	the event id
start	the starting day of the drought event
time	the day which the event is attributed to. Usually identical with column start, unless the object x is the result of the Sequent Peak Algorithm.
volume	the volume of the drought event in cubic meters
duration	the duration of the drought event in days
dbt	days below threshold. Number of days the discharge is lower than the given threshold.
qmin	the minimum discharge
tqmin	date of the minimum discharge

Examples

data(ray)
ray <- as.xts(ray)["1970::1970", ]
r <- find_droughts(ray, threshold = 0.02)
summary(r)      # minor events got filtered

summary(r, drop_minor = 0)      # no filtering
summary(r, drop_minor = c("volume" = 10000, "duration" = 5))
summary(r, drop_minor = c("volume" = "10%", "duration" = 5))

lfstat documentation built on May 2, 2019, 6:07 p.m.