wbt_downslope_index {whitebox}

Downslope index

Description

Calculates the Hjerdt et al. (2004) downslope index.

Usage

wbt_downslope_index(
  dem,
  output,
  drop = 2,
  out_type = "tangent",
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output raster file.

drop

Vertical drop value (default is 2.0).

out_type

Output type, options include 'tangent', 'degrees', 'radians', 'distance' (default is 'tangent').

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.