v1.0.0 should be backward compatible with v0.7 but deprecation warnings have been added and one previously deprecated function has been removed.
This release evolves
nhdplusTools to use
hydroloom as a core dependency.
nhdplusTools now depends on
hydroloom for all network navigation and indexing functionality that is not specific to the nhdplus data model or specific to a US-context.
Specific functions imported from
With these functions migrated to hydroloom, a number of
nhdplusTools functions are now deprecated in favor of the
In v1.0.0, the
download_nhd() function was added.
In v1.0.0, the stage_national_data (previously deprecated) function was removed.
This release adds three new functions.
These functions are designed to provide access to:
Wieczorek, M.E., Jackson, S.E., and Schwarz, G.E., 2018, Select Attributes for NHDPlus Version 2.1 Reach Catchments and Modified Network Routed Upstream Watersheds for the Conterminous United States (ver. 3.0, January 2021): U.S. Geological Survey data release, .
No functional changes. Package migrated to new repository: https://github.com/DOI-USGS/nhdplusTools
navigate_nldithe “origin” will always be named as such rather than the named 1-element list being dropped to a data.frame. https://github.com/DOI-USGS/dataRetrieval/issues/623
Note v0.5.4 was burned in a CRAN release mistake
fixes a cran test failure in an example and an issue with precision of
v0.5.3 is primarily bug fixes and enhancements.
One notable addition is the addition of the
vpu_boundaries datasets which provide simplified polygons around the RPU and VPU subset domains of the nhdplusV2 dataset.
Mike Johnson is now recognized as an author of
> 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
get_waterbody_index()units and projection handling was altered. Defaults for the
search_radiusinput 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.
nhdplusToolsnow 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.
get_split_catchment()use a web service to access elevation data and retireve a raindrop trace path to the nearest flowline in nhdplus V2 and a split catchment or basin to a precise point location respectively.
get_elev_along_path()access an elevation data service from the 3D Elevation Program and return cross section / path elevation data.
subset_rpu()and will subset a vector procesing unit.
fix_flowdir()will re-order geometry nodes such that their order corresponds to the convention used in nhdplus data.
get_vaa()will now return an updated nhdplus network attribute set derived from multiple improved sources.
navigate_network()provides a wrapper around a number of network navigation capabilities and will support local or web service data.
get_tocomid()encapsulates a suite of functionality for converting edge node network representations to edge list format.
get_path_lengths()finds network distances between pairs of points.
get_partial_length()finds flowpath length up and downstream of a hydrologic location.
igraphpackage is no longer a dependency. All graph algorithms have been implemented in base R for performance and simplicity.
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.
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.
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.
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
.gpkgfile, now uses
get_nhdplus()for download functionality.
navigate_nldi()and most other NLDI functions are now based on an NLDI client in the
dataRetrievalpackage. Functionality has been maintained backward compatible with
nhdplusToolsv0.3 as much as possible with some minor modifications to accommodate 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.
.fstfile) 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_factorparameter that will cause stream leveling to follow the weight rather than the name input if the weight is
override_factortimes larger than the name indication.
Functions Removed *
Functions Deprecated *
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.
navigate_nldi()to use the new NLDI navigation end point. Distance is now required.
get_flowline_index()to handle multipart lines.
plot_nhdplus()to improve scalability
subset_nhdplus()for download filtering.
plot_nhdplus()updated to improve scalability of large downloads.
get_node()to get top and bottom of a flowline.
subset_rpu()to enable subsetting the NHD by Raster Processing Unit
get_waterbody_index()to find associations between point locations and waterbodys.
get_flowline_index()rather than requiring data to be loaded locally.
plot_nhdplus()with both outlet-based and bbox based data subsetting as well as rudimentary style modification capabilities.
get_pfaf()) for dendritic networks.
subset_nhdplus()can now return data without writing a file to disk.
get_nhdplushr()has been updated to modify terminal path and other identifiers making nhdplusHR subsets “stand alone”. A function
make_standalone()is now exported.
get_pathlength()functions to generate nhdplus network attributes.