cross_section_dimensions_L2: Calculate Cross Section Dimensions at Level 2

View source: R/cross_section_dimensions_L2.R

cross_section_dimensions_L2R Documentation

Calculate Cross Section Dimensions at Level 2

Description

Calculates level 2 cross section dimensions for the input cross section feature class.

Usage

cross_section_dimensions_L2(
  xs,
  xs_points,
  bankfull_elevation,
  lead_n,
  use_smoothing,
  loess_span = 0.5,
  vert_units
)

Arguments

xs

sf; the full path to a cross section line feature class

xs_points

sf data frame; the full path to a cross section points feature class

bankfull_elevation

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

lead_n

numeric; The number of features to lead/lag on either side of each feature that will be used to calculate the slope and sinuosity.

use_smoothing

boolean; determines if smoothed elevation values are used to calculate gradient. values are: TRUE, FALSE (default)

loess_span

numeric; the loess regression span parameter, defaults to 0.05

vert_units

character; The vertical units. One of: "m" (meter), "ft" (foot), "us-ft" (us survey foot)

Value

A new cross section data frame with the hydraulic geometry dimensions added.


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