R/rasterizeTRMM.R

In environmentalinformatics-marburg/heavyRain: Download and Pre-Process CHIRPS and TRMM Rainfall Data Sets in R

#' Rasterize TRMM 3B42 Data
#'
#' @description
#' Rasterize TRMM 3B42 .bin or .HDF files.
#'
#' @param x TRMM 3B42 file(s) as \code{character}. Currently supported filetypes
#' are .bin .HDF, and .nc4. Note that \code{\link{rasterizeTRMMbin}} takes one
#' file only.
#' @param ... Additional arguments passed to \code{\link{rasterizeTRMMbin}} or
#' \code{\link{rasterizeTRMMhdf}}.
#'
#' @return
#' \itemize{
#' \item{\strong{.bin files}: A single \code{RasterLayer} object.}
#' \item{\strong{.HDF files}: A \code{list} of \code{Raster*} objects.}
#' }
#'
#' @author
#' Florian Detsch
#'
#' @seealso
#' \code{\link{getTRMM}}, \code{\link{readBin}},
#' \code{\link{rasterizeTRMMbin}}, \code{\link{rasterizeTRMMhdf}}.
#'
#' @examples
#' \dontrun{
#' ## download 3-hourly TRMM 3B42 data from Jan 1, 2015
#' fls <- getTRMM(begin = "2015-01-01", end = "2015-01-01",
#'                     type = "3-hourly")
#' fls[1]
#'
#' ## rasterize
#' library(rworldmap)
#' eth <- subset(countriesCoarse, ADMIN == "Ethiopia")
#' rst <- rasterizeTRMM(fls, ext = eth)
#'
#' ## visualize
#' plot(rst[[1]])
#' }
#'
#' @export rasterizeTRMM
#' @name rasterizeTRMM
rasterizeTRMM <- function(x, ...) {

  filetype <- strsplit(x, "\\.")
  filetype <- unique(sapply(filetype, "[[", length(filetype[[1]])))

  if (length(filetype) > 1)
    stop("Please make sure all files in 'x' are of the same filetype.\n")

  if (filetype %in% c("HDF", "hdf")) {
    rasterizeTRMMhdf(x, ...)
  } else if (filetype %in% c("BIN", "bin")) {
    rasterizeTRMMbin(x, ...)
  } else if (filetype == "nc4") {
    rasterizeTRMMnc4(x, ...)
  } else {
    stop("Provided filetype currently not supported, see ?rasterizeTRMM. \n")
  }
}