ggplot wrappers for scfm rasters

DESCRIPTION

@@ -8,8 +8,8 @@ Description: The original fire model is described by Cumming et al. (1998),
 URL: https://scfmutils.predictiveecology.org,
     https://github.com/PredictiveEcology/scfmutils,
     https://predictiveecology.github.io/scfmutils/
-Date: 2024-06-05
-Version: 0.0.13.9002
+Date: 2024-06-18
+Version: 0.0.13.9003
 Authors@R: c(
     person("Steve", "Cumming", email = "[email protected]",
            role = c("aut")),
@@ -42,7 +42,9 @@ Imports:
     SpaDES.tools (>= 2.0.0),
     stats,
     terra,
-    tools
+    tidyterra,
+    tools,
+    viridis
 Suggests:
     bcdata,
     googledrive,

NAMESPACE

@@ -24,7 +24,11 @@ export(hatP0)
 export(makeAndExecuteDesign)
 export(makeDesign)
 export(pTE)
+export(plot_ageMap)
+export(plot_burnMap)
 export(plot_fireRegimePolys)
+export(plot_fireRegimeRas)
+export(plot_flammableMap)
 export(prepInputsFireRegimePolys)
 export(qTE)
 export(qqTE)
@@ -53,8 +57,11 @@ importFrom(ggplot2,geom_point)
 importFrom(ggplot2,geom_sf)
 importFrom(ggplot2,geom_text)
 importFrom(ggplot2,ggplot)
+importFrom(ggplot2,ggtitle)
 importFrom(ggplot2,labs)
+importFrom(ggplot2,scale_fill_brewer)
 importFrom(ggplot2,scale_fill_discrete)
+importFrom(ggplot2,scale_fill_distiller)
 importFrom(ggplot2,scale_x_continuous)
 importFrom(ggplot2,scale_y_continuous)
 importFrom(ggplot2,theme_bw)
@@ -104,4 +111,6 @@ importFrom(terra,res)
 importFrom(terra,setValues)
 importFrom(terra,unwrap)
 importFrom(terra,values)
+importFrom(tidyterra,geom_spatraster)
 importFrom(tools,file_path_sans_ext)
+importFrom(viridis,scale_fill_viridis)

R/plot_wrappers.R

@@ -17,6 +17,87 @@ plot_fireRegimePolys <- function(fireRegimePolys) {
 
   ggplot(fireRegimePolys) +
     geom_sf(aes(fill = PolyID)) +
-    scale_fill_discrete() +
-    theme_minimal()
+    scale_fill_discrete() + ## TODO: use same palette as plot_fireRegimeRas ??
+    theme_bw()
+}
+
+#' Plot fire regime raster
+#'
+#' @param x `SpatRaster` object corresponding to a fire regime raster
+#'
+#' @param title character, the plot title
+#'
+#' @return `ggplot` object
+#'
+#' @export
+#' @importFrom ggplot2 ggplot ggtitle scale_fill_brewer theme_bw
+#' @importFrom tidyterra geom_spatraster
+plot_fireRegimeRas <- function(x, title) {
+  ggplot() +
+    geom_spatraster(data = terra::as.factor(x)) +
+    scale_fill_brewer(palette = "Paired", type = "qual", na.value = "transparent") +
+    ggtitle(title) +
+    theme_bw()
+}
+
+#' Plot age map
+#'
+#' @param x `SpatRaster` object corresponding to stand age or time since disturbance map
+#'
+#' @param title character, the plot title
+#'
+#' @param maxAge the maximum age to plot
+#'
+#' @return `ggplot` object
+#'
+#' @export
+#' @importFrom ggplot2 ggplot ggtitle scale_fill_distiller theme_bw
+#' @importFrom tidyterra geom_spatraster
+plot_ageMap <- function(x, title, maxAge) {
+  x[x > maxAge] <- maxAge
+
+  ggplot() +
+    geom_spatraster(data = x) +
+    scale_fill_distiller(palette = "Greens", direction = 1, na.value = "transparent") +
+    ggtitle(title) +
+    theme_bw()
+}
+
+#' Plot burn maps
+#'
+#' @param x `SpatRaster` object corresponding to a current or cumulative burn map.
+#'
+#' @param title character, the plot title
+#'
+#' @return `ggplot` object
+#'
+#' @export
+#' @importFrom ggplot2 ggplot ggtitle theme_bw
+#' @importFrom tidyterra geom_spatraster
+#' @importFrom viridis scale_fill_viridis
+plot_burnMap <- function(x, title) {
+  ggplot() +
+    geom_spatraster(data = x) +
+    scale_fill_viridis(na.value = "transparent") +
+    ggtitle(title) +
+    theme_bw()
+}
+
+#' Plot flammable map
+#'
+#' @param x `SpatRaster` object corresponding to a flammability map.
+#'
+#' @param title character, the plot title
+#'
+#' @return `ggplot` object
+#'
+#' @export
+#' @importFrom ggplot2 ggplot ggtitle scale_fill_distiller theme_bw
+#' @importFrom tidyterra geom_spatraster
+plot_flammableMap <- function(x, title) {
+  ggplot() +
+    geom_spatraster(data = x) +
+    scale_fill_distiller(palette = "RdBu", na.value = "transparent") +
+    ggtitle(title) +
+    theme_bw()
 }