File: handler_slowdown.Rd

package info (click to toggle)
r-cran-progressr 0.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,184 kB
  • sloc: sh: 13; makefile: 7
file content (44 lines) | stat: -rw-r--r-- 1,295 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/handler_slowdown.R
\name{handler_slowdown}
\alias{handler_slowdown}
\title{Progression Handler: Slow Down Progress Reporting}
\usage{
handler_slowdown(
  duration = 10,
  intrusiveness = 0,
  target = "void",
  enable = getOption("progressr.enable", TRUE),
  ...
)
}
\arguments{
\item{duration}{(numeric) Added slowdown (in seconds) across all progress
steps, e.g. if \code{duration = 10.0} and \code{steps = 100L}, then each step unit is
delayed 0.1 seconds, totaling a ten-second slowdown.}

\item{intrusiveness}{(numeric) A non-negative scalar on how intrusive
(disruptive) the reporter to the user.}

\item{target}{(character vector) Specifies where progression updates are
rendered.}

\item{enable}{(logical) If FALSE, then progress is not reported.}

\item{\ldots}{Additional arguments passed to \code{\link[=make_progression_handler]{make_progression_handler()}}.}
}
\description{
Progression Handler: Slow Down Progress Reporting
}
\details{
This progression handler delays each progress step a certain number of
seconds. It does not render any output.
}
\examples{
\donttest{\dontrun{
handlers(handler_slowdown(duration = 30.0)) ## 30-second total slowdown
with_progress(y <- slow_sum(1:100))
print(y)
}}

}