getFPExt {discharge}

Flood Pulse Extent (FPExt)

Description

Calculate the Flood Pulse Extent (FPExt) from the given residual values.

Usage

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

Value

Data frame containing two columns:

year	First column, represents year
FPExt	Second column, represents FPExt 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)

# FPExt
fpext = getFPExt(x.bl$resid.sig, x.streamflow$data$year)