wbt_raster_area: Raster area

Description Usage Arguments Value

View source: R/gis_analysis.R

Description

Calculates the area of polygons or classes within a raster image.

Usage

1
2
3
4
5
6
7
8
9
wbt_raster_area(
  input,
  output = NULL,
  out_text = FALSE,
  units = "grid cells",
  zero_back = FALSE,
  wd = NULL,
  verbose_mode = FALSE
)

Arguments

input

Input raster file.

output

Output raster file.

out_text

Would you like to output polygon areas to text?.

units

Area units; options include 'grid cells' and 'map units'.

zero_back

Flag indicating whether zero values should be treated as a background.

wd

Changes the working directory.

verbose_mode

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

Value

Returns the tool text outputs.


whitebox documentation built on Sept. 7, 2020, 3 p.m.