Calculate cross section and regional hydraulic geometry metrics

Calculates cross section geometry and regional hydraulic geometry dimensions for the specified cross section at the specified bankfull elevation.

xs_regional_metrics(xs_points, stream, xs_number, bankfull_elevation, region)

Arguments

xs_points

data frame; a data frame of cross section points

stream

character; The name of the stream.

xs_number

integer; The cross section identifier of the requested cross section.

bankfull_elevation

numeric; The detrended bankfull elevation (units: NAVD88 feet) that is used to calculate hydraulic geometry.

region

character; The region that a dimension will be calculated for. See the regional_curves$region field for a complete list.

Value

A data frame of hydraulic dimensions for the specified cross section at the specified detrended bankfull elevation and the regional hydraulic dimensions.

reach_name

character; The name of the stream.

cross_section

numeric; The cross section unique identifier. Seq is only unique within a reach.

xs_type

character; A string indicating how the cross section was derived. "DEM derived cross section" denotes dimensions calculated from the DEM and "<Region Name>" denotes that the dimensions were calculated from that regions regional curve.

bankfull_elevation

numeric; The detrended bankfull elevation (in feet) that is used to calculate hydraulic geometry.

drainage_area

numeric; The area of the watershed upstream from this cross section, units: square miles.

xs_area

numeric; The cross sectional area at the specified detrended bankfull elevation, units: square feet.

xs_width

numeric; The cross section width at the specified detrended bankfull elevation, units: feet.

xs_depth

numeric; The maximum depth at the specified detrended bankfull elevation, units: detrended feet.

discharge

numeric; The estimated discharge at the specified drainage area.

See also

The xs_regional_metrics function calls the xs_metrics function which calls the xs_geometry function. The xs_regional_metrics function is called by the xs_dimensions function.

Examples

# Extract attribute data from the fluvgeo::sin_riffle_channel_points_sf
# sf object
sin_xs_points_df <- fluvgeo::sin_riffle_channel_points_sf
# Call the xs_metrics function
sin_4 <- xs_regional_metrics(xs_points = sin_xs_points_df,
                             stream = "Sinsinawa",
                             xs_number = 4,
                             bankfull_elevation = 103.5,
                             region = "Eastern United States")