# Formatted data for: Bergmann, Sehara _et al._, 2022

Formatted data set for the "AirtrackMotorPlanning" project (examines whether whiskers and pupil positions predict the animal's motor plans).

The dataset stored here is part of the [root data repository](https://gin.g-node.org/larkumlab/Bergmann_2022_DataRepository), and it is:

- used for the analysis in the paper.
- based on the [raw](https://gin.g-node.org//larkumlab/Ronny_Bergmann_AirtrackMotorPlanning_RawData), [whisker-tracking](https://gin.g-node.org//larkumlab/Ronny_Bergmann_AirtrackMotorPlanning_TrackedWhiskerPositions), and [eye-tracking](https://gin.g-node.org//larkumlab/Ronny_Bergmann_AirtrackMotorPlanning_TrackedEyePositions) datasets.



### Contents

- [File organization](#file-organization)
- [`TRIALS.csv`](#trials-csv)



## File organization

### File names

The files are organized as: `<ANIMAL>/<SESSION>/<DOMAIN>/<ANIMAL>_<SESSION>_<DOMAIN>_run<TRIAL>`, where:

- `ANIMAL` representing the ID of the animal (in the pattern `MLAxxxxxx`).
- `SESSION` being the name of the session (in the pattern `sessionYYYY-MM-DD-001`).
- `DOMAIN` representing the domain of recording (see below).
- `TRIAL` being the trial index during the session.

### Domain names

| Domain name    | Description                                                  |
| -------------- | ------------------------------------------------------------ |
| tracking       | whisking radius and angles, pupil positions and diameters, aligned with the 200 Hz trial timebase. |
| states         | CSV files containing manual annotation of behavioral states based on the top-view videos, trial-based. Merely the copy from the raw data. |
| merged-video   | the top-view videos overlaid with eye videos, along with the annotated behavioral states, in the form of single videos. The video quality is not so high. Used for visual examination of video alignment. |
| annotated-plot | the plot of whisking angles, eye positions, and annotated behavioral states, in the form similar to Figure 1 of the paper. |

## `TRIALS.csv`

Each session directory has the `TRIALS.csv` file, including information about the state of alignment between the top-view and eye videos. The columns represent:

- `Trial`: the index of the trial
- `ContextCoupling`:
- `EyeVideos`: the status of the eye videos.
  - `OK`: the eye videos are aligned nicely with the top-view videos.
  - `OutOfSync`: the eye videos and the top-view videos seem to record different trials, so they cannot be analyzed together.
  - `NoVideos`: no recording of eye videos seem to have occurred.

----

Copyright (c) 2022, [Ronny Bergmann](https://orcid.org/0000-0002-1477-7502), [Keisuke Sehara](https://orcid.org/0000-0003-4368-8143), Sina E. Dominiak, [Julien Colomb](https://orcid.org/0000-0002-3127-5520), [Jens Kremkow](https://orcid.org/0000-0001-7077-4528), [Matthew E. Larkum](https://orcid.org/0000-0001-9799-2656), [Robert N. S. Sachdev](https://orcid.org/0000-0002-6627-0199), [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)