ggsave documentation updated for parameter ext

roxygenized

Author: Sebastian Kopf

R/save.r

@@ -12,6 +12,7 @@
 #' @param filename file name/filename of plot
 #' @param plot plot to save, defaults to last plot displayed
 #' @param device device to use, automatically extract from file name extension
+#'    (or from paramter \code{ext} if specified)
 #' @param path path to save plot to (if you just want to set path and not
 #'    filename)
 #' @param scale scaling factor
@@ -22,6 +23,9 @@
 #' @param limitsize when \code{TRUE} (the default), \code{ggsave} will not
 #'   save images larger than 50x50 inches, to prevent the common error of
 #'   specifying dimensions in pixels.
+#' @param ext file extension to use for choosing the correct device (pdf, jpg, png, etc.), 
+#'   uses extension of the filename by default, specify if filename does not have
+#'   an instructive extension (or none at all, e.g. in a temporary file)
 #' @param ... other arguments passed to graphics device
 #' @export
 #' @examples

man/ggsave.Rd

@@ -4,16 +4,18 @@
 \title{Save a ggplot with sensible defaults}
 \usage{
 ggsave(filename = default_name(plot), plot = last_plot(),
-  device = default_device(filename), path = NULL, scale = 1,
+  device = default_device(ext), path = NULL, scale = 1,
   width = par("din")[1], height = par("din")[2], units = c("in", "cm",
-  "mm"), dpi = 300, limitsize = TRUE, ...)
+  "mm"), dpi = 300, limitsize = TRUE, ext = default_ext(filename), ...)
 }
 \arguments{
 \item{filename}{file name/filename of plot}
 
 \item{plot}{plot to save, defaults to last plot displayed}
 
-\item{device}{device to use, automatically extract from file name extension}
+  \item{device}{device to use, automatically extract from
+  file name extension (or from paramter \code{ext} if
+  specified)}
 
 \item{path}{path to save plot to (if you just want to set path and not
 filename)}
@@ -32,7 +34,13 @@ filename)}
 save images larger than 50x50 inches, to prevent the common error of
 specifying dimensions in pixels.}
 
-\item{...}{other arguments passed to graphics device}
+  \item{ext}{file extension to use for choosing the correct
+  device (pdf, jpg, png, etc.), uses extension of the
+  filename by default, specify if filename does not have an
+  instructive extension (or none at all, e.g. in a
+  temporary file)}
+
+  \item{...}{other arguments passed to graphics device}
 }
 \description{
 ggsave is a convenient function for saving a plot.  It defaults to