Package index • fluvgeo

All functions
`FluvialGeomorphicMetric-class`	An S4 class to represent a fluvial geomorphic metric
`accept_stream_network()`	Accept an explicitly reviewed retained Stream Network
`add_study_reaches()`	Add explicitly assigned Reaches to a saved Study Area
`add_study_stream_corridor()`	Save one selected Stream corridor in a new study revision
`arcgis_auth()`	Authenticate to an ArcGIS Enterprise Portal
`associate_study_terrain()`	Associate a local terrain file with a recorded Survey Event
`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
`cancel_stream_dem_download()`	Record cancellation after a source DEM worker has stopped
`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_study_area_containment()`	Check child areas against a proposed Study Area boundary
`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
`clip_terrain_to_aoi()`	Clip and mask terrain while recording the executed operation
`combine_study_area_polygons()`	Combine explicitly selected polygons into a Study Area boundary
`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
`define_study_area_report()`	Render a prospective Define Study Area report
`define_study_streams()`	Define the initial Streams of a saved Study Area
`detrend()`	Detrend DEM
`discover_stream_dem_files()`	Find reported source DEM files for a Stream and Survey Collection
`discover_survey_collections()`	Discover reported lidar Survey Collections for a Study Area
`estimate_bankfull()`	Estimate Bankfull Report
`event_mask_key()`	Identify the raster-processing dependencies of saved Survey Event masks
`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_drainage_context()`	Retrieve candidate drainage layers for a reviewed stream location
`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_legacy_staging()`	Inspect a legacy FileGDB staging Study Area without modifying it
`inspect_stream_dem_download()`	Inspect one recorded source DEM without modifying it
`inspect_terrain_folder()`	Inspect files referenced by a terrain intake manifest
`inspect_terrain_vertical_reference()`	Inspect vertical-reference declarations in a local GeoTIFF
`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
`locate_drainage_stream()`	Locate a nearby mapped stream for drainage exploration
`map_extent()`	Calculate Expanded Map Extent
`map_reach_metric()`	Reach Metric Map
`map_reach_overview()`	Reach Overview Map
`map_xs()`	Cross section location map
`mask_terrain_mosaic()`	Apply an existing aligned analysis mask to a terrain mosaic
`meander_length()`	Calculate the meander length for each loop
`meander_width()`	Calculate the meander width for each loop
`metric_colors()`	Metric colors
`mosaic_terrain_tiles()`	Mosaic compatible elevation tiles with optional output-grid resampling
`normalize_retained_stream_network()`	Normalize a retained Stream Network
`order_drainage_flowlines()`	Order reference flowlines for upstream or downstream browsing
`orient_lines_from_dem()`	Orient lines upstream using DEM endpoint elevations
`planform()`	Calculate planform dimensions
`planform_dimensions()`	Calculate planform dimensions for each cross section
`preflight_stream_dem()`	Preflight a Stream acquisition group without creating terrain products
`prepare_stream_dem_download()`	Prepare an immutable local source DEM download attempt
`prepare_stream_network_from_features()`	Prepare retained Stream Network features for analyst review
`preview_stream_corridor()`	Preview an explicitly selected Stream corridor
`preview_stream_dem_download()`	Preview a downloaded DEM in its source pixel grid
`propose_survey_acquisition_groups()`	Propose acquisition months from retained provider evidence
`pt_watershed_area()`	Point Watershed Area
`reach_rhg_graph()`	Plot a reach regional hydraulic geometry graph
`read_event_masks()`	Reopen and verify saved masks
`read_stream_dem_download()`	Read local DEM download outcomes
`read_stream_dem_selection()`	Read saved Stream DEM file choices without network access
`read_stream_network_geodatabase()`	Read a locally saved Stream Network GeoPackage
`read_study_context()` `read_study_context_summary()`	Reopen a saved Study Area context
`read_survey_acquisition_group()`	Read a local acquisition group without changing its evidence
`read_survey_collection_selection()`	Read a retained Survey Collection selection snapshot
`record_study_analysis_reference()`	Record a Study Area analysis-reference choice in a new context
`record_study_survey_event()`	Record one acquired Survey Event under an existing Reach
`record_study_terrain_metadata()`	Record evidenced vertical metadata for associated terrain
`record_study_terrain_processing()`	Record an attributed account of terrain preparation
`record_study_terrain_source()`	Record attributed source-use evidence for an inventoried terrain artifact
`rename_study_feature()`	Rename a saved Stream or Reach
`retain_study_terrain_evidence()`	Retain a supporting file for a terrain source-use account
`review_terrain_transformations()`	Discover coordinate operation plans for saved source DEM references
`revise_study_context()`	Revise Study Area details or boundary in a new context copy
`run_stream_dem_download()`	Execute a prepared source DEM download attempt
`set_study_analysis_crs()`	Save a validated Study Area analysis CRS
`set_study_reach_areas()`	Supply or revise areas of existing Study Reaches
`set_study_vertical_reference()`	Save a vertical target specification without changing terrain
`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
`preview_study_reach_split()` `split_study_reach()`	Split a saved Reach at a snapped map location
`start_left()`	Does point C fall on the left side of the AB line?
`start_study_context()`	Start a new Study Area draft without acquired data
`stream_power()`	Calculate stream power for each cross section
`study_context_report()`	Render a selected view of saved Study Area context
`study_crs_candidates()`	Discover locally installed projected EPSG systems for a Study Area
`read_study_stream_segments()` `preview_study_reach_corridor()` `add_study_reach_corridor()`	Define Reaches from retained Stream segments
`preview_study_reach_merge()` `merge_study_reaches()`	Combine saved Reaches under one retained identity
`study_staging_report()`	Render a Study Area Staging Report
`study_vertical_crs_candidates()`	Discover locally installed vertical height CRS candidates
`survey_collection_products()`	Review product evidence for discovered Survey Collections
`survey_opportunity_report()`	Render a durable survey-opportunity report
`survey_opportunity_summary()`	Review survey opportunities from offline catalog snapshots
`table_xs_dimensions()`	Create a Cross Section Dimensions Table
`terrain_clip_report()`	Review a completed terrain clipping run
`terrain_development_report()`	Render an offline Terrain Development HTML report
`terrain_development_summary()`	Assemble a pre-Level-1 Terrain Development review
`terrain_reference_review()`	Assemble read-only terrain reference evidence for review
`terrain_to_international_feet()`	Convert NAVD88 metre elevations to international feet
`terrain_transform_candidates()`	Review locally available coordinate operation candidates
`validate_stream_network()`	Validate current retained-network state before observation acceptance
`validate_study_analysis_crs()`	Validate a projected horizontal analysis CRS
`validate_study_vertical_reference()`	Validate a Study Area vertical target specification
`warp_terrain_horizontal()`	Warp terrain on a qualified static horizontal grid without elevation conversion
`water_surface_poly()`	Water Surface Polygon
`write_event_masks()`	Write verified Study Area, Stream and Reach masks
`write_stream_dem_selection()`	Save explicit Stream DEM file choices
`write_stream_network_geodatabase()`	Save local Stream Network relations to a new GeoPackage
`write_study_context()`	Save supplied Study Area report context
`write_survey_acquisition_group()`	Save reviewed local acquisition group and Event spacing
`write_survey_collection_selection()`	Save Survey Collection selection intent without creating Survey Events
`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

Reference

All functions