Skip to content

Commit 4af8f87

Browse files
Update README.md: clarify dataset description and expand supported experiments section
1 parent a1f2421 commit 4af8f87

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ subjects = ic.load_subjects_yaml(dataset_root / "subjects.yaml")
136136
```
137137

138138
## Synthetic example data
139-
The repository includes a small synthetic *IntelliCage*-style dataset at:
139+
The repository includes a small synthetic place learning *IntelliCage*-style dataset at:
140140

141141
```text
142142
example_data/synthetic_group_ab_place_learning
@@ -147,7 +147,7 @@ It contains two groups with ten pseudo-mice each:
147147
- `Group A`: simulated stronger place learning, better reversal adaptation, and clear saccharin preference.
148148
- `Group B`: simulated weaker place learning, stronger phase-4 perseveration at the previous correct corner, and a plain-water preference as an anhedonia-like phenotype.
149149

150-
It follows a four-phase *IntelliCage* protocol on an aligned 0-266 h analysis timeline:
150+
It follows a four-phase *IntelliCage* place learning and place reversal protocol on an aligned 0-266 h analysis timeline:
151151

152152
![IntelliCage place-learning protocol](figures/intellicage_place_learning_protocol.jpg)
153153

@@ -243,7 +243,16 @@ The analysis distinguishes raw *IntelliCage* export blocks from biological analy
243243
This makes runs with different start times, uninterrupted long exports, and
244244
interrupted recordings comparable on a common experiment timeline.
245245

246+
## Which experiments are already supported?
247+
The toolkit is designed to be extensible to any *IntelliCage* experiment. The current release support the analysis of the following experiments:
246248

249+
* General activity and locomotor cage engagement
250+
* Liquid-intake surveillance / drinking behavior
251+
* Nosepoke adaptation
252+
* Bottle preference / two-bottle choice
253+
* Place learning
254+
* Place learning and place reversal
255+
* General readouts from any phase-wise structured experiment
247256

248257
## Where to start
249258
We recommend to start with usage examples on the documentation website (will come soon). The folder `user_scripts/` contains interactive scripts that are described in the documentation and can be run cell by cell in VS Code's interactive window or in a notebook-like environment. They are designed to be run with provided example datasets (download from [Zenodo](https://doi.org/10.5281/zenodo.22181525) or from this repository, here stored in `example_data/`) or with your own *IntelliCage* data.

0 commit comments

Comments
 (0)