All functions

FluvialGeomorphicMetric-class

An S4 class to represent a fluvial geomorphic metric

accept_stream_network()

Accept an explicitly reviewed retained Stream Network

arcgis_auth()

Authenticate to an ArcGIS Enterprise Portal

bend_radius()

Calculate the bend radius of curvature

bend_raduis_plot()

Plot the bend radius of curvature

build_gof_stats()

Calculate goodness-of-fit statistics

build_logical_stream_links()

Build logical links from raw stream line segments

check_bankline_points()

Check the validity of an `fluvgeo` `bankline_points` data structure

check_banklines()

Check the validity of an `fluvgeo` `banklines` data structure

check_channel_feature()

Check the validity of an `fluvgeo` `channel_feature` data structure

check_cross_section()

Check the validity of an `fluvgeo` `cross_section` data structure

check_cross_section_dimensions()

Check the validity of an `fluvgeo` `cross_section_dimension` data structure

check_cross_section_points()

Check the validity of an `fluvgeo` `cross_section_points` data structure

check_crs_3857()

Test if the CRS is 3857

check_features()

Check the validity of an `fluvgeo` `features` data structure

check_flowline()

Check the validity of an `fluvgeo` `flowline` data structure

check_flowline_points()

Check the validity of an `fluvgeo` `flowline_points` data structure

check_loop_points()

Check the validity of an `fluvgeo` `loop_points` data structure

check_slope_sinuosity()

Check the validity of the `slope_sinuosity` function

check_valleyline()

Check the validity of an `fluvgeo` `valleyline` data structure

check_valleyline_points()

Check the validity of an `fluvgeo` `valleyline_points` data structure

check_xs_dims()

Check the validity of an `fluvgeo` `xs_dims` data structure

classify_stream_network_segments()

Apply explicit segment-role classifications to prepared candidates

compare_long_profile()

Compare stream longitudinal profiles from multiple surveys

compare_xs_long_profile()

Compare cross section longitudinal profiles from multiple surveys

connect_stream_network()

Assign candidate nodes and derive hydrologic connectivity

create_stream_network_configuration()

Create Stream Network Configuration relations

create_stream_network_observation()

Create a Stream Network Observation relation

cross_section()

Cross Section

cross_section_dimensions_L1()

Calculate Cross Section Dimensions at Level 1

cross_section_dimensions_L2()

Calculate Cross Section Dimensions at Level 2

cross_section_points()

Cross Section Points

detrend()

Detrend DEM

estimate_bankfull()

Estimate Bankfull Report

explore_long_profile()

Explore Longitudinal Profile Report

fc2sf()

Convert ESRI .gdb feature class to `sf`

fig_xs_profiles_L1()

Cross Section Plot Figure

fig_xs_profiles_L2()

Cross Section Plot Figure, L2

floodplain_volume()

Floodplain Volume

flowline()

Flowline

flowline_metrics()

Level 1 longitudinal metrics

flowline_points()

Flowline Points

gdb_raster2SpatRast()

Convert an ESRI Geodatabase raster to a SpatRaster

get_dem()

Get DEM

get_leaflet()

Get Leaflet Map

get_results_leaflet()

Get Results Leaflet

get_terrain_leaflet()

Get a Terrain Leaflet

get_watershed()

Get Watershed

gof_graph()

Plot goodness-of-fit graph

gte()

Assign Vector Values Greater Than or Equal to Value

hydroflatten_dem()

Hydroflatten DEM

inspect_terrain_folder()

Inspect files referenced by a terrain intake manifest

justify_gtable()

Justify a tableGrob

level_1_report()

Level 1 Report

level_1_report_b()

Level 1 Report, version b

level_2_report()

Level 2 Report

level_2_report_b()

Level 2 Report, version b

level_3_report()

Cross Section Metrics Report

map_extent()

Calculate Expanded Map Extent

map_reach_metric()

Reach Metric Map

map_reach_overview()

Reach Overview Map

map_xs()

Cross section location map

meander_length()

Calculate the meander length for each loop

meander_width()

Calculate the meander width for each loop

metric_colors()

Metric colors

normalize_retained_stream_network()

Normalize a retained Stream Network

orient_lines_from_dem()

Orient lines upstream using DEM endpoint elevations

planform()

Calculate planform dimensions

planform_dimensions()

Calculate planform dimensions for each cross section

prepare_stream_network_from_features()

Prepare retained Stream Network features for analyst review

pt_watershed_area()

Point Watershed Area

reach_rhg_graph()

Plot a reach regional hydraulic geometry graph

read_stream_network_geodatabase()

Read a locally saved Stream Network GeoPackage

sf2csv()

Save `sf` object to a .csv file.

sf_fix_crs()

Fix SF CRS

sf_get_z()

SF Get Z

sf_line_end_point()

Extract line end points

sf_line_reverse()

Reverse line direction

sf_point_attributes()

Calculate x and y coordinate values as new fields.

shear_stress()

Calculate shear stress for each cross section

sin_bankline_points_sf

Sinsinawa Creek, IL stream bankline points

sin_banklines_sf

Sinsinawa Creek, IL stream banklines

sin_features_sf

Sinsinawa Creek, IL stream features

sin_flowline_points_sf

Sinsinawa Creek, IL stream flowline points

sin_flowline_sf

Sinsinawa Creek, IL stream flowline

sin_gradient_sf

Sinsinawa Creek, IL stream gradient points

sin_loop_points_sf

Sinsinawa Creek, IL stream loop points

sin_riffle_channel_points_sf

Sinsinawa Creek, IL stream channel cross section points

sin_riffle_channel_sf

Sinsinawa Creek, IL riffles

sin_riffle_floodplain_dims_L1_sf

Sinsinawa Creek, IL stream riffle cross section lines

sin_riffle_floodplain_dims_L2_sf

Sinsinawa Creek, IL stream riffle cross section lines

sin_riffle_floodplain_dims_L3_sf

Sinsinawa Creek, IL stream riffle cross section lines

sin_riffle_floodplain_points_sf

Sinsinawa Creek, IL stream riffle cross section points

sin_riffle_floodplain_sf

Sinsinawa Creek, IL stream riffle cross section lines

sin_valleyline_points_sf

Sinsinawa Creek, IL stream valleyline points

sin_valleyline_sf

Sinsinawa Creek, IL stream valleyline

slope_sinuosity()

Calculate slope and sinuosity

start_left()

Does point C fall on the left side of the AB line?

stream_power()

Calculate stream power for each cross section

table_xs_dimensions()

Create a Cross Section Dimensions Table

terrain_development_report()

Render an offline Terrain Development HTML report

terrain_development_summary()

Assemble a pre-Level-1 Terrain Development review

validate_stream_network()

Validate current retained-network state before observation acceptance

water_surface_poly()

Water Surface Polygon

write_stream_network_geodatabase()

Save local Stream Network relations to a new GeoPackage

write_terrain_manifest()

Record a portable terrain intake inventory

xs2pts()

XS lines to points

xs_bearing()

Cross Section Bearing

xs_compare_plot_L1()

Overplot multiple cross section profile surveys

xs_compare_plot_L2()

Overplot multiple cross section profile surveys

xs_dimensions()

Calculate cross section and regional metrics for a set of streams, regions, and detrended bankfull elevations

xs_geometry()

Calculate cross section width, depth, area.

xs_metric_plot()

Plot cross section metrics

xs_metric_ratios()

Calculate metric ratios for each cross section

xs_metrics()

Calculate cross section hydraulic geometry metrics

xs_metrics_plot_L1()

Plot Level 1 Cross Section Metrics

xs_metrics_plot_L2()

Plot Level 2 Cross Section Metrics

xs_metrics_plot_L3()

Plot Level 3 Cross Section Metrics

xs_plot()

Plot cross section profile

xs_profile_plot()

Plot stream longitudinal profile

xs_pts_classify()

Classify Cross Section Points

xs_regional_metrics()

Calculate cross section and regional hydraulic geometry metrics

xs_upstream()

Calculate upstream cross section