FlowScreen (version 1.2.6)

Qn: Calculate flow quantiles

Description

This function calculates flow quantiles by hydrologic year, calendar year, month, or doy.

Usage

Qn(TS, n = 0.1, by = "hyear")

Arguments

TS

output from create.ts containing a data.frame of flow time series

n

Numeric value of the quantile. Default is 0.1.

by

Character string indicating time unit to summarize by. Default is "hyear" for hydrologic year, see create.ts. Other options are "year" for calendar year, "month", or "doy" for day of year.

Value

Returns a numeric vector of the calculated flow quantile for the time periods indicated with the "by" argument. The "times" attribute contains the hydrologic year, calendar year, month, or day of year for each data point.

Examples

# NOT RUN {
data(cania.sub.ts)

# 50% quantile, i.e. mean, by calendar year
res <- Qn(cania.sub.ts, n=0.5, by="year")
res2 <- screen.metric(res, "Q (m3/s)")

# Default 10% quantile, by hydrologic year
res <- Qn(cania.sub.ts)
res2 <- screen.metric(res, "Q (m3/s)")
# }