| Progressor {bbotk} | R Documentation |
Progressor
Description
Wraps progressr::progressor() function and stores current progress.
Public fields
progressor(
progressr::progressor()).max_steps(
integer(1)).current_steps(
integer(1)).unit(
character(1)).
Methods
Public methods
Method new()
Creates a new instance of this R6 class.
Usage
Progressor$new(progressor, unit)
Arguments
progressor(
progressr::progressor())
Progressor function.unit(
character(1))
Unit of progress.
Method update()
Updates progressr::progressor() with current steps.
Usage
Progressor$update(terminator, archive)
Arguments
terminator(Terminator).
archive(Archive).
Method clone()
The objects of this class are cloneable with this method.
Usage
Progressor$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
[Package bbotk version 1.0.1 Index]