Create a Progressor Function that Signals Progress Updates
Create a Progressor Function that Signals Progress Updates
progressor(
steps = length(along),
along = NULL,
offset = 0L,
scale = 1L,
transform = function(steps) scale * steps + offset,
message = character(0L),
label = NA_character_,
trace = FALSE,
initiate = TRUE,
auto_finish = TRUE,
on_exit = !identical(envir, globalenv()),
enable = getOption("progressr.enable", TRUE),
envir = parent.frame()
)steps |
(integer) Number of progressing steps. |
along |
(vector; alternative) Alternative that sets
|
offset, scale |
(integer; optional) scale and offset applying transform
|
transform |
(function; optional) A function that takes the effective
number of |
message |
(character vector or a function) If a character vector, then
it is pasted together into a single string using an empty separator.
If a function, then the message is constructed by |
label |
(character) A label. |
trace |
(logical) If TRUE, then the call stack is recorded, otherwise not. |
initiate |
(logical) If TRUE, the progressor will signal a progression 'initiate' condition when created. |
auto_finish |
(logical) If TRUE, then the progressor will signal a progression 'finish' condition as soon as the last step has been reached. |
on_exit, envir |
(logical) If TRUE, then the created progressor will
signal a progression 'finish' condition when the calling frame exits.
This is ignored if the calling frame ( |
enable |
(logical) If TRUE, progression conditions are signaled when calling the progressor function created by this function. If FALSE, no progression conditions is signaled because the progressor function is an empty function that does nothing. |
A function of class progressor.
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.