Skip to contents

Computes the return discharge value for a given time series and return period, based on the specified hydrological regime (low or high waters).

Usage

get_Xn(X, returnPeriod, waterType = "low", Date = NULL, period = NULL)

Arguments

X

Numeric vector of flow values.

returnPeriod

Numeric value of the return period.

waterType

Character string, either 'low' for log-normal estimation or 'high' for Gumbel-based estimation.

Date

Optional vector of dates corresponding to the flow values.

period

Optional length-2 vector specifying the start and end of the period to consider (must match class of Date).

Value

Numeric value of the estimated discharge for the given return period.