collapse_headwaters: Collapse Headwaters

View source: R/aggregation.R

collapse_headwatersR Documentation

Collapse Headwaters

Description

This function identifies small (pathlength or area) headwater catchments and collapses them into the existing network until none remain. Headwaters are those segments in which there are no inflows (!ID %in% toID).

Usage

collapse_headwaters(
  network_list,
  min_area_sqkm = 3,
  min_length_km = 1,
  verbose = TRUE,
  cache_file = NULL
)

Arguments

network_list

a list containing flowpath and catchment sf objects

min_area_sqkm

The minimum allowable size of the output hydrofabric catchments

min_length_km

The minimum allowable length of the output hydrofabric flowlines

verbose

should messages be emitted?

cache_file

If not NULL results will be written to a provide path (.gpkg)

Value

a list containing flowpath and catchment sf objects


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