Skip to contents

Changelog

Source: NEWS.md

hydroloom 1.3.0

Distances from confluences and subpaths along identified mainstems. Four new functions place and recover positions relative to the confluences of identified mainstems (aggregate_id as a mainstem URI), working kilometer values along each aggregate flowpath axis, built from flowline lengths rather than coordinates. A mainstem is one kind of aggregate flowpath (the flowlines that share an aggregate_id and link end to end), so any aggregate_id whose flowlines form one unbranched path works the same way.

  • get_confluences() returns each confluence of two identified mainstems as a hydro location on the receiving mainstem just below the tributary.
  • add_hydro_location_distance() records the signed distance along a mainstem from the nearest hydro location; negative toward the outlet, positive toward the head.
  • index_hydro_location_distance() is the inverse, mapping a distance from a hydro location back to a flowline id and id_measure.
  • get_subpath() returns the subpath between two positions on one aggregate flowpath (such as an identified mainstem) as ordered flowline pieces, with piece geometry cut by lwgeom::st_linesubstring() when the input is sf and lwgeom is installed.
  • index_points_to_lines() returns id_measure on every call and accepts aggregate_ids to constrain a point to one mainstem’s flowlines.
  • hy_capabilities() reports the four new functions. A new website article, “Distances from confluences along mainstems”, walks a worked example.
  • The “Indexing points to a network” website article moves over from hydrogeofetch and is rewritten around hydroloom’s indexing functions.

hydroloom 1.2.2

CRAN release: 2026-09-13

Correctness fix on make_node_topology() for dendritic networks. Outlet tonodes were seeded from max(non-outlet tonode) + 1. When the highest fromnodes belonged to outlets (whose tonode is NA and excluded from that max), the seed fell inside the fromnode range and a terminal flowline’s tonode collided with another feature’s fromnode, fabricating a connection that add_toids() would then rediscover. Outlet tonodes are now seeded above every assigned node (max(c(fromnode, tonode))), so terminals keep independent pendant nodes. Observed on the Alaska reference network (2 of 2,122 outlets).

Performance fix on accumulate_downstream(). No user-facing behavior change; output is identical.

Correctness fix on add_pathlength() for networks with character ids. The terminal test was toid != 0, which recognizes only the numeric outlet sentinel. With character ids the sentinel is "", the comparison is made as strings and is TRUE, so terminals took the accumulating branch, indexed with NA, and the NA propagated up every path above them — the whole pathlength_km column came back NA. Now uses get_outlet_value(), as add_streamorder() and add_levelpaths() do. Networks with numeric ids are unaffected.

nhdplusTools has been renamed hydrogeofetch. Examples, tests, and articles that pull sample data now suggest and source from hydrogeofetch, and package URLs point at the new repository.

hydroloom 1.2.1

CRAN release: 2026-08-03

Maintenance release completing the USGS official software release review (#72). No package code changed.

hydroloom 1.2.0

CRAN release: 2026-05-23

This release introduces an S3 class hierarchy (hy_topo, hy_leveled, hy_node, hy_flownetwork) that lets hydroloom validate input at dispatch time and emit guided error messages. Existing code that passes data.frame or hy objects keeps working – the new classes are assigned automatically by hy() and by producer functions. See ?hy_topo, ?hy_leveled, ?hy_node, and ?hy_flownetwork for representation patterns, required columns, and conversion paths; the non-dendritic networks and network navigation articles at https://doi-usgs.github.io/hydroloom/ provide end-to-end walkthroughs. Package developers should note that returned objects now carry subclass attributes which are stripped by standard dplyr operations.

  • Outlet detection is explicit (#85): a row is an outlet when its toid is not in id. Canonical reserved values (0 / ""), NA, implicit absence, foreign reserved values, and unique-per-outlet ids are all accepted. Calls that previously errored on NA or orphan toid now succeed; warnings are narrower (check_hy_outlets() only on type mismatch, sort_network() only on zero outlets).
  • S3 class hierarchy (#73). Producer functions stamp output classes (add_toids(), sort_network(), add_levelpaths(), make_node_topology(), to_flownetwork()); dispatch is on subclass with guided errors for wrong input. hy_flownetwork is a separate junction table – it does not inherit from hy.
  • New exported helpers: hy_network_type(), is_dendritic(), hy_capabilities(). Print methods for hy_topo, hy_node, hy_flownetwork.
  • hy() gains add_topo to auto-build toid from fromnode/tonode.
  • add_toids(return_dendritic = FALSE) is deprecated; use to_flownetwork().
  • add_levelpaths() is faster (data.table conversion).
  • New check_valid() for sf/sfc geometry repair, including GEOMETRYCOLLECTION artifacts from sf::st_make_valid(). See ?check_valid.
  • New dissolve_polygons() for unioning catchment or HUC-style polygon coverages, with optional grouping and interior-hole fill. Uses geos (added to Suggests) for accelerated unions when installed. See ?dissolve_polygons.
  • Fix get_bridge_flowlines() on networks with independent terminals – make_nondendritic_topology() had collapsed all rows carrying the reserved outlet value into one synthetic node, misclassifying bridges and exhausting memory on continental networks.
  • Fix make_to_dt() dendritic branch on tibble input.
  • Welcome new contributor Andrew Psoras.
  • Deprecation notice: A future release will require that hy_topo objects have unique id values (one row per catchment). Non-dendritic connectivity with duplicated ids in a toid-based edge list will need to be represented as hy_flownetwork (via to_flownetwork()). Developers passing non-dendritic toid tables through hydroloom functions should migrate to to_flownetwork() or make_node_topology().

hydroloom 1.1.3

CRAN release: 2026-02-20

Update test tolerances for failing Fedora CRAN tests

hydroloom 1.1.2

CRAN release: 2026-02-20

Hydroloom 1.1.2 introduces new functionality in accumulate_downstream(), reworks the make_index_ids(), and deprecates make_fromids() and format_index_ids() for clarity of package function. Deprecated functions will be removed in the next major version release.

hydroloom 1.1.1

CRAN release: 2025-10-01

  • fix bug with sort_network when duplicate entries are in the extended attributes – #52
  • add specific id search to index_points_to_lines for #24
  • error handling #49

hydroloom 1.1.0

CRAN release: 2024-08-26

  • Add new vignette for network navigation vignette("network_navigation")
  • Add support for upmain and downmain navigation in navigate_network_dfs()
  • Add support for upmain and downmain in make_index_ids() and make_fromids().
  • Add function to create a “flownetwork” representation of the network with a to_flownetwork function.
  • Improved handling / fix bugs with edge cases in add_toids()
  • Improved error conditions when missing suggested packages.
  • navigate_hydro_network() will now navigate from a diverted path to a main path where it previously only followed traditional tributaries..

hydroloom 1.0.1 and 1.0.2

CRAN release: 2024-01-09

  • Add checks if nhdplusTools is available.

hydroloom 1.0.0

CRAN release: 2023-09-29