R/write_scales.R

In wilsonfrantine/landscapeDecoupler: Landscape Decoupler: Tools for Multi-scale Landscape Analysis

#' @description  This function saves each uncoupled scale as file
#' @export write_scales
#' @name write_scales
#' @title write scales
#' @author Wilson Frantine-Silva
#' @param x an output of decouple function or a list of raster files
#' @param buffer.names a vector of names same length as buffer scales or number of raster files on the list to be saved. If null, rasters will be saved as layers names.
#' @param format one of the valids output in rgdal package or raster native defaults. For details, see raster::writeRaster help.
#' @param path a path to save raster. Working directory is the default
#' @param overwrite a boolean whether to overwrite files. TRUE by default
#' @param bylayer a boolean whether to save files by layers in raster file. See bylayer in raster::writeRaster.
#' @seealso decouple, raster::writeRaster, raster::writeFormats
#' @param ... any other convinient param from raster::writeRaster

write_scales <- function(x=NULL, buffer.names=NULL, format='GTiff', path=NULL, overwrite=T, bylayer=F, ...){
  if(is.null(x)){
    stop("A list of raster has been not provided. Check if you have a list of raster as input")
  }

  if(is.null(path)){
    path<-getwd()
  }else if(!dir.exists(path)){
    dir.create(path)
  }
  for (i in 1:length(x)){
    raster <- x[[i]]
    if(is.null(buffer.names)){
      buffer.names <- names(raster)
    }
     raster::writeRaster(raster,
                filename=file.path(path, paste0(as.character(names(x)[i]))),
                format=format,
                bylayer= bylayer,
                suffix = buffer.names,
                overwrite=T,
                progress="text")
  }
}