wbt_clip_raster_to_polygon: Clip raster to polygon

In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

Clip raster to polygon

Description

Clips a raster to a vector polygon.

Usage

wbt_clip_raster_to_polygon(
  input,
  polygons,
  output,
  maintain_dimensions = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input	Input raster file path. See wbt_file_path() for details.
polygons	Input vector polygons file.
output	Output raster file.
maintain_dimensions	Maintain input raster dimensions?.
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 Oct. 14, 2024, 2:38 a.m.