xs_metric_ratios: Calculate metric ratios for each cross section
In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis

xs_metric_ratios

R Documentation

Calculate metric ratios for each cross section

Description

Calculates metric ratios for each cross section in the input xs_dims data frame.

Usage

xs_metric_ratios(xs_dimensions)

Arguments

xs_dimensions

sf object; A 'cross_section_dimensions' fluvgeo data structure.

Value

Returns the input xs_dims data frame of cross sections with the calculated metric ratio variables added.

Examples

# Calculate cross section planform dimensions
xs_dims_plan <- planform_dimensions(fluvgeo::sin_riffle_floodplain_dims_L2_sf,
                                    fluvgeo::sin_bankline_points_sf)

# Calculate cross section metric ratios
xs_dims_ratios <- xs_metric_ratios(xs_dims_plan)

FluvialGeomorph/fluvgeo documentation built on Feb. 19, 2025, 4:24 p.m.