CTF {hydrostats} | R Documentation |
Cease-to-flow (CTF) spell statistics
Description
Calculates summary statistics describing cease-to-flow spell characteristics.
Usage
CTF(flow.ts, threshold = 0.1)
Arguments
flow.ts |
Dataframe with date and discharge data in columns named "Date" and "Q" respectively. Date must be in POSIX format (see ts.format). |
threshold |
values below this threshold (default 0.1) are treated as zero for the purpose of defining cease to flow spells to account for the fact that cease to flow levels are poorly defined for many gauging sites. |
Value
A dataframe with 5 columns (see below).
p.CTF |
Proportion time cease to flows occur |
avg.CTF |
Average cease-to-flow spell duration |
med.CTF |
Median cease-to-flow spell duration |
min.CTF |
Minimum cease-to-flow spell duration |
max.CTF |
Maximum cease-to-flow spell duration |
Author(s)
Nick Bond <n.bond@latrobe.edu.au>
Examples
data(Cooper)
Cooper<-ts.format(Cooper)
CTF(Cooper)
CTF(Cooper, threshold=0)
[Package hydrostats version 0.2.9 Index]