Setup types model

Table of contents

  1. Introduction
  2. Fields
  3. Submission process
  4. Permissions
  5. Setup types API access

Introduction

Setup types are fundamentally categories of setups and also serve as categories for behavioral paradigms. In BrainSTEM, setup types are a shared model across users. Behavioral paradigms are linked to a specific setup type, ensuring that each paradigm is defined within a particular type of setup.

Fields

FieldDescription
Name of setup typeThe name of the setup type (required; string; maximum length: 200 characters; must be unique)
Category of the setup typeThe category of the setup type (required). Selected from predefined categories (In Vitro, Ex Vivo, Anesthetized In Vivo, Head-Fixed Awake, Voluntarily Stationary Awake, Freely Moving Awake, Unknown)
DescriptionA general description of the setup type (optional; maximum length: 2000 characters)
Adding/editing commentsComments for the submission/approval process (optional).

Submission process

Anyone can submit new setup types or suggest changes to existing ones. However, all submissions must be approved before they become available for usage. Please refer to existing entries for examples of what to submit.

Permissions

Once an entry has been approved, it becomes available to all users.

Setup types API access

The API allows for programmable access to setup types, enabling you to read, edit, and delete entries through the API. Learn more about the setup types’ fields and data structure on the Setup types API page.