wbt_sink: Sink

In whitebox: 'WhiteboxTools' R Frontend

Sink

Description

Identifies the depressions in a DEM, giving each feature a unique identifier.

Usage

wbt_sink(
  input,
  output,
  zero_background = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input	Input raster DEM file.
output	Output raster file.
zero_background	Flag indicating whether a background value of zero should be used.
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 May 29, 2024, 1:21 a.m.