R/nulldev.R

In R.devices: Unified Handling of Graphics Devices

#########################################################################/**
# @RdocFunction nulldev
#
# @title "A \"null\" graphics device voiding all output"
#
# \description{
#  @get "title".
# }
#
# @synopsis
#
# \arguments{
#   \item{file}{The output file (ignored; forced to its default).}
#   \item{...}{All other arguments are also ignored.}
# }
#
# \value{
#   A plot device is opened; nothing is returned.
# }
#
# \details{
#   The null graphics device opens a regular \link[grDevices]{pdf} device
#   and directs its output to the null file, which is \code{/dev/null} unless
#   on Windows where it is \code{NUL}.
# }
#
# \examples{\dontrun{
#   nulldev()
#   plot(1:3)
#   dev.off()
# }}
#
# \keyword{device}
#
# @author
#
# @keyword device
# @keyword internal
#*/#########################################################################
nulldev <- function(file = nullfile(), ...) {
  type <- getOption("R.devices.nulldev", "pdf")
  do.call(type, args = list(nullfile()))
}