aggregate_network_to_distribution: Aggregate Network

View source: R/aggregation.R

aggregate_network_to_distributionR Documentation

Aggregate Network

Description

Aggregate Network

Usage

aggregate_network_to_distribution(
  gf = NULL,
  flowpaths = NULL,
  catchments = NULL,
  ideal_size_sqkm = 10,
  min_length_km = 1,
  min_area_sqkm = 3,
  outfile = NULL,
  verbose = TRUE,
  overwrite = FALSE,
  nexus_topology = TRUE,
  routelink_path = NULL
)

Arguments

gf

A path to a refactored geofarbric file (see US reference fabric)

flowpaths

an sf object

catchments

an sf object

ideal_size_sqkm

The ideal size of catchments (default = 10 sqkm)

min_length_km

The minimum allowable length of flowpaths (default = 1 km)

min_area_sqkm

The minimum allowable size of catchments (default = 3 sqkm)

outfile

of not NULL, where to write the output files

verbose

print status updates. Default = TRUE

overwrite

overwrite existing gf file. Default is FALSE

nexus_topology

should a hy-features cat–>nex topology be enforced? default = TRUE

Value

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


mikejohnson51/hyAggregate documentation built on July 1, 2022, 2:42 p.m.