瀏覽代碼

Add more detail to readme

Davide Crombie 1 月之前
父節點
當前提交
b71e2e9406
共有 1 個文件被更改,包括 32 次插入3 次删除
  1. 32 3
      README.md

+ 32 - 3
README.md

@@ -2,7 +2,36 @@
 
 Data and code for Crombie et al. "Spiking activity in the visual thalamus is coupled to pupil dynamics across temporal scales"
 
-### How to
-To generate figures from already processed data, copy the .pkl files out of data/original_cooked/ into data/ and then run the corresponding cells in the figures notebooks. Note that notebook cells should be run in order to avoid variable name conflicts.
+## How to
 
-To re-generate the processed data, run the corresponding .py file with the desired arguments. The primary argument is the experiment name, which can be 'spontaneous', 'sparsenoise', 'dark', 'natmov', and 'natmov_opto'. 
+### Figures
+To generate figures from already processed data, copy the `*.pkl` data files out of `data/original_cooked/` and `data/original_raw` into `data/` and then run the corresponding cells in the `figures_*.ipynp` Jupyter notebooks. Note that notebook cells should be run in order to avoid variable name conflicts. Figures will by default be stored in the `figures/` folder, which also contains sub-folder
+
+**Note** : Because many of the analyses involve randomization (e.g. comparison to random permutations of the data), the original figures may only be *exactly* reproduced by using the data files from the `original_cooked` folder.
+
+### Analyses
+Data for this project is stored as "pickled" Pandas DataFrame objects. The "raw" data, including `pupil_*.pkl`, `spikes_*.pkl`, `ball_*.pkl`, and `trials_*.pkl`, are minimally-processed data to be used in further analyses.
+
+To re-generate the processed ("cooked") data, run the corresponding `*.py` file with the desired arguments. The positional argument `e_name` specifies the experiment name, and is required for all scripts. It can be one of
+
+- 'spontaneous' : experiments where the monitor displayed a uniform gray screen 
+- 'sparsenoise' : experiments with sparse noise visual stimulation 
+- 'dark' : experiments where the display monitor was switched off and other sources of illumination were covered 
+- 'natmov' : experiments with repeated trial of a naturalistic video clip
+- 'natmov_opto' : experiments with repeated trials of a naturalistic video clip, trials with optogenetic stimulation of V1 PV neurons are interleaved pseudo-randomly
+
+**Note** : Spontaneous and sparse noise experiments are generally analyzed together, but the analysis scripts need to be run separately for each experiment type.
+
+Other arguments may include:
+
+Spike type : --spk_type -s
+- 'tonicskp' : tonic spikes, i.e. all spikes that are not part of a burst
+- 'burst' : burst events, i.e. the first spike in a burst
+- 'spk' : all spikes, i.e. any spike regardless of whether it is part of a burst or not
+
+Time ranges : --tranges -t 
+- 'run'
+- 'sit'
+- 'nosaccade'
+- 'noopto' 
+- 'desync'