lagtime: Lag time estimation

View source: R/lagtime.R

lagtimeR Documentation

Lag time estimation

Description

Estimate the lag time of the catchment.

Usage

lagtime(hl, ...)

## Default S3 method:
lagtime(hl, uc, ...)

## S3 method for class 'units'
lagtime(hl, uc, method = 1, ...)

## S3 method for class 'stars'
lagtime(hl, ...)

## S3 method for class 'transfR'
lagtime(hl, verbose = TRUE, ...)

Arguments

hl

hydraulic length of class transfR or stars or matrix or vector. If no unit is provided, hl is assumed to be in [m].

...

further arguments passed to or from other methods

uc

streamflow velocity. If no unit is provided, uc is assumed to be in [m/s].

method

integer describing the method to use for lag time estimation. Possible values: 1 (see details).

verbose

boolean indicating if information messages should be written to the console.

Details

The function estimates the lag time of the catchment. It can be used to estimate one of the inputs of the function rapriori. If method is 1, the lag time is estimated from the ratio of the mean hydraulic length (hl) and the average streamflow velocity (uc).

Value

A numeric value of class units, or if hl is a transfR object, the same transfR object incremented by the "lagtime" attribute.

Examples

data(Oudon)
icatch <- 1
lagtime(Oudon$hl[[icatch]], uc = units::set_units(0.5, "m/s"))

transfR documentation built on Jan. 23, 2023, 5:36 p.m.