R/gdevice.R

In TobieSurette/gulf.graphics: Southern Gulf Graphics Functions

#' Prepare Graphics Device
#'
#' @description A wrapper function to prepare a graphics device for output.
#'
#' @param type Character string specifying the type of graphics device to be created (e.g. 'pdf', 'jpg', ...).
#' @param file File name, excluding file extension suffix.
#' @param width,height Dimensions in inches.
#' @param layout Specify plot layout of graphics device.
#'
#' @examples
#' gdevice("pdf", "Test.pdf")
#' gdevice() # Equivalent to 'dev.new()'.
#' plot(runif(100), runif(100))
#' dev.off()

#' @export
gdevice <- function(type = "", file, width = 8.5, height = 8.5, layout, ...){
   if (missing(file)) type <- ""
   if (type == ""){
      if (.Platform$OS.type == "unix") quartz(width = width, height = height, ...)
      if (.Platform$OS.type == "windows") windows(width = width, height = height, ...)
   }
   type <- gsub("jpg", "jpeg", tolower(type))
   
   if (type == "jpeg") jpeg(file = paste0(file, ".jpg"), width = width * 480, height = height * 480, res = 8.5 * 75, ...)
   if (type == "png")  png(file = paste0(file, ".png"), width = width * 480, height = height * 480, res = 8.5 * 75, ...)
   if (type == "pdf")  pdf(file = paste0(file, ".pdf"), width = width, height = height, ...)
   
   if (!missing(layout)){
      if (is.null(layout)) if (length(layout) == 1) layout <- 1:layout
      if (is.vector(layout)) layout <- matrix(layout, byrow = TRUE)
      layout <- kronecker(layout, matrix(1,nrow = 5, ncol = 5))
      layout <- rbind(0, cbind(0, layout, 0), 0, 0)
      layout(layout)
      par(mar = c(0,0,0,0))
   }
}