Link Search Menu Expand Document

Dataset model

Table of contents

  1. Introduction
  2. Dataset fields
  3. Types of environment type
  4. Permissions
  5. Dataset API access

Introduction

Setups describe where experiments, procedures, or manipulations takes place. It also describes the environment of a recorded subject. Setups has physical dimensions and equipments associate with it.

Dataset fields

FieldDescription
NameName of the setup (required)
Environment typeThe type of environment the setup is of (required)
Authenticated groupsGroups that have change permissions for this setup (required)
DescriptionText description of the setup
ImageImage of the setup
Public accessDetermines if the setup is public or private
Physical dimensionsAny physical dimensions used to describe the setup. Each dimension is a name value pair with any associated units or description.

Types of environment type

  • Barnes maze
  • Circular track
  • Elevated plus maze
  • Elevated zero maze
  • Figure eight maze
  • Forced swim test
  • Head-fixed disc
  • Homecage
  • Linear Track
  • Morris water maze
  • Open field environment
  • Radial arm maze
  • Running wheel
  • Sleepbox
  • Square cage
  • Theta maze
  • T-maze
  • Y-maze
  • Other

Permissions

Setups define the overall permissions level for equipments. You manage permissions through the management tab, where you can assign individual users and groups access levels to a setup. Setup have four permission levels: membership (read access), contributors, managers, and owners.

Equipments inherit permissions from their associated setup.

Visit the permissions page to learn more.

Dataset API access

The API allows for programmable access to setups, enabling you to read, edit, and delete Setups through the API. Learn more about the datasets’ fields and data structure on the Dataset API page.