This is where I perform all my analyses of the behavioral data in the three-box foraging task. This repo is organized into the following sections:
data
- this folder contains experiment data as well as any data structures generated by the code. Experiment data can be downloaded upon request and placed indata/experiments
. Pre-existing data structures useful for analysis may be found underdata/analysis
.docs
- this folder contains useful documentation about the experiment, results, etc. Some of the pdfs are directly generated from notebooks contained innotebooks
.figures
- this folder is used to contain any figures generated by scripts.notebooks
- this folder contains jupyter notebooks that interface with theforaging
package to render results and figures.- start with the
Data Cleaning.ipynb
notebook first to get an overview of the data and how it's cleaned. Then proceed to theBehavioral Analysis
and then theBelief Analysis
notebooks.
- start with the
src
- this folder contains theforaging
package, which you should install locally in your environment. See steps to setup below.
You can see the full list in the pyproject.toml
under the dependencies
field.
To install the foraging
package, cd to the root of this repo and just run pip install .
in terminal! To install in development mode, where you may wish to edit the package files, run pip install -e .
.