ratio {hydropeak}

RATIO - Flow Ratio (Metric 5)

Description

The metric flow ratio (RATIO) is defined as the flow maximum divided by the flow minimum, \frac{Q_{max}}{Q_{min}}. Given an event with equal flow trend, the flow ratio is computed and returned.

Usage

ratio(x, event_type)

Arguments

x

Data frame (time series) from an event with equal flow trend. The data frame must contain a date-time column (Time) and a flow rate column (Q) and must be in a compatible format. (see flow()).

event_type

Numeric value which specifies the event type. See get_events() for an overview of the event types.

Value

Returns a numeric value which is the flow ratio computed by max(x$Q) divided by min(x$Q). If a data frame containing NA flow rates (Q) is given, NA is returned.

Examples

data(Q)
Q <- flow(Q[3:4, ])
ratio(Q, event_type(Q))