File: readxl_progress.Rd

package info (click to toggle)
r-cran-readxl 1.4.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,044 kB
  • sloc: ansic: 4,854; cpp: 3,213; makefile: 2
file content (21 lines) | stat: -rw-r--r-- 793 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/progress.R
\name{readxl_progress}
\alias{readxl_progress}
\title{Determine whether to show progress spinner}
\usage{
readxl_progress()
}
\description{
By default, readxl displays a progress spinner \strong{unless}
one of the following is \code{TRUE}:
\itemize{
\item The spinner is explicitly disabled by setting
\code{options(readxl.show_progress = FALSE)}.
\item The code is run in a non-interactive session (\code{interactive()} is \code{FALSE}).
\item The code is run by knitr / rmarkdown.
\item The code is run in an RStudio notebook chunk.
readxl uses the \href{https://cran.r-project.org/package=progress}{progress package} under-the-hood and
therefore is also sensitive to any options that it consults.
}
}