R/generictools.R

In ilyamaclean/ecohydrotools: hydrogical modelling for ecological applications with R

#' Flexible conversion to raster object
#'
#' @description
#' `if_raster` is used to permit flexibility in the use of rasters, matrices or arrays in many functions.
#'
#' @param x an R object
#' @param r an R object
#'
#' @return if `r` is a raster, `x` is converted to a raster with the same attributes as `r`, otherwise returns `x`
#' @import raster elevatr
#' @export
#'
#' @examples
#' r <- is_raster(dtm100m)
#' r1 <- if_raster(r, dtm100m)
#' r2 <- if_raster(r, r)
#' class(r1) # is a RasterLayer
#' class(r2) # is a matrix
if_raster <- function(x, r) {
  if (class(r) == "RasterLayer")
    x <- raster(x, template = r)
  x
}
#' Checks whether object is a raster and returns a matrix if yes

#' @description
#' `is_raster` is used to permit flexibility in the use of rasters, matrices or arrays in many functions.
#'
#' @param r an R object
#'
#' @return if `r` is a raster, returns a matrix containing all values of `r`, otherwise returns `r`
#' @import raster
#' @export
#'
#' @examples
#' r <- is_raster(dtm100m)
#' class(dtm100m) # is a RasterLayer
#' class(r) # is a matrix
#' plot(r) # not a raster
#' plot(raster(r)) # converts to raster
is_raster <- function(r) {
  if (class(r) == "RasterLayer")
    r <- getValues(r, format = "matrix")
  r
}
#' internal function used for loading spatial arrays
#' @export
.loada <- function(fn) {
  aa <- load(fn)
  aa <- get(aa)
  return(aa$arraydata)
}