wbt_sediment_transport_index: Sediment transport index

In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

Sediment transport index

Description

Calculates the sediment transport index.

Usage

wbt_sediment_transport_index(
  sca,
  slope,
  output,
  sca_exponent = 0.4,
  slope_exponent = 1.3,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

sca	Input raster specific contributing area (SCA) file.
slope	Input raster slope file.
output	Output raster file.
sca_exponent	SCA exponent value.
slope_exponent	Slope exponent value.
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.

giswqs/whiteboxR documentation built on Feb. 13, 2024, 6:16 p.m.