Mike Johnson is now recognized as an author of nhdplusTools.

New citation:

> citation("nhdplusTools")

To cite nhdplusTools in publications, please use:

  Blodgett, D., Johnson, J.M., 2022, nhdplusTools: Tools for Accessing and
  Working with the NHDPlus, https://doi.org/10.5066/P97AS8JD

New Functions

Improvements

  • get_flowline_index() and get_waterbody_index() units and projection handling was altered. Defaults for the search_radius input were changed. Coordinate reference system handling in geoprocessing now relies on the CRS of the provided points rather than the flowlines.
  • get_nldi_basin() now supports precise basin delineation via a logical “split” parameter as well as the option to retrieve un-simplified basin geometry.
  • All network-dependent functions in nhdplusTools now return a warning and NULL if the web servicee is unavailable or fails for other reasons. This is according to CRAN policy.

This is a very minor release required by CRAN checks.

Some scalability issues in plot_nhdplus() were identified and fixed.

Documentation updates

  • A new “advanced network attributes” vignette was added.
  • All vignettes were revisited to ensure they are up to date.
  • The introduction vignette is now very brief with links to others.

Web Service Wrapper Functions

Utility Functions

  • New functions st_compatibalize() and rename_geometry() provide utility functionality to make two layers compatible, including projection and rename geometry columns respectively.

  • New function get_sorted() generates a sorted and optionally partitioned version of a dendritic tree.

Subsetting and data utilities

  • New function subset_vpu() wraps subset_rpu() and will subset a vector procesing unit.
  • New function fix_flowdir() will re-order geometry nodes such that their order cooresponds to the convention used in nhdplus data.
  • get_vaa() will now return an updated nhdplus network attribute set derived from multiple improved sources.

Network Navigation and Attributes

  • New function navigate_network() provides a wrapper around a number of network navigation capabilities and will support local or web service data.
  • New function get_tocomid() encapsulates a suite of functionality for converting edge node network representations to edge list format.
  • New function get_path_lengths() finds network distances between pairs of points.
  • New function get_partial_length() finds flowpath length up and downstream of a hydrologic location.

Plotting

  • plot_nhdplus() now includes on network and off network waterbodies.
  • New function get_wb_outlet() finds the outlet flowline of an on-network waterbody. This function works for both nhdplusV2 and hires.

Package Internals

  • nhdplusTools testing has been updated to use testthat edition 3.
  • All terminal “toID” values are 0 rather than NA to avoid confusion with a mix of both.
  • igraph package is no longer a dependency. All graph algorithms have been implemented in base R for performance and simplicity.
  • Many package functions have been converted to use lowercase attributes. Attribute naming is settling into two modes – ID, toID, and lowercase otherwise – and comid, tocomid, and lowercase. The ID syntax is meant to be a temporary ID while comid is meant to be some external identifier that should be treated as such.
  • The master branch was renamed main.
  • New function added: get_streamlevel() calculates stream level, a bottom up level path order used by nhdplus to categorize complete river levels.

  • nhdplusTools internals have started to be refactored to use all lower case attribute names. No changes should be seen from outside the package, but please report issues with attribute naming.

  • Package testing now runs in parallel and uses revision 3 of the testthat package.

Version 0.4.2 further cleans up temporary and cache data functionality for CRAN policy.

New functionality was added to indexing functionality.

  • When multiple flowlines are returned, disambiguate_flowline_indexes() supports for disambiguating them based on numeric or text attributes that should match. This functionality is not heavily tested, but forms a basis for expansion of this functionality going forward.
  • A function to find the point location of a flowline index, get_hydro_location() was added. It will return point geometry given a geometry identifier and measure along that identifier.

Version 0.4.1 is a minor release with bug fixes and updates for CRAN policy.

A noteable addition is handling for strictly dendritic topology encoded using a “tocomid” attribute rather than “fromnode” and “tonode” attributes. This functionality was added in subsetting functions and is backward compatible with previous versions.

Version 0.4.0 adds new functionality for data access via web services and updates the usability and flexibility of data discovery and subsetting functions. This release includes significant rework of functions related to network navigation and web-service data subsetting.

  • Previsouly, subset_nhdplus() included internal functionality for downloading data via web service. This code for subsetting NHDPlus via web service was completely rewritten and a number of new web-service data access functions were added. The get_nhdplus() function has been added and is for web-service data access only. subset_nhdplus(), which will output a subset to a local .gpkg file, now uses get_nhdplus() for download functionality.
  • navigate_nldi() and most other NLDI functions are now based on an NLDI client in the dataRetrieval package. Functionality has been maintained backward compatible with nhdplusTools v0.3 as much as possible with some minor modifications to accomadate changes in dataRetrieval. The response format from navigate_nldi() has been changed slightly in v0.4, it now includes both the origin feature and navigation type(s) as a list. Two un-needed nldi discovery functions were removed.
  • Functions to download and cache all NHDPlus VAAs (in a 195mb .fst file) for use in network navigation and other applications have been added. These can be used with any nhdplusTools functions that do not require geometry.
  • get_levelpaths() now has an override_factor parameter that will cause stream leveling to follow the weight rather than the name input if the weight is override_factor times larger than the name indication.

Functions Added * get_nhdplus() * get_nhdarea() * get_waterbodies() * get_gagesII() * get_huc12() * get_huc8() * download_vaa() * get_vaa() * get_vaa_names() * get_vaa_path()

Functions Removed * discover_nldi_navigation() * discover_nldi_sources()

Functions Deprecated * stage_national_data()

Functions with Consolodated Internals * discover_nhdplus_id() * get_nldi_basin() * get_nldi_feature() * subset_nhdplus() * plot_nhdplus()

Finally, the handling of data and caching in the package has been overhauled. These changes are non-functional, but aim to decrease data downloads by caching rather than using temp directories.

  • Added get_node() to get top and bottom of a flowline.
  • Switched geospatial data dependency to use labs.waterdata.usgs.gov
  • Added subset_rpu() to enable subsetting the NHD by Raster Processing Unit
  • Added get_waterbody_index() to find associations between point locations and waterbodys.
  • Added ability to get multiple matches from get_flowline_index() with max_matches parameter.
  • Added ability to download flowlines in get_flowline_index() rather than requiring data to be loaded locally.
  • tested with dplyr 1.0 and sf 0.9.
  • Added plot_nhdplus() with both outlet-based and bbox based data subsetting as well as rudimentary style modification capabilities.
  • Implemented stream order and Pfafstetter code generators (get_streamorder() and get_pfaf()) for dendritic networks.
  • subset_nhdplus() can now return data without writing a file to disk.
  • NLDI feature specification is more flexible, doesn’t require names anymore.
  • get_nhdplushr() has been updated to modify terminal path and other identifiers making nhdplusHR subsets “stand alone”. A function make_standalone() is now exported.
  • Added get_terminal() and get_pathlength() functions to generate nhdplus network attributes.
  • Updated link to NHDPlusHR data
  • Empty tibble rather than NULL response from empty NLDI result
  • Slides from AWRA National 2019, link in README
  • Added name alignment function
  • Added ability to sort response of network navigation
  • Added downloader functions for more hydrography datasets
  • Change navigations to exclude requested catchment
  • Modified vignettes and examples to avoid web-service calls breaking CRAN build.
  • Added error handling to some web service requests.
  • Added CITATION and NEWS.
  • First CRAN release!