R/nameAndBringOn.R

In tati-micheletti/usefulFuns: Useful functions for my modules and packages

#' nameAndBringOn name's a raster, postProcess to RTM and brings it to memory.
#'
#' @param ras RasterLayer.      
#' @param RTM RasterLayer template. If a RTM is passed, the function masks the raster to it, converting 
#'            non-NA inside it to 0
#' @param name character. Name of the raster layer.
#' 
#' @return RasterLtack
#'
#' @author Tati Micheletti
#' @export
#' @importFrom raster raster setValues getValues
#' 
#' @rdname nameAndBringOn

nameAndBringOn <- function(ras, name, RTM = NULL){
  
  # Bring into memory, name and if a RTM is passed, mask non-NA inside it to 0
  names(ras) <- name
  ras[] <- ras[]
  if (!is.null(RTM)){
    ras <- postProcess(ras, rasterToMatch = RTM, filename2 = NULL, destinationPath = tempdir(), useCache = FALSE)
    rasVals <- raster::getValues(ras)
    valsRTM <- raster::getValues(RTM)
    rasVals[is.na(rasVals) & valsRTM == 1] <- 0
    ras <- raster::setValues(x = ras, values = rasVals)
  }
  return(ras)
}