aggregate_network_to_distribution: Aggregate Network to Distribution

In NOAA-OWP/hyAggregate: Hydrologic and Hydrographic Network Aggregating Tools Based on HY_Features

Aggregate Network to Distribution

Description

This function aggregated a network to a desired size distribution while enforcing minimum flowpath legnths and catchment area. Addtionally a set of explicit nexus locations can be provided over which the netwrok cannot be aggregated.

Usage

aggregate_network_to_distribution(
  gpkg = NULL,
  catchment_name = "refactored_divides",
  flowpath_name = "refactored_flowpaths",
  ideal_size_sqkm = 10,
  min_length_km = 1,
  min_area_sqkm = 3,
  nexus_topology = TRUE,
  routelink_path = NULL,
  nexus_locations = NULL,
  outfile = NULL,
  log = TRUE,
  overwrite = FALSE,
  cache_file = NULL
)

Arguments

ideal_size_sqkm	The ideal size of catchments (default = 10 sqkm)
min_length_km	The minimum allowable length of flowpath features (default = 1 km)
min_area_sqkm	The minimum allowable area of catchment features (default = 3 sqkm)
nexus_topology	should a hy-features cat–>nex topology be enforced? default = TRUE
nexus_locations	a data.frame with columns specifiying the ID, and the nexus type.
outfile	of not NULL, where to write the output files
log	a filepath to write to or booleen (TRUE = print to console; FALSE = no messages)
overwrite	overwrite existing gf file. Default is FALSE
gf	A path to a hydrofabric file (see US reference fabric)
verbose	print status updates. Default = TRUE

Value

if outfile = TRUE, a file path, else a list object

NOAA-OWP/hyAggregate documentation built on Aug. 13, 2022, 1:36 p.m.