nhdplusTools (version 0.3.8)

navigate_nldi: Navigate NLDI

Description

Navigate the Network Linked Data Index network.

Usage

navigate_nldi(nldi_feature, mode = "upstreamMain",
  data_source = "comid", distance_km = NULL, tier = "prod")

Arguments

nldi_feature

list with names `featureSource` and `featureID` where `featureSource` is derived from the "source" column of the response of discover_nldi_sources() and the `featureSource` is a known identifier from the specified `featureSource`.

mode

character chosen from names, URLs, or url parameters returned by discover_nldi_navigation(nldi_feature). See examples.

data_source

character chosen from "source" column of the response of discover_nldi_sources() or empty string for flowline geometry.

distance_km

numeric distance in km to stop navigating.

tier

character optional "prod" or "test"

Value

sf data.frame with result

Examples

# NOT RUN {
library(sf)
library(dplyr)

nldi_nwis <- list(featureSource = "nwissite", featureID = "USGS-05428500")

navigate_nldi(nldi_feature = nldi_nwis,
              mode = "upstreamTributaries",
              data_source = "") %>%
  st_geometry() %>%
  plot()

navigate_nldi(nldi_feature = nldi_nwis,
              mode = "UM",
              data_source = "") %>%
  st_geometry() %>%
  plot(col = "blue", add = TRUE)



nwissite <- navigate_nldi(nldi_feature = nldi_nwis,
                          mode = "UT",
                          data_source = "nwissite")

st_geometry(nwissite) %>%
  plot(col = "green", add = TRUE)

nwissite
# }
# NOT RUN {
# }