You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a1f2421
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+15-21Lines changed: 15 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,10 @@
6
6
[](https://doi.org/10.5281/zenodo.21603005)
7
7
[](https://ic-analysis.readthedocs.io)-->
8
8
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.
10
10
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.
12
12
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
- 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.
27
13
28
14
## Installation
29
15
The toolkit requires Python 3.12 or newer.
@@ -161,6 +147,17 @@ It contains two groups with ten pseudo-mice each:
161
147
-`Group A`: simulated stronger place learning, better reversal adaptation, and clear saccharin preference.
162
148
-`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.
163
149
150
+
It follows a four-phase *IntelliCage* protocol on an aligned 0-266 h analysis timeline:
Generated result folders are ignored by Git. They can be safely recreated from the synthetic input data and analysis script.
221
217
222
218
## Metric definitions
223
219
The workflow keeps several place-learning metrics in parallel:
@@ -230,10 +226,8 @@ The workflow keeps several place-learning metrics in parallel:
230
226
Correct-corner visits with nose-poke and licking divided by all visits.
231
227
-`bottle_preference`
232
228
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`.
235
229
236
-
For phase 4, the toolkit also separates:
230
+
For a place reversal phase in a place learning experiment, the toolkit also separates:
237
231
238
232
- visits to the new correct corner
239
233
- visits to the previous correct corner
@@ -252,7 +246,7 @@ interrupted recordings comparable on a common experiment timeline.
252
246
253
247
254
248
## 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.
256
250
257
251
## Citation
258
252
If you use the *IntelliCage Analysis Toolkit* in scientific work, please cite it as follows:
0 commit comments