How to Add a Total Sample Category to a Single Selection Control

This article describes how to include a Total sample category within an R filter variable that is connected to a single selection control box.

Combo Box.png

Requirements

A control box (created via Control from the toolbar) with Control > Selection mode set to Single selection.
A filter variable that references this control box.

See the "Method - manual" section of How to Create a Combo Box Filter for instructions on how to set up the required elements.

Method

In this example, we have a single filter variable connected to a control box (Household.Status.combo.box), which is based on the Status variable.

If you generated the filter variable as an Advanced filter using the Automatic method outlined in How to Create a Combo Box Filter, our condition will look like this:

In this case, the variable name under Properties > General > General > Name is bXQBLY.

The matching logic is as follows if the original filter variable is R-based:

Status %in% Household.Status.combo.box

To add a Total sample category to the above, you can follow these steps:

1. Select the combo box control on your page.

2. Add Total sample to your control box via Control > Item list in Properties .

This will place Total sample at the top of your control item list.

3. Select your filter R variable in the Data Sources tree.

4. From Properties , select Data > R Code - Data > Edit Code.

5. Paste the code below into the Code panel. The general way for setting up a Total sample option for mutually exclusive data is to do so via an if/else statement in your code:

For Advanced filter variables, the code in this case would be:

if (Household.Status.combo.box == "Total sample") {
  rep(TRUE, length(id))
} else {
  bXQBLY
}

And this is the code when only using R:

if (Household.Status.combo.box == "Total sample") {
  rep(TRUE, length(id))
} else {
  Status %in% Household.Status.combo.box
}

Here, we need to reference the Total sample selection item by wrapping our existing condition within an if/else statement.
To do this, we can use the rep function and reference the length of a variable which matches the total number of records in the file, i.e. id.
This will then generate a TRUE or 1 for every record in the data set if Total sample is selected, otherwise it will return the individual filter category.

6. Once you've updated the code above to reference your specific combo box and variables, click Calculate.

How to Work with R in Displayr

How to Connect Filters to Controls Using R Code

How to Create a Combo Box Filter

How to Create a List Box Filter

How to Insert a Text Box

How to Create a Combo Box (Drop-Down Control) With a Dynamic List