navigate_network: Navigate Network

In nhdplusTools: NHDPlus Tools

Navigate Network

Description

Provides a full feature network navigation function that will work with local or web service data. Parameter details provide context.

Usage

navigate_network(
  start,
  mode = "UM",
  network = NULL,
  output = "flowlines",
  distance_km = 10,
  trim_start = FALSE,
  trim_stop = FALSE,
  trim_tolerance = 5
)

Arguments

start	list, integer, sf, or sfc if list must be a valid NLDI feature if integer must be a valid comid. If sf, must contain a "comid" field.
mode	character chosen from c(UM, DM, UT, or DD)
network	sf should be compatible with network navigation functions If NULL, network will be derived from requests to the NLDI
output	character flowline or a valid NLDI data source
distance_km	numeric distance to navigate in km
trim_start	logical should start be trimmed or include entire catchment?
trim_stop	logical should stop(s) be trimmed or include entire catchment(s)? # Not supported
trim_tolerance	numeric from 0 to 100 percent of flowline length. If amount to trim is less than this tolerance, no trim will be applied.

Examples

navigate_network(list(featureSource = "nwissite", featureID = "USGS-06287800"),
                "UM",
                output = "flowlines",
                trim_start = TRUE)


source(system.file("extdata", "walker_data.R", package = "nhdplusTools"))
hydro_location <- list(comid = 5329339,
                      reachcode = "18050005000078",
                       reach_meas = 30)

hydro_location <- sf::st_sf(
  hydro_location,
  geom = nhdplusTools::get_hydro_location(data.frame(hydro_location),
                                          walker_flowline))

net <- navigate_network(hydro_location,
                       mode = "DM", network = walker_flowline,
                       trim_start = TRUE, distance_km = 20)

plot(sf::st_geometry(walker_flowline))
plot(sf::st_geometry(hydro_location), add = TRUE)
plot(sf::st_geometry(net), add = TRUE, col = "blue", lwd = 2)

nhdplusTools documentation built on June 22, 2024, 10:36 a.m.