Estimate Bankfull Report

Produces the FluvialGeomorph Estimate Bankfull report.

estimate_bankfull(
  stream,
  flowline_fc,
  xs_dims_fc,
  xs_points_ch_1,
  xs_points_ch_2,
  xs_points_ch_3,
  xs_points_ch_4,
  xs_points_fp_1,
  xs_points_fp_2,
  xs_points_fp_3,
  xs_points_fp_4,
  survey_name_1,
  survey_name_2,
  survey_name_3,
  survey_name_4,
  features_fc,
  dem,
  show_xs_map,
  regions,
  bankfull_elevations,
  bf_estimate,
  stat,
  label_xs,
  profile_units,
  aerial,
  elevation,
  xs_label_freq,
  exaggeration,
  extent_factor,
  output_dir,
  output_format
)

Arguments

stream

character; The stream name. The stream name must match a stream name in `ReachName` field in the other parameters.

flowline_fc

character; The path to the `flowline` feature class.

xs_dims_fc

character; The path to the `riffle_channel_dims_L2` feature class. This is for the "base year" survey.

xs_points_ch_1

character; The path to the `riffle_channel_points` feature class for the "base year".

xs_points_ch_2

character; The path to the `riffle_channel_points` feature class for the second time period.

xs_points_ch_3

character; The path to the `riffle_channel_points` feature class for the third time period.

xs_points_ch_4

character; The path to the `riffle_channel_points` feature class for the fourth time period.

xs_points_fp_1

character; The path to the `riffle_floodplain_points` feature class for the "base year".

xs_points_fp_2

character; The path to the `riffle_floodplain_points` feature class for the second time period.

xs_points_fp_3

character; The path to the `riffle_floodplain_points` feature class for the third time period.

xs_points_fp_4

character; The path to the `riffle_floodplain_points` feature class for the fourth time period.

survey_name_1

character: The name or date of the "base year" survey.

survey_name_2

character: The name or date of the second survey.

survey_name_3

character: The name or date of the third survey.

survey_name_4

character: The name or date of the fourth survey.

features_fc

character; The path to a `features` feature class.

dem

character; The path to the DEM raster.

show_xs_map

logical; Add the cross section maps to the report?

regions

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

bankfull_elevations

numeric vector; The bankfull elevations (units: detrended feet) that are used to calculate hydraulic geometry.

bf_estimate

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

stat

character; The statistic to graph "RMSE", "MAE" (the default).

label_xs

logical; Label cross sections?

profile_units

character; The units of the longitudinal profile. One of "kilometers", "meters", "miles", or "feet"

aerial

logical; Display an overview map with an aerial photo background?

elevation

logical; Display an overview map with an elevation background?

xs_label_freq

numeric; An integer indicating the frequency of cross section labels.

exaggeration

numeric; The degree of terrain exaggeration.

extent_factor

numeric; The amount the extent is expanded around the cross section feature class. Values greater than one zoom out, values less than one zoom in.

output_dir

character; The output directory.

output_format

character; The output format of the report. One of "html_document", "word_document", "pdf_document".

Value

Produces a FluvialGeomorph Estimate Bankfull report in the `output_dir` in the requested file format.