R/save_plot.R

In SATVILab/UtilsGGSV: Utility functions for ggplot2

#' @title Save plot in multiple formats using cowplot::save_plot
#'
#' @description Wrapper around \code{cowplot::save_plot} to save plots
#' in multiple formats.
#'
#' @param filename character. Name of plot (including directory, if
#' not to save in working directory).
#' @param plot gg object. Output from either ggplot2::ggplot
#' or cowplot::plot_grid.
#' @param device character vector. Devices to save in (i.e. plot format).
#' Default is \code{c("png", "pdf")}.
#' @param ... passed on to \code{cowplot::save_plot}.
#'
#' @export
#'
#' @return \code{invisible(filename)}.
save_plot <- function(filename, plot, device = c("png", "pdf"), ...) {
  if (!requireNamespace("cowplot", quietly = TRUE)) {
    .utilsggsv_dep_install("cowplot")
  }

  filename_orig <- filename
  if (grepl(".png", filename)) {
    filename <- gsub(".png$", "", filename)
  } else if (grepl(".pdf", filename)) {
    filename <- gsub(".pdf$", "", filename)
  }
  if (!dir.exists(dirname(filename))) {
    dir.create(dirname(filename), recursive = TRUE)
  }
  for (x in device) {
    cowplot::save_plot(
      filename = paste0(filename, ".", x),
      plot = plot,
      ...
    )
  }
  invisible(filename_orig)
}

#' @title Save plot in multiple formats using cowplot::ggsave2
#'
#' @description Wrapper around \code{cowplot::ggsave2} to save plots
#' in multiple formats.
#'
#' @param filename character. Name of plot (including directory, if
#' not to save in working directory).
#' @param plot gg object. Output from either ggplot2::ggplot
#' or cowplot::plot_grid.
#' @param device character vector. Devices to save in (i.e. plot format).
#' Default is \code{c("png", "pdf")}.
#' @param ... passed on to \code{cowplot::ggsave2}.
#' 
#' @export
#'
#' @return \code{invisible(filename)}.
ggsave2 <- function(filename, plot, device = c("png", "pdf"), ...) {

  if (!requireNamespace("cowplot", quietly = TRUE)) {
    .utilsggsv_dep_install("cowplot")
  }

  filename_orig <- filename
  if (grepl(".png", filename)) {
      filename <- gsub(".png$", "", filename)
  } else if (grepl(".pdf", filename)) {
      filename <- gsub(".pdf$", "", filename)
  }
  if (!dir.exists(dirname(filename))) {
    dir.create(dirname(filename), recursive = TRUE)
  }
  for (x in device) {
    cowplot::ggsave2(
      filename = paste0(filename, ".", x),
      plot = plot,
      ...
    )
  }
  invisible(filename_orig)
}