build site

README.Rmd

@@ -47,8 +47,7 @@ This catalog is an [evolving, federated collection of datasets](https://github.c
 3. A set of [shortcuts](https://mikejohnson51.github.io/climateR/reference/index.html#shortcuts) that implement these methods for a core set of selected catalog elements
 
 
-> :warning: **Python Users**: Access the to data catalogs is available through the USGS [`gdptools`](https://gdptools.readthedocs.io/en/latest/) package. Directly analogous climateR functionality can be found in [`climatePy`](https://github.com/LynkerIntel/climatePy)
-
+> :warning: **Python Users**: Data catalog access is available through the USGS [`gdptools`](https://gdptools.readthedocs.io/en/latest/) package. Directly analogous climateR functionality can be found in [`climatePy`](https://github.com/LynkerIntel/climatePy)
 
 # Installation
 
@@ -86,6 +85,17 @@ system.time({
 plot(d$precipitation_amount)
 ```
 
+# Basic Animation
+
+```{r, eval = FALSE}
+animation(d$precipitation_amount, AOI = AOI, "man/figures/ex_gif.gif")
+```
+
+```{r, echo = FALSE}
+knitr::include_graphics("man/figures/ex_gif.gif")
+```
+!["man/ex_gif.gif"]("man/ex_gif.gif")
+
 # Integration with `zonal`
 
 ```{r}

README.md

@@ -45,10 +45,9 @@ be accessed by the data access utilities.
     that implement these methods for a core set of selected catalog
     elements
 
-> :warning: **Python Users**: Access the to data catalogs is available
-> through the USGS
-> [`gdptools`](https://gdptools.readthedocs.io/en/latest/) package.
-> Directly analogous climateR functionality can be found in
+> :warning: **Python Users**: Data catalog access is available through
+> the USGS [`gdptools`](https://gdptools.readthedocs.io/en/latest/)
+> package. Directly analogous climateR functionality can be found in
 > [`climatePy`](https://github.com/LynkerIntel/climatePy)
 
 # Installation
@@ -81,11 +80,20 @@ system.time({
                endDate  = "1991-11-06")
 })
 #>    user  system elapsed 
-#>   0.257   0.056   1.223
+#>   0.225   0.060   5.582
 ```
 
 <img src="man/figures/README-unnamed-chunk-7-1.png" width="100%" />
 
+# Basic Animation
+
+``` r
+animation(d$precipitation_amount, AOI = AOI, "man/figures/ex_gif.gif")
+```
+
+<img src="man/figures/ex_gif.gif" width="100%" />
+![“man/ex_gif.gif”](%22man/ex_gif.gif%22)
+
 # Integration with `zonal`
 
 ``` r
@@ -95,7 +103,7 @@ system.time({
   county = zonal::execute_zonal(d, geom = AOI, ID = "fip_code")
 })
 #>    user  system elapsed 
-#>   0.421   0.025   0.494
+#>   0.332   0.013   0.347
 ```
 
-<img src="man/figures/README-unnamed-chunk-9-1.png" width="100%" />
+<img src="man/figures/README-unnamed-chunk-11-1.png" width="100%" />