Learn R Programming

bbotk (version 0.3.1)

Progressor: Progressor

Description

Wraps progressr::progressor() function and stores current progress.

Arguments

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()

Method setup()

Creates progressr::progressor().

Usage

Progressor$setup(terminator, archive)

Arguments

terminator

(Terminator).

archive

(Archive).

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

deep

Whether to make a deep clone.