R/progress.R

In hadley/readxl: Read Excel Files

#' Determine whether to show progress spinner
#'
#' @description By default, readxl displays a progress spinner **unless**
#'   one of the following is `TRUE`:
#' * The spinner is explicitly disabled by setting
#'   `options(readxl.show_progress = FALSE)`.
#' * The code is run in a non-interactive session (`interactive()` is `FALSE`).
#' * The code is run by knitr / rmarkdown.
#' * The code is run in an RStudio notebook chunk.
#' readxl uses the [progress
#' package](https://cran.r-project.org/package=progress) under-the-hood and
#' therefore is also sensitive to any options that it consults.
#' @export
readxl_progress <- function() {
  ## based on readr:::show_progress()
  isTRUE(getOption("readxl.show_progress", default = TRUE)) &&
    interactive() &&
    !isTRUE(getOption("knitr.in.progress")) &&
    !isTRUE(getOption("rstudio.notebook.executing"))
}