getLSAF {discharge}R Documentation

Low Spectral Anomaly Frequency (LSAF)

Description

Compute Low Spectral Anomaly Frequency (LSAF) from the given residual values.

Usage

getLSAF(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 LSAF values only for the given year in this argument. If argument is omitted, LSAF values for all years are calculated.

Value

Data frame containing two Columns:

year First column, represents year
LSAF Second column, represents LSAF values

Examples

# 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)

# LSAF
lsaf = getLSAF(x.bl$resid.sig, x.streamflow$data$year)


[Package discharge version 1.0.0 Index]