benchmark {switchboard}

Benchmark or signal an event or achievement with a giant checkmark.

Description

The benchmark widget displays the number of simulation iterations.

Arguments

eavesdrop

The variable to track.

benchmark

The numerical value associated with eavesdrop that will trigger a visual benchmark on a widget. For example, if eavesdrop is a variable that ranges from 1 to 100, then benchmark = 50 will flag completion at the 50 value.

label

A small caption/label for the widget.

size

A number used to designate the size (magnification) of the widget. The default is set to 1 which is 80 by 80 pixels. For example, setting to 3 will results in a widget 3-times the default size (240 by 240 pixels) and will occupy a grid area of 3 by 3.

placeOnGrid

A row by column coordinate (e.g., c(row-number, column-number)) of a grid that designates the position to draw the widget on the switchboard. Use showGrid() to help organize widget placement on dashboard. The default places the first widget in pipe chain to the c(1, 1) position, and all following on the same row stacked to the right.

Value

Nothing.

Usage

benchmark(eavesdrop = NULL, benchmark = NA, label = "",
   size = 1, placeOnGrid = c(1, 1))

See Also

Other eavesdroppers: counter_tally(), counter(), eavesdropper_2D(), eavesdropper_X(), eavesdropper(), injector_2D(), injector_X(), injector(), number_pair(), number_quartet(), number_trio(), number(), progress_benchmark()

Examples

## Not run: 

   for (i in 1:250) {
     switchboard(delay = 0.01) %>%
       benchmark(i, benchmark = 125, label = ">125")
   }
   switchboard_close()


## End(Not run)