wbt_insert_dams: Insert dams

In whitebox: 'WhiteboxTools' R Frontend

Insert dams

Description

Calculates the impoundment size resulting from damming a DEM.

Usage

wbt_insert_dams(
  dem,
  dam_pts,
  output,
  damlength,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem	Input raster DEM file.
dam_pts	Input vector dam points file.
output	Output file.
damlength	Maximum length of the dam.
wd	Changes the working directory. Default: NULL will use the value in WhiteboxTools settings, see wbt_wd() for details.
verbose_mode	Sets verbose mode. If verbose mode is FALSE, tools will not print output messages. Default: NULL will use the value in WhiteboxTools settings, see wbt_verbose() for details.
compress_rasters	Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: NULL will use the value in WhiteboxTools settings, see wbt_compress_rasters() for details.
command_only	Return command that would be executed by system() rather than running tool. Default: FALSE.

Value

Returns the tool text outputs.

whitebox documentation built on Nov. 19, 2023, 1:07 a.m.