whitebox (version 2.3.1)

wbt_shape_index: Shape index

Description

This tool calculates the shape index from an input DEM.

Usage

wbt_shape_index(
  dem,
  output,
  zfactor = 1,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

dem

Name of the input raster DEM file.

output

Name of the output raster image file.

zfactor

Z conversion factor.

wd

Changes the working directory.

verbose_mode

Sets verbose mode. If verbose mode is FALSE, tools will not print output messages.

compress_rasters

Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.

command_only

Return command that would be executed by system() rather than running tool.