R/create_dirs.R

In igapfill: Interface for Gap-Filling Earth Observation Datasets

#' Creates a set of directories which are an essential part of the general workflow
#' of this package
#' 
#' Using the directory provided by \code{path} as root this function
#' creates the sub-directory \emph{/gapfill} with sub-folders \emph{/gapfill/filled}, 
#' \emph{/gapfill/master}, \emph{/gapfill/output}, \emph{/gapfill/progressReports} and \emph{/gapfill/splits}.
#' 
#' @param      path character, full path indicating the directory containing the images
#'                  to process with \code{\link[gapfill]{Gapfill}}.
#' @param startYear numeric, indicates the starting time-point, on the annual scale, 
#'                  of a time series of satellite images to process.
#' @param   endYear numeric, indicates the ending time-point, on the annual scale, 
#'                  of a time series of satellite images to process.
#' 
#' @export
#' 
#' @return At the location indicated by \code{path}, the abovementioned directories
#' will be created.
#' 
create_dirs <- function(path, startYear, endYear){
  dir.create( path = paste0(path, "/gapfill") )
  dir.create( path = paste0(path, "/gapfill/output") )
  dir.create( path = paste0(path, "/gapfill/filled") )
  dir.create( path = paste0(path, "/gapfill/splits") )
  dir.create( path = paste0(path, "/gapfill/master") )
  
  for(year in startYear:endYear){
    dir.create( path = paste0(path, "/gapfill/splits/", year) )
  }
  dir.create( path = paste0(path, "/gapfill/progressReports") )
  
  message( colorText("Done, check output at ", 216),
           colorText(path, 159) ) 
}