control_switch_pair {switchboard}

A pair of switches to toggle on/off two simulation variables.

Description

The control_switch_pair widget displays two switches to toggle the state (e.g., on or off, TRUE or FALSE) of two simulation variables. A switch is blue when "on", and gray when "off".

Arguments

inject

A vector of the two strings for each variable name to be modified/injected by the switch widget. For example, inject = c("A", "B"). These two variables should be in boolean form (e.g., 0 or 1, FALSE or TRUE).

label

A vector of two short strings designating labels/captions for each switch.

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

control_switch_pair(inject = c("", ""), label = c("", ""),
   size = 1, placeOnGrid = c(1, 1))

See Also

Other injectors: control_slider_Y_pair(), control_slider_Y(), control_slider_pair(), control_slider(), control_switch_trio(), control_switch(), injector_2D(), injector_X(), injector()

Examples

## Not run: 

     varToSlideA <- 0
     varToSlideB <- 0
     for (i in 1:500) {
       switchboard(delay = 0.01) %>%
         control_switch_pair(inject = c("varToSlideA", "varToSlideB"),
                             label = c("0 to 1", "0 to 1")) %>%
         number_pair(c(varToSlideA, varToSlideB))
     }
     switchboard_close()


## End(Not run)