R/write_plots.R

In bcgov/fasstr: Analyze, Summarize, and Visualize Daily Streamflow Data

# Copyright 2019 Province of British Columbia
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
# http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and limitations under the License.

#' @title Write plots from a list into a directory or PDF document
#'
#' @description Write a list of plots (ggplots; as used by \code{fasstr}) into a directory or PDF document. 
#'    When writing into a named directory each plot will be named by the plot name listed in the list; uses \code{ggplot2::ggsave}
#'    function. When writing into a PDF document (\code{combined_pdf == TRUE}) the plot names will not appear; uses 
#'    \code{grDevices::pdf} function.
#'
#' @param plots List of plots to write to disk.
#' @param folder_name Name of folder to create on disk (if it does not exist) to write each plot from list. 
#'    If using \code{combined_pdf} argument, then it will be the name of the PDF document.
#' @param plot_filetype Image type to write. One of \code{'png'}, \code{'eps'}, \code{'ps'}, \code{'tex'}, \code{'pdf'}, \code{'jpeg'}, 
#'    \code{'tiff'}, \code{'bmp'}, or \code{'svg'}. Image type will be overwritten if using \code{combined_pdf} is used.
#' @param width Numeric plot width in \code{units}. If not supplied, uses the size of current graphics device.
#' @param height Numeric plot height in \code{units}. If not supplied, uses the size of current graphics device.
#' @param units Character string plot height and width units, one of \code{'in'}, \code{'cm'}, or \code{'mm'}. Default \code{'in'}.
#' @param dpi Numeric resolution of plots. Default \code{300}.
#' @param combined_pdf Logical value indicating whether to combine list of plots into one PDF document. Default \code{FALSE}.
#'
#' @examples
#' \dontrun{
#' 
#' # Working examples:
#' 
#' # Example plots to save
#' plots <- plot_annual_lowflows(station_number = "08NM116")
#' 
#' # Write the plots as "png" files
#' write_plots(plots = plots, 
#'             folder_name = "Low Flow Plots",
#'             plot_filetype = "png")
#' 
#' # Write the plots as a combined "pdf" document
#' write_plots(plots = plots, 
#'             folder_name = "Low Flow Plots",
#'             combined_pdf = TRUE)
#'             
#' }
#' @export

write_plots <- function(plots,
                        folder_name,
                        plot_filetype,
                        width,
                        height,
                        units = "in",
                        dpi = 300,
                        combined_pdf = FALSE){
  
  # ARGUMENT CHECKS
  # ---------------
  
  if (missing(plots)) {
    plots <- NULL
  }
  if (missing(folder_name)) {
    stop("Must provide a name of a folder name to creating using the folder_name argument.", call. = FALSE)
  }
  if (missing(plot_filetype)) {
    plot_filetype <- NULL
  }
  if (missing(width)) {
    width <- NA
  }
  if (missing(height)) {
    height <- NA
  }
  
  # Check list of plots
  if (is.null(plots)) stop("Must provide a list of plots.", call. = FALSE)
  if (!is.list(plots)) stop("Object provided is a not a list.", call. = FALSE)
  if (!all(sapply(plots, inherits, what = "gg"))) stop("Not all objects in list are plots.", call. = FALSE)
  
  # Check device type
  if (!combined_pdf) {
    if (is.null(plot_filetype)) stop("Must provide an image plot_filetype to save.", call. = FALSE)
    if (!plot_filetype %in% c("png", "eps", "ps", "tex", "pdf", "jpeg", "tiff", "bmp", "svg")) 
      stop("Use of the file types required.", call. = FALSE)
  } else {
    if (!is.null(plot_filetype)) {
      plot_filetype %in% c("png", "eps", "ps", "tex", "jpeg", "tiff", "bmp", "svg")
      message("plot_filetype argument is not 'pdf', using combine_pdf = TRUE will change it to 'pdf'.")
    }   
  }
  
  # Check dimensions
  if ((!is.na(height) & !is.numeric(height)))
    stop("height argument must be numeric.", call. = FALSE)
  if (length(height) !=1) stop("Only one height value can be provided.", call. = FALSE)
  
  if ((!is.na(width) & !is.numeric(width)))
    stop("width argument must be numeric.", call. = FALSE)
  if (length(width) !=1) stop("Only one width value can be provided.", call. = FALSE)
  
  if (length(units) != 1)  stop("only one unit type can be provided.", call. = FALSE)
  if (!units %in% c("in", "cm", "mm"))  stop("Only units of 'in', 'cm', or 'mm' can be provided.", call. = FALSE)
  
  
  # SAVE PLOTS
  # ----------
  
  # Create a single PDF document
  if(combined_pdf) { 
    
    # Remove slash if folder_name ends with it
    if (substr(folder_name, nchar(folder_name), nchar(folder_name)) == "/") {
      folder_name <- substr(folder_name, 1, nchar(folder_name)-1)
    }
    
    # Check dimensions for PDF device
    if(is.na(width)) {
      width <- grDevices::dev.size(units = units)[1]
    }
    
    if(is.na(height)) {
      height <- grDevices::dev.size(units = units)[2]
    }
    
    # Plot plots to PDF device
    grDevices::pdf(file = paste0(folder_name, ".pdf"), 
                   width = width, 
                   height = height,
                   title = "R Graphics Output - fasstr")
    for (i in names(plots)) {
      suppressWarnings(graphics::plot(plots[[i]]))
    }
    grDevices::dev.off()
    if (!is.null(grDevices::dev.list())) {
      grDevices::dev.off()    
    }
    message(paste0("Successfully created PDF file ", folder_name, ".pdf with all plots."))
    
    
  } else {
    
    # Create a folder of plots
    
    # Check if folder exists, create if not
    dir.create(folder_name, showWarnings = FALSE)
    
    # Add the slash to folder_name if it doesn't exist
    if (!substr(folder_name, nchar(folder_name), nchar(folder_name)) == "/") {
      folder_name <- paste0(folder_name, "/")
    }
    
    # Filter through each plot
    for (i in names(plots)) {
      suppressWarnings(ggplot2::ggsave(filename = paste0(folder_name, i, ".", plot_filetype), 
                                       plot = plots[[i]],
                                       width = width,
                                       height = height,
                                       units = units,
                                       dpi = dpi))
    }
    
    message(paste0("Successfully created folder ", folder_name, " with all plots."))
    
    
  }
  
  
  
}