progressr (version 0.5.0)

progression: A Progression Condition

Description

A progression condition represents a progress in an R program.

Usage

progression(
  message = character(0L),
  amount = 1,
  step = NULL,
  time = progression_time,
  ...,
  type = "update",
  class = NULL,
  progressor_uuid = NULL,
  progression_index = NULL,
  progression_time = Sys.time(),
  call = NULL,
  owner_session_uuid = NULL
)

Arguments

message

(character) A progress message.

amount

(numeric) The total amount of progress made.

step

(character or integer) The step completed.

time

(POSIXct) A timestamp.

type

Type of progression made.

class

(character) Zero or more class names to prepend.

progressor_uuid

(character string) A character string that is unique for the current progressor and the current R session.

progression_index

(integer) A non-negative integer that is incremented by one for each progression condition created.

progression_time

(POSIXct or character string) A timestamp specifying when the progression condition was created.

call

(expression) A call expression.

owner_session_uuid

(character string) A character string that is unique for the R session where the progressor was created.

…

Additional named elements.

Value

A base::condition of class progression.

See Also

To signal a progression condition, use base::signalCondition(). To create and signal a progression condition at once, use progress().