New function: gcLocatorCreate

NAMESPACE

@@ -19,6 +19,7 @@ export(cumPoolsCreateAGB)
 export(cumPoolsSmooth)
 export(distMatch)
 export(extractToRast)
+export(gcLocatorCreate)
 export(gcidsCreate)
 export(m3ToBiomPlots)
 export(nmfac)

R/Boudewyn_cumPoolsCreate.R

@@ -1,14 +1,14 @@
 #' Create `cumPools` data.table
 #'
-#' @param fullSpecies DESCRIPTION NEEDED
-#' @param gcMeta DESCRIPTION NEEDED
-#' @param userGcM3 DESCRIPTION NEEDED
-#' @param stable3 DESCRIPTION NEEDED
-#' @param stable4 DESCRIPTION NEEDED
-#' @param stable5 DESCRIPTION NEEDED
-#' @param stable6 DESCRIPTION NEEDED
-#' @param stable7 DESCRIPTION NEEDED
-#' @param thisAdmin DESCRIPTION NEEDED
+#' @param fullSpecies Species names found in study area.
+#' @param gcMeta Growth curve metadata table that links species with additional attributes.
+#' @param userGcM3 Growth curve metadata table that links species with additional attributes.
+#' @param stable3 Boudewyn table 3 subset to study area attributes.
+#' @param stable4 Boudewyn table 3 subset to study area attributes.
+#' @param stable5 Boudewyn table 3 subset to study area attributes.
+#' @param stable6 Boudewyn table 3 subset to study area attributes.
+#' @param stable7 Boudewyn table 3 subset to study area attributes.
+#' @param thisAdmin Study area metadata
 #'
 #' @return `cumPools` data.table
 #'

R/CBM-tools_gcLocatorCreate.R

@@ -0,0 +1,43 @@
+#' Create gcLocator raster layer
+#'
+#' Builds the gcLocator raster from site productivity, spatial unit, and leading species matched to
+#' a growth curve lookup table
+#'
+#' @param siteProductivity Productivity class raster layer
+#' @param spuRaster spatial unit ID raster layer
+#' @param leadSpecies leading species raster layer
+#' @param gcidLookup Table with metadata for each gcid
+#'
+#'
+#' @return `gcLocator` SpatRaster
+#'
+#' @export
+#' @importFrom data.table data.table as.data.table
+#' @importFrom terra rast
+gcLocatorCreate <- function(siteProductivity, spuRaster, leadSpecies, gcidLookup) {
+
+  #check if all rasters share the same CRS
+  if (!length(unique(lapply(list(siteProductivity, spuRaster, leadSpecies), crs))) == 1){
+    stop("Rasters do not all share the same CRS.")
+  }
+
+  #build gcTable from the raster layers
+  combine <- c(leadSpecies, spuRaster, siteProductivity)
+  gcTable <- as.data.table(combine, na.rm = FALSE)
+  setnames(gcTable, c("speciesID", "spatialunit", "prodclass"))
+  gcTable[, cell := 1:.N]
+
+  #merge gcTable with gcidLookup to get growth curve information for each pixel
+  gcTable <- merge(gcTable, gcidLookup, by = c("speciesId", "spatialunit", "prodclass"), all.x = TRUE)
+  colstokeep <- c("cell", "growthcurveid")
+  gcTable <- gcTable[, ..colstokeep]
+  setnames(gcTable, c("cell", "growthcurveid"))
+
+  #build the gcLocator raster layer
+  gcLocator <- rast(leadSpecies)
+  values(gcLocator) <- NA
+  values(gcLocator)[gcTable$cell] <- gcTable$growthcurveid
+
+  return(gcLocator)
+
+}