Generate vegetation type map

vegTypeMapGenerator(x, ...)

# S3 method for RasterStack
vegTypeMapGenerator(x, ..., doAssertion = getOption("LandR.doAssertion", TRUE))

# S3 method for data.table
vegTypeMapGenerator(
  x,
  pixelGroupMap,
  vegLeadingProportion = 0.8,
  mixedType = 2,
  sppEquiv = NULL,
  sppEquivCol,
  colors,
  pixelGroupColName = "pixelGroup",
  doAssertion = getOption("LandR.assertions", TRUE),
  ...
)

Arguments

x

Either a cohortData object or a speciesCover RasterStack

...

Additional arguments.

doAssertion

A logical indicating whether some internal tests should be run to ensure the function is running correctly. Default: getOption("LandR.assertions", TRUE).

pixelGroupMap

A RasterLayer with pixel values equal to a pixel group number that corresponds exactly to pixelGroup column in cohortData.

vegLeadingProportion

Numeric between 0-1, determining the relative biomass threshold a species needs to pass to be considered "leading".

mixedType

An integer defining whether mixed stands are of any kind of species admixture (1), or only when deciduous mixed with conifer (2). Defaults to 2.

sppEquiv

table with species name equivalencies between the kNN and final naming formats. See data("sppEquivalencies_CA", "LandR"). Only necessary if mixedType == 2. If not provided and mixedType == 2, will attempt to use data("sppEquivalencies_CA", "LandR").

sppEquivCol

the column name to use from sppEquiv. Only necessary if mixedType == 2. If not provided and mixedType == 2, will attempt to use "Boreal".

colors

A named vector of colour codes. The names MUST match the names of species in cohortData$speciesCode, plus an optional "Mixed" colour.

pixelGroupColName

Name of the column in pixelGroup to use.