whitebox (version 2.4.0)

wbt_vector_stream_network_analysis: Vector stream network analysis

Description

This tool performs common stream network analysis operations on an input vector stream file.

Usage

wbt_vector_stream_network_analysis(
  streams,
  output,
  snap = 0.1,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

streams

Name of the input streams vector file.

output

Name of the output lines shapefile.

snap

Snap distance, in xy units (metres).

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.