planform_dimensions: Calculate planform dimensions for each cross section

View source: R/planform_dimensions.R

planform_dimensionsR Documentation

Calculate planform dimensions for each cross section

Description

Calculates planform dimensions for each cross section in the input xs_dims data frame.

Usage

planform_dimensions(xs_dimensions, bankline_points)

Arguments

xs_dimensions

sf data frame; A 'cross_section_dimensions' fluvgeo data structure.

bankline_points

sf data frame; A 'bankline_points' fluvgeo data 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)

FluvialGeomorph/fluvgeo documentation built on April 12, 2024, 5:35 p.m.