basic animation mikejohnson51#71

Author: mikejohnson51

DESCRIPTION

@@ -17,6 +17,7 @@ Imports:
     dplyr,
     future.apply,
     glue,
+    gifski,
     ncmeta,
     RNetCDF,
     terra,

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(animation)
 export(checkDodsrc)
 export(checkNetrc)
 export(climater_filter)
@@ -69,6 +70,7 @@ importFrom(dplyr,select)
 importFrom(dplyr,slice)
 importFrom(dplyr,ungroup)
 importFrom(future.apply,future_lapply)
+importFrom(gifski,save_gif)
 importFrom(glue,glue)
 importFrom(methods,formalArgs)
 importFrom(ncmeta,nc_coord_var)
@@ -91,6 +93,7 @@ importFrom(terra,extract)
 importFrom(terra,flip)
 importFrom(terra,intersect)
 importFrom(terra,merge)
+importFrom(terra,minmax)
 importFrom(terra,nlyr)
 importFrom(terra,plot)
 importFrom(terra,project)

R/catalog.R

@@ -5,11 +5,12 @@
 
 #' @importFrom dplyr filter mutate select distinct `%>%` everything mutate_all bind_rows left_join rename group_by ungroup slice
 #' @importFrom glue glue
-#' @importFrom terra intersect project vect crs ext relate rast crop flip `ext<-` `crs<-` `units<-` `time<-` union sprc merge units nlyr as.polygons plot extract time align ymax ymin xmax xmin
+#' @importFrom terra intersect project vect crs ext relate rast crop flip `ext<-` `crs<-` `units<-` `time<-` union sprc merge units nlyr as.polygons plot extract time align ymax ymin xmax xmin plot minmax
 #' @importFrom RNetCDF open.nc close.nc var.get.nc dim.inq.nc var.inq.nc utcal.nc att.get.nc 
 #' @importFrom future.apply future_lapply
 #' @importFrom ncmeta nc_coord_var nc_grid_mapping_atts nc_gm_to_prj nc_vars nc_var nc_dims
 #' @importFrom utils head tail
+#' @importFrom gifski save_gif
 #' @importFrom methods formalArgs
 #' @importFrom stats complete.cases
 

R/viz.R

@@ -0,0 +1,42 @@
+#' @title Animate SpatRast as GIF
+#' @description
+#' Animate a SpatRaster object as a gif.
+#' @param data a single SpatRast object
+#' @param AOI optional AOI sf or SpatVect object to overlay on gif
+#' @param outfile path to write gif file, must have .gif extenstion
+#' @param colors colors to plot w
+#' @return file.path
+#' @family viz
+#' @export
+
+animation = function(data, AOI = NULL, outfile, colors = blues9){
+  
+  y = terra::minmax(data, compute = TRUE)
+  
+  y = y[!is.na(y)]
+  
+  brk <- seq(min(y), max(y), (max(y) - min(y)) / length(colors))
+  n = names(data)
+  
+  gifski::save_gif({
+    for (t in 1:nlyr(data)) {
+      try({
+        terra::plot(
+          data[[t]],
+          breaks = brk,
+          col = colors ,
+          legend = T,
+          axes = F,
+          box = F,
+          main = n[t]
+        )
+        if(!is.null(AOI)){
+          plot(spatAOI(AOI), col = NULL, add = TRUE)
+        }
+        
+      }, silent = F)
+    }
+  }, gif_file = outfile, width = 800, height = 600, delay = .5, loop = TRUE)
+  
+  return(outfile)
+}

_pkgdown.yml

@@ -46,3 +46,7 @@ reference:
   desc: Parquet file exported to package dataset
   contents:
   - has_concept("catalog")
+- subtitle: Visualization
+  desc: Parquet file exported to package dataset
+  contents:
+  - has_concept("viz")