compute_hydrological_signatures: Computes a reference discharge

View source: R/compute_hydrological_signatures.R

compute_hydrological_signaturesR Documentation

Computes a reference discharge

Description

Function returns the river network consisting of all upstream segments from the specified river segment.

Usage

compute_hydrological_signatures(
  HS,
  fun = mean,
  timeseries = "discharge",
  output_col = NULL,
  verbose = FALSE,
  ...
)

Arguments

HS

a HS object obtained passed through river_network.

fun

Function applied to the collected values upstream. The function must take na.rm argument.

timeseries

Which timeseries to apply f to. Eithr "runoff", "discharge", "observation", or "control".

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.

...

Additional arguments passed to fun.

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.