Using Variable Instruments

Brim lets you organize your variables into structured, ordered groups called instruments. Instruments help streamline large abstraction projects by providing clarity, consistency, and better navigation—especially when your project includes dozens or even hundreds of variables.

What Are Instruments?

Instruments are ordered groups of variables. Each variable can belong to one instrument.
Instruments themselves are also ordered relative to each other.
Brim automatically imports instruments (and their variable order) when you use the REDCap API or upload a CSV with defined instruments.
You can also create and manage instruments manually via Project Setup > Variables > Manage Instruments.

Managing Instruments

➕ Creating an Instrument

Go to Project Setup > Variables > Manage Instruments, then click New Instrument.

Give your instrument a name.
Select which variables should be included.
Click Save.

↕️ Reordering Instruments

In Manage Instruments, use the grab bars (≡) next to each instrument name to drag and reorder them. This order will be reflected throughout the project interface.

🎯 Adding a Variable to an Instrument

There are two ways to assign a variable to an instrument:

From Manage Instruments:

Go to Manage Instruments > Edit for the instrument you want.
Use the “Add Variables” dropdown.
Select the variable(s) in the table below, then click “Go”.

From Variable Edit:

While creating or editing a variable, click “Show Advanced Settings.”
Find the “Instrument” dropdown.
Select the instrument you want. The variable will be added to the end of that instrument.

🔀 Reordering Variables Within an Instrument

Go to Manage Instruments > Edit for the instrument in question.

Drag and drop the variables into your desired order.
Click Save to apply the new order.

❌ Removing a Variable from an Instrument

There are two ways to remove a variable from an instrument:

From Manage Instruments:

Go to Manage Instruments > Edit for the instrument.
Scroll to Actions > Remove selected variables.
Select the variable(s) in the table and click “Go.”

From Variable Edit:

While editing a variable, click “Show Advanced Settings.”
Set the Instrument dropdown to “Not assigned to an instrument.”
Save the variable.

Using Instruments in Your Workflow

Variable lists in Brim follow instrument order to match your project’s logical structure.
Filter by instrument in variable and value tables using the “Filter” dropdown to quickly find relevant content.

Instruments help keep your project organized, especially when working with large or collaborative research teams.