discharge (version 1.0.0)

getHSAF: High Spectral Anomaly Frequency (HSAF)

Description

Compute High Spectral Anomaly Frequency (HSAF) from the given residual values.

Usage

getHSAF(resid, years, for.year = NULL)

Arguments

resid

A vector of residual values generated with respect to the baseline signal

years

A vector of years corrosponding to the residual values

for.year

(optional) Calculate HSAF values only for the given year in this argument. If argument is omitted, HSAF values for all years are calculated.

Value

Data frame containing two Columns:

year	First column, represents year

Examples

# NOT RUN {
# load sample data
data("sycamore")
x = sycamore

# get streamflow object for the sample data
x.streamflow = asStreamflow(x)

# prepare baseline signal 
x.bl = prepareBaseline(x.streamflow)

# HSAF
hsaf = getHSAF(x.bl$resid.sig, x.streamflow$data$year)

# }