This function is designed to facilitate the development of R-based Syncrosim Packages, such as beginning, stepping, ending, and reporting the progress for a SyncroSim simulation.

progressBar(
type = "step",
iteration = NULL,
timestep = NULL,
totalSteps = NULL
)

## Arguments

type character. Update to apply to progress bar. Options include "begin", "end", "step", and "report" (Default is "step") integer. The current iteration. Only used if type = "report" integer. The current timestep. Only used if type = "report" integer. The total number of steps in the simulation. Only used if type = "begin"

## Value

No returned value, used for side effects

## Examples

if (FALSE) {
# Begin the progress bar for a simulation
progressBar(type = "begin", totalSteps = numIterations * numTimesteps)

# Increase the progress bar by one step for a simulation
progressBar(type = "step")

# Report progress for a simulation
progressBar(type = "report", iteration = iter, timestep = ts)

# End the progress bar for a simulation
progressBar(type = "end")
}