summary.deficit | R Documentation |
Summarizes an object of class deficit. For every drought event the start, end as well as the drought volume and duration is listed.
## S3 method for class 'deficit' summary(object, drop_minor = c(volume = "0.5%", duration = 5), ...)
object |
an object of class deficit, as produced by |
drop_minor |
a vector of length one or two, determining the filtering of minor droughts. If |
... |
currently ignored. |
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 |
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 |
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))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.