R/figure_write.R

In metagear: Comprehensive Research Synthesis Tools for Systematic Reviews and Meta-Analysis

#' Saves/writes a figure image.
#'
#' Writes a figure image to file and returns the file name.    
#'
#' @param aFigure The \code{EBImage} figure.
#' @param file Name and location of file to save.  Supports .jpg, .png, and
#'    .tiff image formats.
#' @return Vector of file names.
#'
#' @seealso \code{\link{figure_read}}
#' 
#' @export

figure_write <- function (aFigure,
                          file = NULL) {
    
  # if EBImage not installed, do it
  .metagearDependencies("EBImage")
  
  # save EBImage to file
  return (EBImage::writeImage(aFigure, file))
}