discharge (version 1.0.0)

getIFI: Inter-Flood Interval (IFI)

Description

Compute Inter-Flood Interval (IFI) from the given residual values.

Usage

getIFI(resid, years, lowflow.start, lowflow.end, unique.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

lowflow.start

A vector giving start index of low-flow window in each year

lowflow.end

A vector giving end index of low-flow window in each year

unique.years

A vector or year values corresponding to the highflow.start and highflow.end values.

for.year

(optional) Calculate IFI values only for the given year in this argument. If argument is omitted, IFI 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)

# signal parts
x.sp = getSignalParts(x.bl$pred2, candmin = c(40:125), candmax = c(190:330),
                      years = x.streamflow$data$year, 
                      months = x.streamflow$data$month,
                      jdays = x.streamflow$data$jday)

# IFI
ifi = getIFI(x.bl$resid.sig, x.streamflow$data$year, x.sp$LF.window.start, 
             x.sp$LF.window.end, x.sp$year)

# }