Behavioral Assay model

Table of contents

  1. Introduction
  2. How it fits together
  3. Example
  4. Fields
  5. Permissions
  6. API access

Introduction

A behavioral assay is your lab’s specific implementation of a behavioral paradigm. While paradigms describe the shared conceptual task (e.g., “Morris Water Navigation Task”), an assay captures how your lab actually runs it — the specific protocol, parameters, and setup type used.

How it fits together

BrainSTEM organizes behavioral experiments through a hierarchy that separates shared scientific knowledge from lab-specific implementation details:

  • Behavioral Category — The broad domain (e.g., “Anxiety & Affect” → “Anxiety”)
  • Behavioral Paradigm — The standardized task shared across the field (e.g., “Elevated Plus Exploration”)
  • Behavioral Assay (this page) — Your lab’s specific implementation of a paradigm under a specific preparation condition, linking a paradigm to a setup type (e.g., “EPM 5-min test”)
  • Behavior — The actual execution of an assay within a session, tied to specific subjects and a physical setup

Categories and paradigms are shared taxonomies available to everyone. Assays are lab-specific — they belong to your groups and capture exactly how you run a paradigm.

Example

LevelExample
ParadigmElevated Plus Exploration
Assay“EPM 5-min test” — single 5-min session, 300 lux open arms, setup type: Elevated Plus Maze (Freely Moving Awake)
BehaviorRat #7, Session 2024-06-01, ran assay “EPM 5-min test” on setup “EPM Rig B, Room 108”

Fields

FieldDescription
Behavioral assay nameA descriptive name for this assay, ideally indicating the paradigm and key protocol details (e.g., “MWM 4-day acquisition” or “EPM 5-min test”) (required; string; maximum length: 50 characters).
Setup categoryCategory of setup conditions associated with the selected setup type (e.g., Freely Moving Awake, Head-Fixed Awake).
Setup typeThe preparation condition under which this assay is run — a setup type encodes both the physiological state of the subject (e.g., Freely Moving Awake) and the class of apparatus (e.g., “Elevated Plus Maze”). This constrains which physical setups can be used when recording a behavior (required). Must reference an existing setup type.
Behavioral categoryThe taxonomy category that organizes the selected behavioral paradigm (e.g., “Learning & Memory”).
Behavioral paradigmThe shared paradigm this assay implements (required). Must reference an existing behavioral paradigm.
LicensesLicenses that authorize this assay for regulatory and compliance tracking. Can include multiple licenses.
DescriptionProtocol details — trial structure, timing, parameters, and any lab-specific variations.
Authenticated groupsAssign one or more groups during creation. Assigned groups receive change permissions; permissions can be adjusted later on the manage page (required).
Public accessDesignates if the behavioral assay is publicly available (boolean; default: False). Must be enabled for assays used in public projects. Only owners can modify this setting.

Permissions

Behavioral assays have four permission levels: membership (read access), change permissions, managers, and owners. You manage permissions through the management tab.

Visit the permissions page to learn more.

API access

The API allows for programmable access to behavioral assays, enabling you to read, edit, and delete assays through the API. Learn more about the fields and data structure on the Behavioral assay API page.