Skip to contents

Get the nexus registry from a decomposition

Source: R/decompose_network.R
get_nexus_registry.Rd

Returns decomposition$nexus_registry – the table that records each synthetic hydro nexus produced by decompose_network() and which domains it connects. One row per nexus; the columns are nexus_id, from_domain_id, and to_domain_id (NA at basin outlets where no downstream domain receives the handoff).

Usage

get_nexus_registry(decomposition)

Arguments

decomposition

object of class domain_decomposition.

Value

data.frame.

See also

domain_decomposition, get_domain_graph().

Examples

g <- sf::read_sf(system.file("extdata/walker.gpkg", package = "hydroloom"))

h <- hy(g) |>
  add_toids() |>
  add_levelpaths(name_attribute = "GNIS_ID",
    weight_attribute = "arbolate_sum")

d <- decompose_network(h)

head(get_nexus_registry(d))
#>            nexus_id         from_domain_id to_domain_id
#> 1 nx_5329303_outlet domain_5329303_5329303         <NA>