wbt_breach_depressions: Breach depressions
In whitebox: 'WhiteboxTools' R Frontend

wbt_breach_depressions

R Documentation

Breach depressions

Description

Breaches all of the depressions in a DEM using Lindsay's (2016) algorithm. This should be preferred over depression filling in most cases.

Usage

wbt_breach_depressions(
  dem,
  output,
  max_depth = NULL,
  max_length = NULL,
  flat_increment = NULL,
  fill_pits = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

`dem`	Input raster DEM file.
`output`	Output raster file.
`max_depth`	Optional maximum breach depth (default is Inf).
`max_length`	Optional maximum breach channel length (in grid cells; default is Inf).
`flat_increment`	Optional elevation increment applied to flat areas.
`fill_pits`	Optional flag indicating whether to fill single-cell pits.
`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`.