wbt_depth_to_water: Depth to water
In whitebox: 'WhiteboxTools' R Frontend

wbt_depth_to_water

R Documentation

Depth to water

Description

This tool calculates cartographic depth-to-water (DTW) index.

Usage

wbt_depth_to_water(
  dem,
  output,
  streams = NULL,
  lakes = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

`dem`	Name of the input raster DEM file.
`output`	Name of the output raster image file.
`streams`	Name of the input streams vector (optional).
`lakes`	Name of the input lakes vector (optional).
`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`.