ExportProfiles: Export Profiles

View source: R/ExportProfiles.R

ExportProfilesR Documentation

Export Profiles

Description

Exports cross shore profiles as csv files to a specified local directory.

Usage

ExportProfiles(
  dat = NA,
  wave_dat = NA,
  erosion = NA,
  mean_high_water = NA,
  total_wsl_adj = NA,
  TrimOnshoreDist = NA,
  path_output = NA,
  export_csv = TRUE
)

Arguments

dat

A sf and data frame of cross-profiles returned from ExtractVeg.

wave_dat

A sf and data frame of cross-profiles returned from WaveModel.

erosion

Erosion summaries returned from ErosionTransectsUtil.

mean_high_water

Mean high water elevation above the chart datum.

total_wsl_adj

Total water surface level above the chart datum. Recall that the chart datum and TopoBathy DEM are referenced to have 0 at low water. It is therefore suggested to set this value at the mean sea level above chart datum or a specific tidal elevation of interest.

TrimOnshoreDist

Numeric, option distance onshore to trim profile in meters.

path_output

Output directory to save cross-shore profiles.

export_csv

Should cross shore profiles be exported.

Value

Cross-shore profiles are exported and save as csv to a directory.


essatech/MNAI.CPBT documentation built on July 1, 2023, 12:34 p.m.