hydroloom | hy S3 class | Network Representation | Representing Dendritic Network Topology | Representing Non-Dendritic Network Topology | Network Graph Representation | Using the Graph Representation
Package: hydroloom 1.2.0
David Blodgett
hydroloom: Utilities to Weave Hydrologic Fabrics
A collection of utilities that support creation of network attributes for hydrologic networks. Methods and algorithms implemented are documented in Moore et al. (2019) <doi:10.3133/ofr20191096>), Cormen and Leiserson (2022) <ISBN:9780262046305> and Verdin and Verdin (1999) <doi:10.1016/S0022-1694(99)00011-6>.
Authors:
hydroloom_1.2.0.tar.gz
hydroloom_1.2.0.zip(r-4.7)hydroloom_1.2.0.zip(r-4.6)hydroloom_1.2.0.zip(r-4.5)
hydroloom_1.2.0.tgz(r-4.6-any)hydroloom_1.2.0.tgz(r-4.5-any)
hydroloom_1.2.0.tar.gz(r-4.7-any)hydroloom_1.2.0.tar.gz(r-4.6-any)
hydroloom_1.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
hydroloom/json (API)
| # Install 'hydroloom' in R: |
| install.packages('hydroloom', repos = c('https://doi-usgs.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/doi-usgs/hydroloom/issues
Pkgdown/docs site:https://doi-usgs.github.io
Last updated from:10b3d493d6. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 239 | ||
| source / vignettes | OK | 253 | ||
| linux-release-x86_64 | OK | 238 | ||
| macos-release-arm64 | OK | 207 | ||
| macos-oldrel-arm64 | OK | 175 | ||
| windows-devel | OK | 180 | ||
| windows-release | OK | 206 | ||
| windows-oldrel | OK | 189 | ||
| wasm-release | OK | 183 |
Exports:accumulate_downstreamadd_divergenceadd_levelpathsadd_measuresadd_pathlengthadd_pfafstetteradd_return_divergenceadd_streamleveladd_streamorderadd_toidsadd_topo_sortalign_namescheck_hy_graphcheck_validdisambiguate_indexesdissolve_polygonsfix_flowdirformat_index_idsget_bridge_flowlinesget_hydro_locationget_nodeget_partial_lengthhyhy_capabilitieshy_network_typehy_reversehydroloom_name_definitionshydroloom_namesindex_points_to_linesindex_points_to_waterbodiesis_dendriticis.hymake_attribute_topologymake_fromidsmake_index_idsmake_node_topologynavigate_connected_pathsnavigate_hydro_networknavigate_network_dfsrename_geometryrescale_measuressort_networkst_compatibalizesubset_networkto_flownetwork
Dependencies:classclassIntclicpp11data.tableDBIdplyre1071fastmapgenericsglueKernSmoothlifecyclemagrittrMASSpbapplypillarpkgconfigproxypurrrR6RANNRcpprlangs2sfstringistringrtibbletidyrtidyselectunitsutf8vctrswithrwk
Hydroloom Overview
Last update: 2026-06-08
Started: 2023-05-05
Network Navigation
Navigation Modes | NHDPlus-based network navigation | Flownetwork-based navigation
Last update: 2026-06-08
Started: 2024-05-11
Non-dendritic networks
Introduction | Non-dendritic topology attributes | fromnode and tonode | divergence | return divergence | stream calculator | summary | Divergence case study: dropped vs preserved secondary paths | Bringing it all together
Last update: 2026-06-08
Started: 2023-04-07
NHD Flow Table with Hydroloom
Last update: 2026-05-05
Started: 2023-04-20
Downstream Accumulation
Introduction | Sample data | Three accumulation modes | 1. Dendritic (default) | 2. Fractional (divergence apportioned) | 3. Total upstream (no apportionment) | Accumulating derived quantities | Choosing a mode
Last update: 2026-02-20
Started: 2026-02-20
Topological Sort Based Network Attributes
Terminology | Introduction | topo_sort | Level Path | Other Derived Network Attributes | Required Base Attributes | A visual introduction to the advanced network attributes | topo_sort and terminal ID | Level Path and outlet ID | Summary
Last update: 2026-02-20
Started: 2023-03-14
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Accumulate Variable Downstream | accumulate_downstream accumulate_downstream.data.frame accumulate_downstream.hy accumulate_downstream.hy_flownetwork accumulate_downstream.hy_node accumulate_downstream.hy_topo |
| Add Divergence Attribute | add_divergence add_divergence.data.frame add_divergence.hy add_divergence.hy_node add_divergence.hy_topo |
| Add Level Paths | add_levelpaths add_levelpaths.data.frame add_levelpaths.hy add_levelpaths.hy_flownetwork add_levelpaths.hy_node add_levelpaths.hy_topo |
| Add aggregate id measures to flowlines | add_measures add_measures.data.frame add_measures.hy |
| Add Path Length | add_pathlength add_pathlength.data.frame add_pathlength.hy add_pathlength.hy_node add_pathlength.hy_topo |
| Add Pfafstetter Codes | add_pfafstetter add_pfafstetter.data.frame add_pfafstetter.hy add_pfafstetter.hy_leveled add_pfafstetter.hy_node add_pfafstetter.hy_topo |
| Add Return Divergence | add_return_divergence add_return_divergence.data.frame add_return_divergence.hy add_return_divergence.hy_node add_return_divergence.hy_topo |
| Add Streamlevel | add_streamlevel add_streamlevel.data.frame add_streamlevel.hy add_streamlevel.hy_leveled add_streamlevel.hy_topo |
| Add Streamorder | add_streamorder add_streamorder.data.frame add_streamorder.hy add_streamorder.hy_flownetwork add_streamorder.hy_node add_streamorder.hy_topo |
| Add Downstream IDs | add_toids add_toids.data.frame add_toids.hy add_toids.hy_node add_toids.hy_topo |
| Add topo_sort | add_topo_sort add_topo_sort.data.frame add_topo_sort.hy add_topo_sort.hy_flownetwork add_topo_sort.hy_node add_topo_sort.hy_topo |
| Align Names to Hydroloom Convention | align_names |
| Check hy Graph | check_hy_graph |
| Check and Repair Geometry Validity | check_valid check_valid.sf check_valid.sfc |
| Disambiguate Flowline Indexes | disambiguate_indexes |
| Dissolve Polygons | dissolve_polygons dissolve_polygons.sf dissolve_polygons.sfc |
| Fix Flow Direction | fix_flowdir |
| DEPRECATED: Format Index ids | format_index_ids |
| Get Bridge Flowlines | get_bridge_flowlines get_bridge_flowlines.data.frame get_bridge_flowlines.hy get_bridge_flowlines.hy_flownetwork get_bridge_flowlines.hy_node get_bridge_flowlines.hy_topo |
| Get Hydro Location | get_hydro_location |
| Get Line Node | get_node |
| Get Partial Flowpath Length | get_partial_length |
| Create a hy Fabric S3 Object | hy |
| What operations are available for this network? | hy_capabilities |
| hy_flownetwork: non-dendritic junction table | hy_flownetwork |
| hy_leveled: enriched self-referencing edge list | hy_leveled |
| What representation pattern does this network use? | hy_network_type |
| hy_node: bipartite feature-and-nexus graph | hy_node |
| Reverse 'hy' to Original Names | hy_reverse |
| hy_topo: self-referencing edge list | hy_topo |
| Hydroloom Name Definitions | hydroloom_name_definitions |
| Get or Set Hydroloom Names | hydroloom_names |
| Index Points to Lines | index_points_to_lines index_points_to_lines.data.frame index_points_to_lines.hy |
| Index Points to Waterbodies | index_points_to_waterbodies |
| Is the network dendritic? | is_dendritic |
| Is Valid 'hy' Class? | is.hy |
| Make Attribute Topology | make_attribute_topology make_attribute_topology.data.frame make_attribute_topology.hy |
| DEPRECATED Convert "to" index ids to "from" index ids | make_fromids |
| Make Index ids | make_index_ids make_index_ids.data.frame make_index_ids.hy make_index_ids.hy_flownetwork make_index_ids.hy_topo |
| Make Node Topology from Edge Topology | make_node_topology make_node_topology.data.frame make_node_topology.hy make_node_topology.hy_flownetwork make_node_topology.hy_topo |
| Navigate Connected Paths | navigate_connected_paths |
| Navigate Hydro Network | navigate_hydro_network navigate_hydro_network.data.frame navigate_hydro_network.hy navigate_hydro_network.hy_leveled navigate_hydro_network.hy_node navigate_hydro_network.hy_topo |
| Navigate all Paths Depth First | navigate_network_dfs |
| Rename Geometry | rename_geometry |
| Rescale Aggregate id Measure to id Measure | rescale_measures |
| Sort Network | sort_network sort_network.data.frame sort_network.hy sort_network.hy_flownetwork sort_network.hy_node sort_network.hy_topo |
| Make Spatial Inputs Compatible | st_compatibalize |
| Subset Network | subset_network subset_network.data.frame subset_network.hy subset_network.hy_node subset_network.hy_topo |
| To Flownetwork | to_flownetwork to_flownetwork.data.frame to_flownetwork.hy to_flownetwork.hy_leveled to_flownetwork.hy_node to_flownetwork.hy_topo |
