Compute and add the hydrosequence to a directed acyclic network — get_hydroseq • hfutils

Compute and add the hydrosequence to a directed acyclic network

Usage

get_hydroseq(x, id = "flowpath_id", toid = "flowpath_toid")

Arguments

x: A data frame (or tibble) containing at least the identifier column given by `id` and the downstream pointer column given by `toid`.
id: Character scalar. Column name in `x` with unique node identifiers. Defaults to `"flowpath_id"`.
toid: Character scalar. Column name in `x` with the *downstream* node identifier for each row. Use `NA` or `0` for outlets/terminals. Defaults to `"flowpath_toid"`.

Value

A numeric vector of hydrosequence values aligned to the rows of `x` (largest values upstream, decreasing downstream).

See also

Other network properties: accumulate_downstream(), get_levelpath(), get_pathlength(), get_pfafstetter(), get_streamlevel(), get_streamorder(), hf_upstream_index(), merge_groups(), upstream_index()

Examples

# 1 -> 2 -> 3 (outlet). Headwater "1" gets the largest hydroseq.
df <- data.frame(
  flowpath_id   = c("1", "2", "3"),
  flowpath_toid = c("2", "3", "0")
)
get_hydroseq(df)
#> [1] 2 1 3