R/ani.pause.R

In yihui/animation: A Gallery of Animations in Statistics and Utilities to Create Animations

#' Pause for a while and flush the current graphical device
#'
#' If this function is called in an interactive graphics device, it will pause
#' for a time interval (by default specified in
#' \code{\link{ani.options}('interval')}) and flush the current device;
#' otherwise it will do nothing.
#' @param interval a time interval to pause (in seconds)
#' @return Invisible \code{NULL}.
#' @author Yihui Xie
#' @seealso \code{\link{dev.interactive}}, \code{\link{Sys.sleep}},
#'   \code{\link{dev.flush}}
#' @export
#' @examples ## pause for 2 seconds
#' oopt = ani.options(interval = 2)
#'
#' for (i in 1:5) {
#'   plot(runif(10), ylim = c(0, 1))
#'   ani.pause()
#' }
#'
#' ani.options(oopt)
#'
#' ## see demo('Xmas2', package = 'animation') for another example
#'
ani.pause = function(interval = ani.options('interval')) {
  if (dev.interactive()) {
    dev.flush()
    Sys.sleep(interval)
  }
}