R/waysToSplit.R

In igapfill: Interface for Gap-Filling Earth Observation Datasets

#' Brief report on ways to split a Raster* object
#' 
#' Based on the passed arguments, this function returns three messages
#' at the console. First, the number of \emph{splits} for the Raster* object.
#' Second, the number of rows and third, the number of columns of each split.
#' 
#' @param      h numeric, parts in which number of columns of \code{raster} will be
#'               split
#' @param      v numeric, parts in which the number of rows of \code{raster} will be
#'               split
#' @param raster Raster* object to be split
#' 
#' @export
#' 
#' @importFrom raster ncol
#' @importFrom raster nrow
#' 
#' @details For an abuse of language, here we use the term \emph{split} to signify
#' \emph{cell} or \emph{crop}, which in the context of handling geo-referenced data structures
#' are more common terms.
#' 
#' @return At the console, there will be a summary indicating the number of \emph{splits}
#' for the Raster* object as well as the number of rows and columns of each \emph{split}.
#' 
waysToSplit <- function(h,v,raster){

  colCELL <- ncol(raster)/h
  rowCELL <- nrow(raster)/v
  
  message(colorText("With these arguments, there will be:", 80))
  
  splitText <- paste(h*v, "splits")
  cat(colorText(splitText, 9), colorText(" each having", 80), "\n")
  cat(colorText("nROW", 200), colorText(paste0(" = ", rowCELL), 80), "\n")
  cat(colorText("nCOL", 118), colorText(paste0(" = ", colCELL), 80), "\n")
  
  
}