compute_network_length: Computes the maximum upstream network length

View source: R/compute_network_length.R

compute_network_lengthR Documentation

Computes the maximum upstream network length

Description

Function returns the maximum length of upstream river network for each river segment in the network.

Usage

compute_network_length(HS, values, output_col = NULL, verbose = FALSE)

Arguments

HS

a HS object obtained passed through river_network.

values

A vector of values to be aggregated, or a name of the column in HS storing the values. If the input is a units object, the unit is preserved.

output_col

Column name in HS where the collected values will be stored. if NULL, the function returns the collected values as a vector.

verbose

Whether or not print progress indicators.

Value

A vector of the collected stats, or the input HS with a specified column storing the vector.


mkkallio/hydrostreamer documentation built on Oct. 14, 2023, 9:38 p.m.