river_net: Create a 'river_net' object
In aarkilanian/dci: Calculate the Dendritic Connectivity in River Networks

river_net

R Documentation

Create a `river_net` object

Description

river_net is a geospatial network structure of river data. It extends the tidy representation of geospatial network data from the sfnetwork data structure.

Usage

river_net(
  rivers,
  barriers,
  outlet,
  poi = NULL,
  invasions = NULL,
  check = TRUE,
  tolerance = NULL
)

Arguments

`rivers`	A `rivers` object returned by `import_rivers`.
`barriers`	A `barriers` object returned by `import_points`.
`outlet`	A `outlet` object returned by `import_points`.
`poi`	A `poi` object (points of interest) returned by `import_points`. This data is optional.
`invasions`	A `invasions` object returned by `import_points`. This data is optional
`check`	A logical value, if `TRUE`, the default, dendritic topology of the river network is enforced with `enforce_dendritic`.
`tolerance`	A numeric value specifying the distance in map units that points should be snapped to rivers. Set to NULL by default.

Value

An object of class river_net representing the river network formed by the geospatial lines and points provided.

Examples

## Not run:  river_net(rivers = river_data, barriers = barrier_data, outlet = outlet_data)
## Not run:  river_net(river_data, barrier_data, outlet_data, poi = extra_data)
## Not run:  river_net(river_data, barrier_data, outlet_data, tolerance = 15

aarkilanian/dci documentation built on Feb. 5, 2024, 7:12 p.m.