Bool Option

The Bool option represents a boolean (true/false) value.

Description

In the jamovi UI, a Bool option is typically represented by a Checkbox. It is ideal for toggling specific statistics, plots, or analysis settings.

YAML Properties

PropertyTypeDescription
namestringThe unique name of the option.
typestringMust be Bool.
titlestringThe label displayed in the UI.
defaultbooleanThe default value (true or false). Defaults to false.

R Implementation

In R, a Bool option is represented as a logical value (TRUE or FALSE).

Examples

1. Define in YAML

- name: welch
  type: Bool
  title: Welch's
  default: false

2. Implementation in R

Access the value using self$options$name:

if (self$options$welch) {
    # Perform Welch's t-test
}