Project model

Table of contents

  1. Introduction
  2. Fields
  3. Permissions
  4. API access

Introduction

Projects serve as a primary means to group subjects, sessions, and collections together. A project can be used to relate experiments for publications, describe day-to-day experiments, or share experimental data with collaborators. Projects define the overall permissions level of most other content.

Fields

FieldDescription
NameName of the project (required; string; maximum length: 200 characters; must be unique across BrainSTEM). Example: “Hippocampal Memory Study 2024”, “Visual Cortex Development Project”
DescriptionA text description of the project. You can upload and insert images through rich text formatting. Example: “This project investigates place cell activity in the CA1 region of the hippocampus…”
PublicationsRelated publications. Can link multiple publications to a project. Example: “Smith et al. 2024 Nature”, “Garcia 2023 Science”
TagsTags for the project. Great for organizational purposes and quick labeling, quick labeling, and filtering. Tags are shared across all users. Example: “electrophysiology”, “behavior”, “hippocampus”
Extra fieldsAllows you to add extra fields to the project. Values can be strings or numeric. Saved as key-value pairs. Example: {“Ethics_Protocol”: “2024-001”, “Funding”: “NIH R01”}
Name used in storageUse this field if you have another name for your project in your local data storage (string; maximum length: 200 characters). Example: “HPC_MEM_24”
Online repositoriesIf this project has been shared in a online public repository, link it here. Example: Links to DANDI (dandiset-123456) or OpenNeuro (ds000123)
Users with rolesUsers associated with the project and their assigned roles. Example: Lab PI as owner, postdoc as manager, students as contributors

Permissions

Projects define the overall permissions level for subjects, sessions, collections, cohorts, and modules. You manage permissions through the management tab, where you can assign individual users and groups access levels to a project.

Projects have four permission levels: membership (read access), contributors, managers, and owners.

Visit the permissions page to learn more.

API access

The API allows for programmable access to projects. Learn more about the projects’ fields and data structure on the Project API page.