wbt_burn_streams_at_roads: Burn streams at roads

View source: R/hydro_analysis.R

wbt_burn_streams_at_roadsR Documentation

Burn streams at roads

Description

Burns-in streams at the sites of road embankments.

Usage

wbt_burn_streams_at_roads(
  dem,
  streams,
  roads,
  output,
  width = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster digital elevation model (DEM) file.

streams

Input vector streams file.

roads

Input vector roads file.

output

Output raster file.

width

Maximum road embankment width, in map units.

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.


whitebox documentation built on Nov. 19, 2023, 1:07 a.m.