R/pr_create_vrt_mosaics.R

In lbusett/phenoriceR: Routines for analysis of PhenoRice outputs

#' @title pr_create_vrt_mosaics
#' @description helper to create virtual mosaics used in create_ordered_tiffs
#' @param mosaics_folder PARAM_DESCRIPTION
#' @param pattern PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples
#' \dontrun{
#'  #EXAMPLE1
#'  }
#' @rdname pr_create_vrt_mosaics
#' @export
#' @author Lorenzo Busetto, phD (2017) <lbusett@gmail.com>
#' @importFrom dplyr arrange
#' @importFrom gdalUtils gdalbuildvrt
#' @importFrom stringr str_split_fixed
#' @importFrom tibble tibble
#' @importFrom tools file_path_sans_ext

pr_create_vrt_mosaics <- function(mosaics_folder, pattern) {
  in_files      <- list.files(mosaics_folder, pattern = pattern, full.names = T)
  names         <- tibble::tibble(fullname = in_files,
                          shortname = basename(tools::file_path_sans_ext(in_files)))
  split_names   <- stringr::str_split_fixed(names$shortname, "_", 3)
  names         <- cbind(names, split_names,
                         or_order = seq(1:length(names$fullname)))
  names(names)  <- c("fullname", "basename", "var", "season", "year", "order")
  names <-  dplyr::arrange(names, year, season)
  ordered_files <- names$fullname

  vrt_file      <- file.path(mosaics_folder, "vrts", paste0(pattern, "_ordered.vrt"))
  dir.create(dirname(vrt_file))
  gdalUtils::gdalbuildvrt(ordered_files,
                          vrt_file,
                          separate = T,
                          overwrite = T)
}