R/convertNGVD.R

In troyhill/EvergladesEBM: Everglades Ecosystem-Based Management

#' 
#' @title Convert between feet NAVD88 and feet NGVD29
#' 
#' @description a RasterLayer surface of elevations NAVD88 rel to NGVD29. Units = feet. to convert NAVD88 to NGVD29, add this. subtract from NGVD29 to get NAVD88.
#'
#' @name convertNGVD
#' @format RasterLayer
#' @examples 
#'  
#' \dontrun{
#' ### code used to generate object 
#' # load("C:/RDATA/EVER4cast/NGVD_to_NAVD.RData") # loads convertNGVD, generated by script
#' # writeRaster(convertNGVD, file = paste0(here::here(), "/inst/extdata/convertNGVD.grd"))
#' convertNGVD <- raster::raster(system.file("extdata/convertNGVD.grd", package = "EvergladesEBM")) 
#' convertNGVD <- raster::readAll(convertNGVD) # store full raster in memory
#' # save("convertNGVD", file =  paste0(here::here(), "/data/convertNGVD.RData"))
#' 
#' 
#' ### how to save as a SpatRaster without LazyLoad package compilation errors?
#' # load("C:/RDATA/EVER4cast/NGVD_to_NAVD.RData") # loads convertNGVD, generated by script
#' # convertNGVD <- terra::rast(system.file("extdata/convertNGVD.grd", package = "EvergladesEBM"))*1 
#' # save("convertNGVD", file =  paste0(here::here(), "/data/convertNGVD.RData"))
#' # terra::writeRaster(convertNGVD, file = paste0(here::here(), "/inst/extdata/convertNGVD.grd"),
#' # overwrite = TRUE)
#' 
#' }
NULL