Skip to content

Commit a1f2421

Browse files
Refine README.md: update project description for clarity and standardize analysis explanation; reorganize example protocol details.
1 parent 4a28109 commit a1f2421

1 file changed

Lines changed: 15 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,10 @@
66
[![Example Datasets on Zenodo](https://img.shields.io/badge/Example%20Datasets-10.5281%2Fzenodo.21603005-blue)](https://doi.org/10.5281/zenodo.21603005)
77
[![Read the docs](https://badgen.net/badge/rtd/Documentation)](https://ic-analysis.readthedocs.io)-->
88

9-
A Python toolkit for analyzing *IntelliCage* experiments, including place learning, reversal, and bottle-preference workflows.
9+
A Python toolkit for standardizing the analysis of *IntelliCage* experiments.
1010

11-
The package provides reusable tools to load *IntelliCage* text exports, define experiment and subject metadata directly in Python, merge those metadata with visit and nose-poke records, compute behavioral metrics, and create publication-oriented summary plots. Raw export folders are treated as technical export blocks; biological analysis phases are defined by subject-specific time windows.
11+
The package provides reusable tools to load *IntelliCage* text exports, define experiment and subject metadata directly in Python, merge those metadata with visit and nose-poke records, compute behavioral metrics, and create publication-oriented summary plots. Raw export folders are treated as technical export blocks; biological analysis phases are defined by subject-specific time windows, ensuring standardized analysis across experiments.
1212

13-
This public repository uses synthetic example data only. Real experimental cohort data are intentionally not included.
14-
15-
## Example PLR protocol
16-
The public place-learning/reversal example follows a four-phase *IntelliCage* protocol
17-
on an aligned 0-266 h analysis timeline:
18-
19-
![IntelliCage place-learning protocol](figures/intellicage_place_learning_protocol.jpg)
20-
21-
- Phase 1, Free Hab: 0-74 h, free habituation and exploration of all corners. This may vary from 48-74 h depending on the experiment design.
22-
- Phase 2, NPA: 74-122 h, nose-poke adaptation and licking behavior.
23-
- Phase 3, PL: 122-194 h, place learning with an assigned rewarded correct
24-
corner.
25-
- Phase 4, PR: 194-266 h, place reversal with a new rewarded corner and
26-
tracking of visits to the previous correct corner.
2713

2814
## Installation
2915
The toolkit requires Python 3.12 or newer.
@@ -161,6 +147,17 @@ It contains two groups with ten pseudo-mice each:
161147
- `Group A`: simulated stronger place learning, better reversal adaptation, and clear saccharin preference.
162148
- `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.
163149

150+
It follows a four-phase *IntelliCage* protocol on an aligned 0-266 h analysis timeline:
151+
152+
![IntelliCage place-learning protocol](figures/intellicage_place_learning_protocol.jpg)
153+
154+
- Phase 1, Free Hab: 0-74 h, free habituation and exploration of all corners. This may vary from 48-74 h depending on the experiment design.
155+
- Phase 2, NPA: 74-122 h, nose-poke adaptation and licking behavior.
156+
- Phase 3, PL: 122-194 h, place learning with an assigned rewarded correct
157+
corner.
158+
- Phase 4, PR: 194-266 h, place reversal with a new rewarded corner and
159+
tracking of visits to the previous correct corner.
160+
164161
The run-group folders intentionally start at different real clock times: Group
165162
A begins on 2026-01-05 at 06:00, while Group B begins 7.5 h later at 13:30.
166163
This demonstrates why real phase `time_window` values are stored per subject.
@@ -217,7 +214,6 @@ The script writes compact result tables and figures to:
217214
example_data/synthetic_group_ab_place_learning/results
218215
```
219216

220-
Generated result folders are ignored by Git. They can be safely recreated from the synthetic input data and analysis script.
221217

222218
## Metric definitions
223219
The workflow keeps several place-learning metrics in parallel:
@@ -230,10 +226,8 @@ The workflow keeps several place-learning metrics in parallel:
230226
Correct-corner visits with nose-poke and licking divided by all visits.
231227
- `bottle_preference`
232228
Left/right nose-poke-side licking summarized as raw bottle consumption or as a bounded preference fraction, e.g. `right_bottle / (left_bottle + right_bottle)`.
233-
- `matlab_placeerror_only`
234-
Legacy-compatible definition based on `PlaceError == 0`.
235229

236-
For phase 4, the toolkit also separates:
230+
For a place reversal phase in a place learning experiment, the toolkit also separates:
237231

238232
- visits to the new correct corner
239233
- visits to the previous correct corner
@@ -252,7 +246,7 @@ interrupted recordings comparable on a common experiment timeline.
252246

253247

254248
## Where to start
255-
We recommend to start with usage examples on the documentation website. 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 with your own *IntelliCage* data.
249+
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.
256250

257251
## Citation
258252
If you use the *IntelliCage Analysis Toolkit* in scientific work, please cite it as follows:

0 commit comments

Comments
 (0)