Dataset model
Table of contents
Introduction
A dataset is a modular construction that flexibly can describe various aspect of experiments based on four basic modules:
- Experiment data: Description of the data collected during the experiment
- Manipulations: Description of any manipulations performed during an experiment
- Behavior: Description of the behavior of the animal subject
- Epochs: Temporal aspects of a dataset
Dataset fields
| Field | Description | |
|---|---|---|
| Name | Name of the dataset (required; string; max length: 100; must be unique across datasets) | |
| Description | A rich text description of the dataset | |
| Projects | Any projects the dataset belongs to. Learn more about the project inheritance [here] (required) | |
| Date and time | Date and time of the onset of the dataset (YYYY-MM-DD string containing date, e.g. “2023-03-22”) | |
| Datarepositories | Data repositories | |
| Extra fields | Allows you to add extra fields to the dataset. The values can be a string or a numeric value | |
| Download links | JSON dictionary | name value pairs allowing you to add extra content |
| Name used in repository | Custom name for a dataset used in an organization in a repository (string; max length: 200) | |
| Tags | Tags for the dataset. Tags are great for organizational purpose, to quickly label a dataset and can be used as a filter afterwards |
Epoch fields
| Field | Description |
|---|---|
| Name | Name of the epoch (required; a string; max length: 100) |
| Start | Start time of the epochs. The start time is relative to the onset of the dataset (the date and time field of the dataset) |
| End | End time of the epochs. The start time is relative to the onset of the dataset (the date and time field of the dataset) |
| Behavior | Behavior associated with the epoch |
| Experiment data | Experiment data associated with the epoch |
| Manipulation | A manipulation associated with the epoch |
Experiment data fields
Please see the dedicated page describing the [Experiment data model].
Manipulation data fields
Please see the dedicated page describing the [Manipulations data model].
Behavior data fields
Please see the dedicated page describing the [Behavior data model].
Permissions
The dataset inherits permissions from projects associated with it. Data repositories are shared through the projects groups, and you are only able to add a data repository associated with the same groups as the selected projects. The relationships in module data also depends on the selected projects
Visit the [permissions page] to learn more.
Dataset API access
The API allows for programmable access to datasets. Learn more about the datasets’ fields and data structure on the Dataset API page.