The glamour subdue me

NAMESPACE

@@ -22,6 +22,7 @@ export(predict_sdm)
 export(rastpointplot)
 export(save_plot)
 export(set_layer_names)
+export(set_levels)
 export(source_R)
 export(split_rast)
 export(standardise_rast)

R/set_levels.R

@@ -0,0 +1,37 @@
+#' @title set levels
+#' @description
+#' Convenience function for setting `SpatRaster` levels names to enable setting in
+#' piped workflows.
+#'
+#'
+#' @param x `SpatRaster`
+#' @param levs `data.frame`
+#'
+#' @return `SpatRaster`
+#' @export
+#'
+#' @examples
+#' \dontrun{
+#' categorical_raster |>
+#'  set_levels(
+#'   levs = tribble(
+#'     ~value, ~category,
+#'     30, "URBAN CENTRE",
+#'     23, "DENSE URBAN CLUSTER",
+#'     22, "SEMI-DENSE URBAN CLUSTER",
+#'     21, "SUBURBAN OR PERI-URBAN",
+#'     13, "RURAL CLUSTER",
+#'     12, "LOW DENSITY RURAL",
+#'     11, "VERY LOW DENSITY RURAL",
+#'     10, "WATER"
+#'    )
+#'   ) %>%
+#'     as.data.frame()
+#' }
+#'
+set_levels <- function(x, levs){
+
+  levels(x) <- levs
+
+  x
+}