find_droughts: Identifying Low Flow Periods
In lfstat: Calculation of Low Flow Statistics for Daily Stream Flow Data
Description
Usage
Arguments
Value
See Also
Examples
Description
A streamflow deficit is defined as an event where discharges are below a given threshold.
Usage
1
find_droughts(x, threshold = vary_threshold, varying = "constant", ...)
Arguments
x
an object which can be coerced to class xts. Either with a single column or with a column named 'discharge'. Units of x are retrieved from the attributes. If it fails, an error is raised.
threshold
The threshold can either be a constant value, a time series with the same length as x or a function (taking a single argument) returning either of these. Furthermore threshold can be a character vector of length one specifying a quantile of x like threshold = 'Q80' as a shortcut of threshold = function(x) quantile(x, 0.2, na.rm = TRUE). See vary_threshold for varying a threshold in time.
varying
if varying is a character vector of length one, values of "constant", "daily", "weekly" and "monthly" are allowed. If a vector of class POSIX is provided, a seasonal varying threshold is computed, where the times provided define the start of the season. Only the day of the year is taken, the year itself doesn't have a meaning.
...
if threshold is a function, these additional arguments are passed on to the function
Value
an object of class 'deficit', which is basically an xts object with the columns
discharge
discharges as provided with x
threshold
the threshold
def.increase
The increase of the deficit volume in m^3 per day.
event.no
an event id. If an event is numbered "0" this period not considered as a streamflow deficit.
See Also
There are summary and plot methods, see summary.deficit and plot.deficit.
pooling, summary.deficit, plot.deficit
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
data(ray)
ray <- as.xts(ray)["1970::1979", ]
r <- find_droughts(ray)
head(r)
summary(r)
plot(r)
# threshold is to low, because there are many days with
# zero flow observations
# provide threshold as a constant value
r <- find_droughts(ray, threshold = 0.02)
head(r)
summary(r)
plot(r)
# provide threshold as a function
r <- find_droughts(ray,
threshold = function(x) quantile(x, 0.2, na.rm = TRUE))
head(r)
summary(r)
Example output
Loading required package: xts
Loading required package: zoo
Attaching package: 'zoo'
The following objects are masked from 'package:base':
as.Date, as.Date.numeric
Loading required package: lmom
Loading required package: lattice
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0 -864 0
1970-01-02 0.010 0 -864 0
1970-01-03 0.010 0 -864 0
1970-01-04 0.005 0 -432 0
1970-01-05 0.005 0 -432 0
1970-01-06 0.005 0 -432 0
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 46 minor events of 112 total.
Only droughts with volume >= 0 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
2 2 1970-05-21 1970-06-10 1970-06-10 0 21 21 0
3 3 1970-06-13 1970-06-26 1970-06-26 0 14 14 0
4 4 1970-06-28 1970-07-13 1970-07-13 0 16 16 0
7 7 1970-07-25 1970-08-05 1970-08-05 0 12 12 0
8 8 1970-08-08 1970-08-18 1970-08-18 0 11 11 0
9 9 1970-08-24 1970-09-08 1970-09-08 0 16 16 0
11 11 1970-09-15 1970-10-31 1970-10-31 0 47 47 0
14 14 1971-05-17 1971-05-22 1971-05-22 0 6 6 0
17 17 1971-05-29 1971-06-07 1971-06-07 0 10 10 0
19 19 1971-07-07 1971-07-23 1971-07-23 0 17 17 0
21 21 1971-09-01 1971-09-23 1971-09-23 0 23 23 0
23 23 1971-09-28 1971-10-02 1971-10-02 0 5 5 0
24 24 1971-10-04 1971-10-11 1971-10-11 0 8 8 0
25 25 1972-01-04 1972-01-12 1972-01-12 0 9 9 0
27 27 1972-06-14 1972-06-26 1972-06-26 0 13 13 0
30 30 1972-07-10 1972-07-21 1972-07-21 0 12 12 0
31 31 1972-07-26 1972-07-30 1972-07-30 0 5 5 0
32 32 1972-08-11 1972-09-07 1972-09-07 0 28 28 0
33 33 1972-09-11 1972-10-09 1972-10-09 0 29 29 0
34 34 1972-10-12 1972-11-06 1972-11-06 0 26 26 0
39 39 1973-05-31 1973-06-18 1973-06-18 0 19 19 0
41 41 1973-07-01 1973-07-05 1973-07-05 0 5 5 0
43 43 1973-07-22 1973-08-04 1973-08-04 0 14 14 0
44 44 1973-08-08 1973-12-07 1973-12-07 0 122 122 0
45 45 1973-12-09 1973-12-20 1973-12-20 0 12 12 0
46 46 1974-04-14 1974-04-27 1974-04-27 0 14 14 0
48 48 1974-05-04 1974-05-10 1974-05-10 0 7 7 0
49 49 1974-05-15 1974-06-07 1974-06-07 0 24 24 0
50 50 1974-06-09 1974-06-15 1974-06-15 0 7 7 0
51 51 1974-06-20 1974-06-25 1974-06-25 0 6 6 0
52 52 1974-07-06 1974-07-13 1974-07-13 0 8 8 0
54 54 1974-07-21 1974-08-03 1974-08-03 0 14 14 0
57 57 1974-08-16 1974-08-25 1974-08-25 0 10 10 0
61 61 1975-06-04 1975-06-15 1975-06-15 0 12 12 0
62 62 1975-06-17 1975-07-16 1975-07-16 0 30 30 0
63 63 1975-07-21 1975-09-12 1975-09-12 0 54 54 0
64 64 1975-09-16 1975-09-24 1975-09-24 0 9 9 0
65 65 1975-09-29 1975-11-02 1975-11-02 0 35 35 0
66 66 1975-11-04 1975-11-14 1975-11-14 0 11 11 0
68 68 1975-11-20 1975-11-26 1975-11-26 0 7 7 0
69 69 1975-12-07 1975-12-30 1975-12-30 0 24 24 0
71 71 1976-01-21 1976-02-11 1976-02-11 0 22 22 0
72 72 1976-02-26 1976-03-14 1976-03-14 0 18 18 0
73 73 1976-03-21 1976-03-31 1976-03-31 0 11 11 0
74 74 1976-04-02 1976-04-13 1976-04-13 0 12 12 0
75 75 1976-04-15 1976-09-24 1976-09-24 0 163 163 0
80 80 1976-11-23 1976-11-27 1976-11-27 0 5 5 0
81 81 1977-04-15 1977-04-25 1977-04-25 0 11 11 0
82 82 1977-05-19 1977-06-09 1977-06-09 0 22 22 0
83 83 1977-06-23 1977-06-27 1977-06-27 0 5 5 0
84 84 1977-07-03 1977-08-15 1977-08-15 0 44 44 0
86 86 1977-09-06 1977-09-24 1977-09-24 0 19 19 0
87 87 1977-09-26 1977-10-07 1977-10-07 0 12 12 0
88 88 1977-10-10 1977-10-31 1977-10-31 0 22 22 0
91 91 1977-11-26 1977-12-05 1977-12-05 0 10 10 0
92 92 1978-05-20 1978-06-28 1978-06-28 0 40 40 0
93 93 1978-06-30 1978-07-30 1978-07-30 0 31 31 0
94 94 1978-08-05 1978-09-27 1978-09-27 0 54 54 0
95 95 1978-09-29 1978-11-18 1978-11-18 0 51 51 0
96 96 1978-11-20 1978-12-06 1978-12-06 0 17 17 0
101 101 1979-06-26 1979-08-07 1979-08-07 0 43 43 0
104 104 1979-08-17 1979-08-22 1979-08-22 0 6 6 0
105 105 1979-08-24 1979-10-07 1979-10-07 0 45 45 0
107 107 1979-10-11 1979-10-24 1979-10-24 0 14 14 0
109 109 1979-11-10 1979-11-17 1979-11-17 0 8 8 0
110 110 1979-11-19 1979-11-25 1979-11-25 0 7 7 0
tqmin
2 1970-05-21
3 1970-06-13
4 1970-06-28
7 1970-07-25
8 1970-08-08
9 1970-08-24
11 1970-09-15
14 1971-05-17
17 1971-05-29
19 1971-07-07
21 1971-09-01
23 1971-09-28
24 1971-10-04
25 1972-01-04
27 1972-06-14
30 1972-07-10
31 1972-07-26
32 1972-08-11
33 1972-09-11
34 1972-10-12
39 1973-05-31
41 1973-07-01
43 1973-07-22
44 1973-08-08
45 1973-12-09
46 1974-04-14
48 1974-05-04
49 1974-05-15
50 1974-06-09
51 1974-06-20
52 1974-07-06
54 1974-07-21
57 1974-08-16
61 1975-06-04
62 1975-06-17
63 1975-07-21
64 1975-09-16
65 1975-09-29
66 1975-11-04
68 1975-11-20
69 1975-12-07
71 1976-01-21
72 1976-02-26
73 1976-03-21
74 1976-04-02
75 1976-04-15
80 1976-11-23
81 1977-04-15
82 1977-05-19
83 1977-06-23
84 1977-07-03
86 1977-09-06
87 1977-09-26
88 1977-10-10
91 1977-11-26
92 1978-05-20
93 1978-06-30
94 1978-08-05
95 1978-09-29
96 1978-11-20
101 1979-06-26
104 1979-08-17
105 1979-08-24
107 1979-10-11
109 1979-11-10
110 1979-11-19
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0.02 864 1
1970-01-02 0.010 0.02 864 1
1970-01-03 0.010 0.02 864 1
1970-01-04 0.005 0.02 1296 1
1970-01-05 0.005 0.02 1296 1
1970-01-06 0.005 0.02 1296 1
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 30 minor events of 92 total.
Only droughts with volume >= 1893.024 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
1 1 1970-01-01 1970-01-08 1970-01-08 9763.2 8 8 0.000
3 3 1970-05-04 1970-05-09 1970-05-09 4147.2 6 6 0.010
4 4 1970-05-13 1970-08-19 1970-08-19 162864.0 99 99 0.000
5 5 1970-08-21 1970-11-06 1970-11-06 128563.2 78 78 0.000
6 6 1970-11-08 1970-11-13 1970-11-13 5702.4 6 6 0.005
7 7 1970-12-19 1970-12-28 1970-12-28 7171.2 10 10 0.009
8 8 1971-04-01 1971-04-22 1971-04-22 25056.0 22 22 0.000
9 9 1971-05-01 1971-06-09 1971-06-09 60048.0 40 40 0.000
12 12 1971-06-23 1971-08-02 1971-08-02 59875.2 41 41 0.000
13 13 1971-08-04 1971-08-10 1971-08-10 5961.6 7 7 0.005
16 16 1971-08-22 1971-10-12 1971-10-12 82684.8 52 52 0.000
18 18 1971-10-24 1971-11-04 1971-11-04 13046.4 12 12 0.005
19 19 1971-11-13 1971-11-17 1971-11-17 3196.8 5 5 0.010
20 20 1971-12-13 1971-12-18 1971-12-18 3628.8 6 6 0.010
21 21 1972-01-04 1972-01-12 1972-01-12 15552.0 9 9 0.000
23 23 1972-04-20 1972-04-28 1972-04-28 7862.4 9 9 0.005
25 25 1972-05-04 1972-05-08 1972-05-08 2851.2 5 5 0.010
26 26 1972-05-17 1972-07-30 1972-07-30 112838.4 75 75 0.000
28 28 1972-08-08 1972-11-11 1972-11-11 160272.0 96 96 0.000
29 29 1972-11-14 1972-11-18 1972-11-18 7084.8 5 5 0.001
30 30 1972-11-22 1972-11-30 1972-11-30 9676.8 9 9 0.005
31 31 1972-12-28 1973-01-14 1973-01-14 15292.8 18 18 0.005
34 34 1973-03-11 1973-04-01 1973-04-01 23846.4 22 22 0.000
36 36 1973-04-05 1973-04-23 1973-04-23 22723.2 19 19 0.000
37 37 1973-04-25 1973-05-03 1973-05-03 7257.6 9 9 0.005
38 38 1973-05-12 1973-06-19 1973-06-19 57801.6 39 39 0.000
39 39 1973-06-21 1973-06-25 1973-06-25 8208.0 5 5 0.000
40 40 1973-06-30 1973-07-05 1973-07-05 8640.0 6 6 0.000
41 41 1973-07-09 1973-07-14 1973-07-14 9676.8 6 6 0.000
42 42 1973-07-21 1973-08-05 1973-08-05 26956.8 16 16 0.000
43 43 1973-08-07 1973-12-20 1973-12-20 232848.0 136 136 0.000
44 44 1974-03-29 1974-06-15 1974-06-15 122601.6 79 79 0.000
45 45 1974-06-18 1974-06-25 1974-06-25 12182.4 8 8 0.000
46 46 1974-06-30 1974-07-15 1974-07-15 23414.4 16 16 0.000
47 47 1974-07-17 1974-08-03 1974-08-03 29808.0 18 18 0.000
48 48 1974-08-06 1974-08-25 1974-08-25 32140.8 20 20 0.000
49 49 1974-08-27 1974-09-01 1974-09-01 8467.2 6 6 0.000
50 50 1974-09-10 1974-09-22 1974-09-22 15811.2 13 13 0.000
55 55 1975-04-25 1975-05-16 1975-05-16 22809.6 22 22 0.005
56 56 1975-05-21 1975-07-16 1975-07-16 92188.8 57 57 0.000
57 57 1975-07-19 1975-12-01 1975-12-01 225331.2 136 136 0.000
58 58 1975-12-03 1976-01-03 1976-01-03 51321.6 32 32 0.000
59 59 1976-01-06 1976-02-11 1976-02-11 57369.6 37 37 0.000
60 60 1976-02-15 1976-09-26 1976-09-26 378604.8 225 225 0.000
61 61 1976-09-28 1976-10-02 1976-10-02 5616.0 5 5 0.000
65 65 1976-10-16 1976-10-28 1976-10-28 12787.2 13 13 0.000
67 67 1976-11-22 1976-11-27 1976-11-27 8985.6 6 6 0.000
68 68 1977-04-14 1977-04-25 1977-04-25 20217.6 12 12 0.000
69 69 1977-05-18 1977-06-09 1977-06-09 39139.2 23 23 0.000
71 71 1977-06-22 1977-06-27 1977-06-27 9676.8 6 6 0.000
72 72 1977-07-02 1977-08-16 1977-08-16 79228.8 46 46 0.000
75 75 1977-09-05 1977-11-01 1977-11-01 97545.6 58 58 0.000
77 77 1977-11-16 1977-11-23 1977-11-23 12009.6 8 8 0.000
78 78 1977-11-25 1977-12-06 1977-12-06 19008.0 12 12 0.000
80 80 1978-05-20 1978-07-30 1978-07-30 124243.2 72 72 0.000
81 81 1978-08-04 1978-12-07 1978-12-07 216345.6 126 126 0.000
83 83 1978-12-18 1978-12-22 1978-12-22 5961.6 5 5 0.000
84 84 1979-01-02 1979-01-06 1979-01-06 6739.2 5 5 0.000
87 87 1979-06-20 1979-08-07 1979-08-07 81475.2 49 49 0.000
88 88 1979-08-09 1979-10-25 1979-10-25 129600.0 78 78 0.000
89 89 1979-10-27 1979-10-31 1979-10-31 8208.0 5 5 0.000
90 90 1979-11-09 1979-11-26 1979-11-26 27648.0 18 18 0.000
tqmin
1 1970-01-07
3 1970-05-06
4 1970-05-21
5 1970-08-24
6 1970-11-10
7 1970-12-27
8 1971-04-21
9 1971-05-11
12 1971-07-02
13 1971-08-08
16 1971-09-01
18 1971-10-28
19 1971-11-15
20 1971-12-16
21 1972-01-04
23 1972-04-25
25 1972-05-07
26 1972-06-07
28 1972-08-11
29 1972-11-17
30 1972-11-25
31 1973-01-12
34 1973-03-29
36 1973-04-17
37 1973-04-28
38 1973-05-27
39 1973-06-22
40 1973-07-01
41 1973-07-10
42 1973-07-22
43 1973-08-08
44 1974-04-14
45 1974-06-20
46 1974-07-06
47 1974-07-19
48 1974-08-07
49 1974-08-29
50 1974-09-19
55 1975-05-01
56 1975-05-31
57 1975-07-21
58 1975-12-07
59 1976-01-16
60 1976-02-26
61 1976-10-01
65 1976-10-17
67 1976-11-23
68 1977-04-15
69 1977-05-19
71 1977-06-23
72 1977-07-03
75 1977-09-06
77 1977-11-17
78 1977-11-26
80 1978-05-20
81 1978-08-05
83 1978-12-19
84 1979-01-04
87 1979-06-22
88 1979-08-10
89 1979-10-28
90 1979-11-10
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0 -864 0
1970-01-02 0.010 0 -864 0
1970-01-03 0.010 0 -864 0
1970-01-04 0.005 0 -432 0
1970-01-05 0.005 0 -432 0
1970-01-06 0.005 0 -432 0
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 46 minor events of 112 total.
Only droughts with volume >= 0 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
2 2 1970-05-21 1970-06-10 1970-06-10 0 21 21 0
3 3 1970-06-13 1970-06-26 1970-06-26 0 14 14 0
4 4 1970-06-28 1970-07-13 1970-07-13 0 16 16 0
7 7 1970-07-25 1970-08-05 1970-08-05 0 12 12 0
8 8 1970-08-08 1970-08-18 1970-08-18 0 11 11 0
9 9 1970-08-24 1970-09-08 1970-09-08 0 16 16 0
11 11 1970-09-15 1970-10-31 1970-10-31 0 47 47 0
14 14 1971-05-17 1971-05-22 1971-05-22 0 6 6 0
17 17 1971-05-29 1971-06-07 1971-06-07 0 10 10 0
19 19 1971-07-07 1971-07-23 1971-07-23 0 17 17 0
21 21 1971-09-01 1971-09-23 1971-09-23 0 23 23 0
23 23 1971-09-28 1971-10-02 1971-10-02 0 5 5 0
24 24 1971-10-04 1971-10-11 1971-10-11 0 8 8 0
25 25 1972-01-04 1972-01-12 1972-01-12 0 9 9 0
27 27 1972-06-14 1972-06-26 1972-06-26 0 13 13 0
30 30 1972-07-10 1972-07-21 1972-07-21 0 12 12 0
31 31 1972-07-26 1972-07-30 1972-07-30 0 5 5 0
32 32 1972-08-11 1972-09-07 1972-09-07 0 28 28 0
33 33 1972-09-11 1972-10-09 1972-10-09 0 29 29 0
34 34 1972-10-12 1972-11-06 1972-11-06 0 26 26 0
39 39 1973-05-31 1973-06-18 1973-06-18 0 19 19 0
41 41 1973-07-01 1973-07-05 1973-07-05 0 5 5 0
43 43 1973-07-22 1973-08-04 1973-08-04 0 14 14 0
44 44 1973-08-08 1973-12-07 1973-12-07 0 122 122 0
45 45 1973-12-09 1973-12-20 1973-12-20 0 12 12 0
46 46 1974-04-14 1974-04-27 1974-04-27 0 14 14 0
48 48 1974-05-04 1974-05-10 1974-05-10 0 7 7 0
49 49 1974-05-15 1974-06-07 1974-06-07 0 24 24 0
50 50 1974-06-09 1974-06-15 1974-06-15 0 7 7 0
51 51 1974-06-20 1974-06-25 1974-06-25 0 6 6 0
52 52 1974-07-06 1974-07-13 1974-07-13 0 8 8 0
54 54 1974-07-21 1974-08-03 1974-08-03 0 14 14 0
57 57 1974-08-16 1974-08-25 1974-08-25 0 10 10 0
61 61 1975-06-04 1975-06-15 1975-06-15 0 12 12 0
62 62 1975-06-17 1975-07-16 1975-07-16 0 30 30 0
63 63 1975-07-21 1975-09-12 1975-09-12 0 54 54 0
64 64 1975-09-16 1975-09-24 1975-09-24 0 9 9 0
65 65 1975-09-29 1975-11-02 1975-11-02 0 35 35 0
66 66 1975-11-04 1975-11-14 1975-11-14 0 11 11 0
68 68 1975-11-20 1975-11-26 1975-11-26 0 7 7 0
69 69 1975-12-07 1975-12-30 1975-12-30 0 24 24 0
71 71 1976-01-21 1976-02-11 1976-02-11 0 22 22 0
72 72 1976-02-26 1976-03-14 1976-03-14 0 18 18 0
73 73 1976-03-21 1976-03-31 1976-03-31 0 11 11 0
74 74 1976-04-02 1976-04-13 1976-04-13 0 12 12 0
75 75 1976-04-15 1976-09-24 1976-09-24 0 163 163 0
80 80 1976-11-23 1976-11-27 1976-11-27 0 5 5 0
81 81 1977-04-15 1977-04-25 1977-04-25 0 11 11 0
82 82 1977-05-19 1977-06-09 1977-06-09 0 22 22 0
83 83 1977-06-23 1977-06-27 1977-06-27 0 5 5 0
84 84 1977-07-03 1977-08-15 1977-08-15 0 44 44 0
86 86 1977-09-06 1977-09-24 1977-09-24 0 19 19 0
87 87 1977-09-26 1977-10-07 1977-10-07 0 12 12 0
88 88 1977-10-10 1977-10-31 1977-10-31 0 22 22 0
91 91 1977-11-26 1977-12-05 1977-12-05 0 10 10 0
92 92 1978-05-20 1978-06-28 1978-06-28 0 40 40 0
93 93 1978-06-30 1978-07-30 1978-07-30 0 31 31 0
94 94 1978-08-05 1978-09-27 1978-09-27 0 54 54 0
95 95 1978-09-29 1978-11-18 1978-11-18 0 51 51 0
96 96 1978-11-20 1978-12-06 1978-12-06 0 17 17 0
101 101 1979-06-26 1979-08-07 1979-08-07 0 43 43 0
104 104 1979-08-17 1979-08-22 1979-08-22 0 6 6 0
105 105 1979-08-24 1979-10-07 1979-10-07 0 45 45 0
107 107 1979-10-11 1979-10-24 1979-10-24 0 14 14 0
109 109 1979-11-10 1979-11-17 1979-11-17 0 8 8 0
110 110 1979-11-19 1979-11-25 1979-11-25 0 7 7 0
tqmin
2 1970-05-21
3 1970-06-13
4 1970-06-28
7 1970-07-25
8 1970-08-08
9 1970-08-24
11 1970-09-15
14 1971-05-17
17 1971-05-29
19 1971-07-07
21 1971-09-01
23 1971-09-28
24 1971-10-04
25 1972-01-04
27 1972-06-14
30 1972-07-10
31 1972-07-26
32 1972-08-11
33 1972-09-11
34 1972-10-12
39 1973-05-31
41 1973-07-01
43 1973-07-22
44 1973-08-08
45 1973-12-09
46 1974-04-14
48 1974-05-04
49 1974-05-15
50 1974-06-09
51 1974-06-20
52 1974-07-06
54 1974-07-21
57 1974-08-16
61 1975-06-04
62 1975-06-17
63 1975-07-21
64 1975-09-16
65 1975-09-29
66 1975-11-04
68 1975-11-20
69 1975-12-07
71 1976-01-21
72 1976-02-26
73 1976-03-21
74 1976-04-02
75 1976-04-15
80 1976-11-23
81 1977-04-15
82 1977-05-19
83 1977-06-23
84 1977-07-03
86 1977-09-06
87 1977-09-26
88 1977-10-10
91 1977-11-26
92 1978-05-20
93 1978-06-30
94 1978-08-05
95 1978-09-29
96 1978-11-20
101 1979-06-26
104 1979-08-17
105 1979-08-24
107 1979-10-11
109 1979-11-10
110 1979-11-19
lfstat documentation built on May 2, 2019, 6:07 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value See Also Examples
Description
A streamflow deficit is defined as an event where discharges are below a given threshold.
Usage
1 | find_droughts(x, threshold = vary_threshold, varying = "constant", ...)
|
Arguments
x |
an object which can be coerced to class xts. Either with a single column or with a column named 'discharge'. Units of x are retrieved from the attributes. If it fails, an error is raised. |
threshold |
The threshold can either be a constant value, a time series with the same length as |
varying |
if |
... |
if threshold is a function, these additional arguments are passed on to the function |
Value
an object of class 'deficit', which is basically an xts object with the columns
discharge |
discharges as provided with |
threshold |
the threshold |
def.increase |
The increase of the deficit volume in m^3 per day. |
event.no |
an event id. If an event is numbered "0" this period not considered as a streamflow deficit. |
See Also
There are summary and plot methods, see summary.deficit and plot.deficit.
pooling, summary.deficit, plot.deficit
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | data(ray)
ray <- as.xts(ray)["1970::1979", ]
r <- find_droughts(ray)
head(r)
summary(r)
plot(r)
# threshold is to low, because there are many days with
# zero flow observations
# provide threshold as a constant value
r <- find_droughts(ray, threshold = 0.02)
head(r)
summary(r)
plot(r)
# provide threshold as a function
r <- find_droughts(ray,
threshold = function(x) quantile(x, 0.2, na.rm = TRUE))
head(r)
summary(r)
|
Example output
Loading required package: xts
Loading required package: zoo
Attaching package: 'zoo'
The following objects are masked from 'package:base':
as.Date, as.Date.numeric
Loading required package: lmom
Loading required package: lattice
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0 -864 0
1970-01-02 0.010 0 -864 0
1970-01-03 0.010 0 -864 0
1970-01-04 0.005 0 -432 0
1970-01-05 0.005 0 -432 0
1970-01-06 0.005 0 -432 0
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 46 minor events of 112 total.
Only droughts with volume >= 0 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
2 2 1970-05-21 1970-06-10 1970-06-10 0 21 21 0
3 3 1970-06-13 1970-06-26 1970-06-26 0 14 14 0
4 4 1970-06-28 1970-07-13 1970-07-13 0 16 16 0
7 7 1970-07-25 1970-08-05 1970-08-05 0 12 12 0
8 8 1970-08-08 1970-08-18 1970-08-18 0 11 11 0
9 9 1970-08-24 1970-09-08 1970-09-08 0 16 16 0
11 11 1970-09-15 1970-10-31 1970-10-31 0 47 47 0
14 14 1971-05-17 1971-05-22 1971-05-22 0 6 6 0
17 17 1971-05-29 1971-06-07 1971-06-07 0 10 10 0
19 19 1971-07-07 1971-07-23 1971-07-23 0 17 17 0
21 21 1971-09-01 1971-09-23 1971-09-23 0 23 23 0
23 23 1971-09-28 1971-10-02 1971-10-02 0 5 5 0
24 24 1971-10-04 1971-10-11 1971-10-11 0 8 8 0
25 25 1972-01-04 1972-01-12 1972-01-12 0 9 9 0
27 27 1972-06-14 1972-06-26 1972-06-26 0 13 13 0
30 30 1972-07-10 1972-07-21 1972-07-21 0 12 12 0
31 31 1972-07-26 1972-07-30 1972-07-30 0 5 5 0
32 32 1972-08-11 1972-09-07 1972-09-07 0 28 28 0
33 33 1972-09-11 1972-10-09 1972-10-09 0 29 29 0
34 34 1972-10-12 1972-11-06 1972-11-06 0 26 26 0
39 39 1973-05-31 1973-06-18 1973-06-18 0 19 19 0
41 41 1973-07-01 1973-07-05 1973-07-05 0 5 5 0
43 43 1973-07-22 1973-08-04 1973-08-04 0 14 14 0
44 44 1973-08-08 1973-12-07 1973-12-07 0 122 122 0
45 45 1973-12-09 1973-12-20 1973-12-20 0 12 12 0
46 46 1974-04-14 1974-04-27 1974-04-27 0 14 14 0
48 48 1974-05-04 1974-05-10 1974-05-10 0 7 7 0
49 49 1974-05-15 1974-06-07 1974-06-07 0 24 24 0
50 50 1974-06-09 1974-06-15 1974-06-15 0 7 7 0
51 51 1974-06-20 1974-06-25 1974-06-25 0 6 6 0
52 52 1974-07-06 1974-07-13 1974-07-13 0 8 8 0
54 54 1974-07-21 1974-08-03 1974-08-03 0 14 14 0
57 57 1974-08-16 1974-08-25 1974-08-25 0 10 10 0
61 61 1975-06-04 1975-06-15 1975-06-15 0 12 12 0
62 62 1975-06-17 1975-07-16 1975-07-16 0 30 30 0
63 63 1975-07-21 1975-09-12 1975-09-12 0 54 54 0
64 64 1975-09-16 1975-09-24 1975-09-24 0 9 9 0
65 65 1975-09-29 1975-11-02 1975-11-02 0 35 35 0
66 66 1975-11-04 1975-11-14 1975-11-14 0 11 11 0
68 68 1975-11-20 1975-11-26 1975-11-26 0 7 7 0
69 69 1975-12-07 1975-12-30 1975-12-30 0 24 24 0
71 71 1976-01-21 1976-02-11 1976-02-11 0 22 22 0
72 72 1976-02-26 1976-03-14 1976-03-14 0 18 18 0
73 73 1976-03-21 1976-03-31 1976-03-31 0 11 11 0
74 74 1976-04-02 1976-04-13 1976-04-13 0 12 12 0
75 75 1976-04-15 1976-09-24 1976-09-24 0 163 163 0
80 80 1976-11-23 1976-11-27 1976-11-27 0 5 5 0
81 81 1977-04-15 1977-04-25 1977-04-25 0 11 11 0
82 82 1977-05-19 1977-06-09 1977-06-09 0 22 22 0
83 83 1977-06-23 1977-06-27 1977-06-27 0 5 5 0
84 84 1977-07-03 1977-08-15 1977-08-15 0 44 44 0
86 86 1977-09-06 1977-09-24 1977-09-24 0 19 19 0
87 87 1977-09-26 1977-10-07 1977-10-07 0 12 12 0
88 88 1977-10-10 1977-10-31 1977-10-31 0 22 22 0
91 91 1977-11-26 1977-12-05 1977-12-05 0 10 10 0
92 92 1978-05-20 1978-06-28 1978-06-28 0 40 40 0
93 93 1978-06-30 1978-07-30 1978-07-30 0 31 31 0
94 94 1978-08-05 1978-09-27 1978-09-27 0 54 54 0
95 95 1978-09-29 1978-11-18 1978-11-18 0 51 51 0
96 96 1978-11-20 1978-12-06 1978-12-06 0 17 17 0
101 101 1979-06-26 1979-08-07 1979-08-07 0 43 43 0
104 104 1979-08-17 1979-08-22 1979-08-22 0 6 6 0
105 105 1979-08-24 1979-10-07 1979-10-07 0 45 45 0
107 107 1979-10-11 1979-10-24 1979-10-24 0 14 14 0
109 109 1979-11-10 1979-11-17 1979-11-17 0 8 8 0
110 110 1979-11-19 1979-11-25 1979-11-25 0 7 7 0
tqmin
2 1970-05-21
3 1970-06-13
4 1970-06-28
7 1970-07-25
8 1970-08-08
9 1970-08-24
11 1970-09-15
14 1971-05-17
17 1971-05-29
19 1971-07-07
21 1971-09-01
23 1971-09-28
24 1971-10-04
25 1972-01-04
27 1972-06-14
30 1972-07-10
31 1972-07-26
32 1972-08-11
33 1972-09-11
34 1972-10-12
39 1973-05-31
41 1973-07-01
43 1973-07-22
44 1973-08-08
45 1973-12-09
46 1974-04-14
48 1974-05-04
49 1974-05-15
50 1974-06-09
51 1974-06-20
52 1974-07-06
54 1974-07-21
57 1974-08-16
61 1975-06-04
62 1975-06-17
63 1975-07-21
64 1975-09-16
65 1975-09-29
66 1975-11-04
68 1975-11-20
69 1975-12-07
71 1976-01-21
72 1976-02-26
73 1976-03-21
74 1976-04-02
75 1976-04-15
80 1976-11-23
81 1977-04-15
82 1977-05-19
83 1977-06-23
84 1977-07-03
86 1977-09-06
87 1977-09-26
88 1977-10-10
91 1977-11-26
92 1978-05-20
93 1978-06-30
94 1978-08-05
95 1978-09-29
96 1978-11-20
101 1979-06-26
104 1979-08-17
105 1979-08-24
107 1979-10-11
109 1979-11-10
110 1979-11-19
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0.02 864 1
1970-01-02 0.010 0.02 864 1
1970-01-03 0.010 0.02 864 1
1970-01-04 0.005 0.02 1296 1
1970-01-05 0.005 0.02 1296 1
1970-01-06 0.005 0.02 1296 1
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 30 minor events of 92 total.
Only droughts with volume >= 1893.024 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
1 1 1970-01-01 1970-01-08 1970-01-08 9763.2 8 8 0.000
3 3 1970-05-04 1970-05-09 1970-05-09 4147.2 6 6 0.010
4 4 1970-05-13 1970-08-19 1970-08-19 162864.0 99 99 0.000
5 5 1970-08-21 1970-11-06 1970-11-06 128563.2 78 78 0.000
6 6 1970-11-08 1970-11-13 1970-11-13 5702.4 6 6 0.005
7 7 1970-12-19 1970-12-28 1970-12-28 7171.2 10 10 0.009
8 8 1971-04-01 1971-04-22 1971-04-22 25056.0 22 22 0.000
9 9 1971-05-01 1971-06-09 1971-06-09 60048.0 40 40 0.000
12 12 1971-06-23 1971-08-02 1971-08-02 59875.2 41 41 0.000
13 13 1971-08-04 1971-08-10 1971-08-10 5961.6 7 7 0.005
16 16 1971-08-22 1971-10-12 1971-10-12 82684.8 52 52 0.000
18 18 1971-10-24 1971-11-04 1971-11-04 13046.4 12 12 0.005
19 19 1971-11-13 1971-11-17 1971-11-17 3196.8 5 5 0.010
20 20 1971-12-13 1971-12-18 1971-12-18 3628.8 6 6 0.010
21 21 1972-01-04 1972-01-12 1972-01-12 15552.0 9 9 0.000
23 23 1972-04-20 1972-04-28 1972-04-28 7862.4 9 9 0.005
25 25 1972-05-04 1972-05-08 1972-05-08 2851.2 5 5 0.010
26 26 1972-05-17 1972-07-30 1972-07-30 112838.4 75 75 0.000
28 28 1972-08-08 1972-11-11 1972-11-11 160272.0 96 96 0.000
29 29 1972-11-14 1972-11-18 1972-11-18 7084.8 5 5 0.001
30 30 1972-11-22 1972-11-30 1972-11-30 9676.8 9 9 0.005
31 31 1972-12-28 1973-01-14 1973-01-14 15292.8 18 18 0.005
34 34 1973-03-11 1973-04-01 1973-04-01 23846.4 22 22 0.000
36 36 1973-04-05 1973-04-23 1973-04-23 22723.2 19 19 0.000
37 37 1973-04-25 1973-05-03 1973-05-03 7257.6 9 9 0.005
38 38 1973-05-12 1973-06-19 1973-06-19 57801.6 39 39 0.000
39 39 1973-06-21 1973-06-25 1973-06-25 8208.0 5 5 0.000
40 40 1973-06-30 1973-07-05 1973-07-05 8640.0 6 6 0.000
41 41 1973-07-09 1973-07-14 1973-07-14 9676.8 6 6 0.000
42 42 1973-07-21 1973-08-05 1973-08-05 26956.8 16 16 0.000
43 43 1973-08-07 1973-12-20 1973-12-20 232848.0 136 136 0.000
44 44 1974-03-29 1974-06-15 1974-06-15 122601.6 79 79 0.000
45 45 1974-06-18 1974-06-25 1974-06-25 12182.4 8 8 0.000
46 46 1974-06-30 1974-07-15 1974-07-15 23414.4 16 16 0.000
47 47 1974-07-17 1974-08-03 1974-08-03 29808.0 18 18 0.000
48 48 1974-08-06 1974-08-25 1974-08-25 32140.8 20 20 0.000
49 49 1974-08-27 1974-09-01 1974-09-01 8467.2 6 6 0.000
50 50 1974-09-10 1974-09-22 1974-09-22 15811.2 13 13 0.000
55 55 1975-04-25 1975-05-16 1975-05-16 22809.6 22 22 0.005
56 56 1975-05-21 1975-07-16 1975-07-16 92188.8 57 57 0.000
57 57 1975-07-19 1975-12-01 1975-12-01 225331.2 136 136 0.000
58 58 1975-12-03 1976-01-03 1976-01-03 51321.6 32 32 0.000
59 59 1976-01-06 1976-02-11 1976-02-11 57369.6 37 37 0.000
60 60 1976-02-15 1976-09-26 1976-09-26 378604.8 225 225 0.000
61 61 1976-09-28 1976-10-02 1976-10-02 5616.0 5 5 0.000
65 65 1976-10-16 1976-10-28 1976-10-28 12787.2 13 13 0.000
67 67 1976-11-22 1976-11-27 1976-11-27 8985.6 6 6 0.000
68 68 1977-04-14 1977-04-25 1977-04-25 20217.6 12 12 0.000
69 69 1977-05-18 1977-06-09 1977-06-09 39139.2 23 23 0.000
71 71 1977-06-22 1977-06-27 1977-06-27 9676.8 6 6 0.000
72 72 1977-07-02 1977-08-16 1977-08-16 79228.8 46 46 0.000
75 75 1977-09-05 1977-11-01 1977-11-01 97545.6 58 58 0.000
77 77 1977-11-16 1977-11-23 1977-11-23 12009.6 8 8 0.000
78 78 1977-11-25 1977-12-06 1977-12-06 19008.0 12 12 0.000
80 80 1978-05-20 1978-07-30 1978-07-30 124243.2 72 72 0.000
81 81 1978-08-04 1978-12-07 1978-12-07 216345.6 126 126 0.000
83 83 1978-12-18 1978-12-22 1978-12-22 5961.6 5 5 0.000
84 84 1979-01-02 1979-01-06 1979-01-06 6739.2 5 5 0.000
87 87 1979-06-20 1979-08-07 1979-08-07 81475.2 49 49 0.000
88 88 1979-08-09 1979-10-25 1979-10-25 129600.0 78 78 0.000
89 89 1979-10-27 1979-10-31 1979-10-31 8208.0 5 5 0.000
90 90 1979-11-09 1979-11-26 1979-11-26 27648.0 18 18 0.000
tqmin
1 1970-01-07
3 1970-05-06
4 1970-05-21
5 1970-08-24
6 1970-11-10
7 1970-12-27
8 1971-04-21
9 1971-05-11
12 1971-07-02
13 1971-08-08
16 1971-09-01
18 1971-10-28
19 1971-11-15
20 1971-12-16
21 1972-01-04
23 1972-04-25
25 1972-05-07
26 1972-06-07
28 1972-08-11
29 1972-11-17
30 1972-11-25
31 1973-01-12
34 1973-03-29
36 1973-04-17
37 1973-04-28
38 1973-05-27
39 1973-06-22
40 1973-07-01
41 1973-07-10
42 1973-07-22
43 1973-08-08
44 1974-04-14
45 1974-06-20
46 1974-07-06
47 1974-07-19
48 1974-08-07
49 1974-08-29
50 1974-09-19
55 1975-05-01
56 1975-05-31
57 1975-07-21
58 1975-12-07
59 1976-01-16
60 1976-02-26
61 1976-10-01
65 1976-10-17
67 1976-11-23
68 1977-04-15
69 1977-05-19
71 1977-06-23
72 1977-07-03
75 1977-09-06
77 1977-11-17
78 1977-11-26
80 1978-05-20
81 1978-08-05
83 1978-12-19
84 1979-01-04
87 1979-06-22
88 1979-08-10
89 1979-10-28
90 1979-11-10
streamflow defict
data.frame with 6 observations and 1 events
discharge threshold def.increase event.no
1970-01-01 0.010 0 -864 0
1970-01-02 0.010 0 -864 0
1970-01-03 0.010 0 -864 0
1970-01-04 0.005 0 -432 0
1970-01-05 0.005 0 -432 0
1970-01-06 0.005 0 -432 0
Summary of droughts
River: Ray at Grendon Underwood
Units: volumes in m<U+00B3>, duration in days
Filtered 46 minor events of 112 total.
Only droughts with volume >= 0 m<U+00B3> and duration >= 5 days are reported.
event.no start time end volume duration dbt qmin
2 2 1970-05-21 1970-06-10 1970-06-10 0 21 21 0
3 3 1970-06-13 1970-06-26 1970-06-26 0 14 14 0
4 4 1970-06-28 1970-07-13 1970-07-13 0 16 16 0
7 7 1970-07-25 1970-08-05 1970-08-05 0 12 12 0
8 8 1970-08-08 1970-08-18 1970-08-18 0 11 11 0
9 9 1970-08-24 1970-09-08 1970-09-08 0 16 16 0
11 11 1970-09-15 1970-10-31 1970-10-31 0 47 47 0
14 14 1971-05-17 1971-05-22 1971-05-22 0 6 6 0
17 17 1971-05-29 1971-06-07 1971-06-07 0 10 10 0
19 19 1971-07-07 1971-07-23 1971-07-23 0 17 17 0
21 21 1971-09-01 1971-09-23 1971-09-23 0 23 23 0
23 23 1971-09-28 1971-10-02 1971-10-02 0 5 5 0
24 24 1971-10-04 1971-10-11 1971-10-11 0 8 8 0
25 25 1972-01-04 1972-01-12 1972-01-12 0 9 9 0
27 27 1972-06-14 1972-06-26 1972-06-26 0 13 13 0
30 30 1972-07-10 1972-07-21 1972-07-21 0 12 12 0
31 31 1972-07-26 1972-07-30 1972-07-30 0 5 5 0
32 32 1972-08-11 1972-09-07 1972-09-07 0 28 28 0
33 33 1972-09-11 1972-10-09 1972-10-09 0 29 29 0
34 34 1972-10-12 1972-11-06 1972-11-06 0 26 26 0
39 39 1973-05-31 1973-06-18 1973-06-18 0 19 19 0
41 41 1973-07-01 1973-07-05 1973-07-05 0 5 5 0
43 43 1973-07-22 1973-08-04 1973-08-04 0 14 14 0
44 44 1973-08-08 1973-12-07 1973-12-07 0 122 122 0
45 45 1973-12-09 1973-12-20 1973-12-20 0 12 12 0
46 46 1974-04-14 1974-04-27 1974-04-27 0 14 14 0
48 48 1974-05-04 1974-05-10 1974-05-10 0 7 7 0
49 49 1974-05-15 1974-06-07 1974-06-07 0 24 24 0
50 50 1974-06-09 1974-06-15 1974-06-15 0 7 7 0
51 51 1974-06-20 1974-06-25 1974-06-25 0 6 6 0
52 52 1974-07-06 1974-07-13 1974-07-13 0 8 8 0
54 54 1974-07-21 1974-08-03 1974-08-03 0 14 14 0
57 57 1974-08-16 1974-08-25 1974-08-25 0 10 10 0
61 61 1975-06-04 1975-06-15 1975-06-15 0 12 12 0
62 62 1975-06-17 1975-07-16 1975-07-16 0 30 30 0
63 63 1975-07-21 1975-09-12 1975-09-12 0 54 54 0
64 64 1975-09-16 1975-09-24 1975-09-24 0 9 9 0
65 65 1975-09-29 1975-11-02 1975-11-02 0 35 35 0
66 66 1975-11-04 1975-11-14 1975-11-14 0 11 11 0
68 68 1975-11-20 1975-11-26 1975-11-26 0 7 7 0
69 69 1975-12-07 1975-12-30 1975-12-30 0 24 24 0
71 71 1976-01-21 1976-02-11 1976-02-11 0 22 22 0
72 72 1976-02-26 1976-03-14 1976-03-14 0 18 18 0
73 73 1976-03-21 1976-03-31 1976-03-31 0 11 11 0
74 74 1976-04-02 1976-04-13 1976-04-13 0 12 12 0
75 75 1976-04-15 1976-09-24 1976-09-24 0 163 163 0
80 80 1976-11-23 1976-11-27 1976-11-27 0 5 5 0
81 81 1977-04-15 1977-04-25 1977-04-25 0 11 11 0
82 82 1977-05-19 1977-06-09 1977-06-09 0 22 22 0
83 83 1977-06-23 1977-06-27 1977-06-27 0 5 5 0
84 84 1977-07-03 1977-08-15 1977-08-15 0 44 44 0
86 86 1977-09-06 1977-09-24 1977-09-24 0 19 19 0
87 87 1977-09-26 1977-10-07 1977-10-07 0 12 12 0
88 88 1977-10-10 1977-10-31 1977-10-31 0 22 22 0
91 91 1977-11-26 1977-12-05 1977-12-05 0 10 10 0
92 92 1978-05-20 1978-06-28 1978-06-28 0 40 40 0
93 93 1978-06-30 1978-07-30 1978-07-30 0 31 31 0
94 94 1978-08-05 1978-09-27 1978-09-27 0 54 54 0
95 95 1978-09-29 1978-11-18 1978-11-18 0 51 51 0
96 96 1978-11-20 1978-12-06 1978-12-06 0 17 17 0
101 101 1979-06-26 1979-08-07 1979-08-07 0 43 43 0
104 104 1979-08-17 1979-08-22 1979-08-22 0 6 6 0
105 105 1979-08-24 1979-10-07 1979-10-07 0 45 45 0
107 107 1979-10-11 1979-10-24 1979-10-24 0 14 14 0
109 109 1979-11-10 1979-11-17 1979-11-17 0 8 8 0
110 110 1979-11-19 1979-11-25 1979-11-25 0 7 7 0
tqmin
2 1970-05-21
3 1970-06-13
4 1970-06-28
7 1970-07-25
8 1970-08-08
9 1970-08-24
11 1970-09-15
14 1971-05-17
17 1971-05-29
19 1971-07-07
21 1971-09-01
23 1971-09-28
24 1971-10-04
25 1972-01-04
27 1972-06-14
30 1972-07-10
31 1972-07-26
32 1972-08-11
33 1972-09-11
34 1972-10-12
39 1973-05-31
41 1973-07-01
43 1973-07-22
44 1973-08-08
45 1973-12-09
46 1974-04-14
48 1974-05-04
49 1974-05-15
50 1974-06-09
51 1974-06-20
52 1974-07-06
54 1974-07-21
57 1974-08-16
61 1975-06-04
62 1975-06-17
63 1975-07-21
64 1975-09-16
65 1975-09-29
66 1975-11-04
68 1975-11-20
69 1975-12-07
71 1976-01-21
72 1976-02-26
73 1976-03-21
74 1976-04-02
75 1976-04-15
80 1976-11-23
81 1977-04-15
82 1977-05-19
83 1977-06-23
84 1977-07-03
86 1977-09-06
87 1977-09-26
88 1977-10-10
91 1977-11-26
92 1978-05-20
93 1978-06-30
94 1978-08-05
95 1978-09-29
96 1978-11-20
101 1979-06-26
104 1979-08-17
105 1979-08-24
107 1979-10-11
109 1979-11-10
110 1979-11-19
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.