소스 검색

Add more detail to readme

Davide Crombie 1 개월 전
부모
커밋
91393d817a
1개의 변경된 파일26개의 추가작업 그리고 9개의 파일을 삭제
  1. 26 9
      README.md

+ 26 - 9
README.md

@@ -7,12 +7,14 @@ Data and code for Crombie et al. "Spiking activity in the visual thalamus is cou
 ### 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.
+Data for this project is stored as pickled Pandas DataFrame objects. The "raw" data files, including `pupil_*.pkl`, `spikes_*.pkl`, `ball_*.pkl`, and `trials_*.pkl`, contain 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.
 
-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
+**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.
+
+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 
@@ -30,9 +32,24 @@ Spike type : --spk_type -s
 - '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'
+- 'run' : bouts of locomotion
+- 'sit' : behavioral quiescence (no locomotion)
+- 'nosaccade' : periods with no saccadic eye movements
+- 'noopto' : trials without optogenetic stimulation
+- 'desync' : 
 - 'sizematched'
+
+**Note** : the `imf_decoding.py` script will automatically look for `phasetuning` data from the `noopto` time ranges.
+
+Analysis and plotting parameters are stored in `parameters.py`. Useful, general-purpose functions are stored in the `util.py` module.
+
+## Nomenclature
+Experimental units are defined using a MSEU nomenclature: mouse (the strain, year, and ID of a mouse, e.g. 'PVCre_2020_0001'), series (recording session, during which several experimental stimulation protocols are carried out, e.g. 's01'), experiment (a single experiment, e.g. e01), unit (a putative neuron identified by spike sorting, e.g. 'u10').
+
+The folloing terms are used interchangeably:
+
+Intrinsic mode function (IMF) == component of pupil dynamics (CPD) == timescale
+- a component resulting from application of Empirical Mode Decomposition (EMD) to the pupil size timeseries
+
+Characteristic frequency == frequency == timescale
+- the value (1/seconds) used to characterise a CPD by taking the mean amplitude-weighted instantaneous frequency