Updated documentation

danieljwilson · Jul 10, 2019 · 50394f8 · 50394f8
1 parent 6f4c4f0
commit 50394f8
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 119 deletions.
diff --git a/docs/pages/data-analysis.rst b/docs/pages/data-analysis.rst
@@ -15,6 +15,8 @@ SciNet
 ------
 
 
+CONTINUE FROM HERE
+
 The `data preprocessing notebook`_ contains the code for:
 
 - Import data from dropbox

diff --git a/docs/pages/experiment-details.rst b/docs/pages/experiment-details.rst
@@ -2,151 +2,86 @@
 Experiment Details
 ==================
 
+Recall that the experiment protocol is located on Dropbox at:
+``DJW_Projects/02_FOOD_REG/PAPERWORK/fMRI_Food_Regulation_Experiment_Protocol.gdoc``
+
+
 ---------
 Main Task
 ---------
 
-----------
-Localizers
-----------
-
---------------
-Questionnaires
---------------
-
-
-All versions of the project were created in `Psychopy`_.
-The code for all `experiment versions`_ is on github.
-
-.. note::
+The main task involved three discreet phases.
 
-    Versions 1 and 2 were made with the Builder interface.
-    Version 3 was written in plain Python using the Psychopy 3 toolbox.
+1. Pre-Scan
 
-.. _experiment versions: https://github.com/danieljwilson/MADE/tree/master/3_experiment/3_1_inputs/versions
-.. _Psychopy: https://www.psychopy.org/
-
-====
-
-The current iterations of the project include:
+   - Food liking ratings
+   - Main task training
 
----
-v1
----
+2. Scan
 
-Description
------------
-- 1,2,3 multipliers
+   - In-scanner trials
 
-Goal
------
-- Disambuguate atribute weights from attribute evaluation
-- Test whether value and weighting affect subject attention
+     - 9 runs
 
----
-v2
----
+3. Post-Scan
 
-Description
------------
-- Additional multipliers (0.1, 0.5, 1, 2, 3, 10)
+   - Food liking ratings (repeated)
+   - Food taste ratings
+   - Food health ratings
 
-Goal
------
-- Test response to fractional weights
-- Calculate subjects' weighting curve to wider range of weights
+=====
 
-------
-v3.0.1
-------
+The code for the Main Task (including the instructions)
+was written in ``MATLAB`` and uses `Psychtoolbox`_.
 
-Description
------------
-- Both multipliers onscreen simultaneously (0.1, 0.33, 0.5, 1, 2, 3, 10)
+The `Main Task Code`_ includes many files, but the key scripts are:
 
-Goal
------
-- Test whether subjects bias their first/total
-  fixation to the higher multiplier
+- ``runPreMRI.m``
 
-------
-v3.0.2
-------
+  - Launches the experiment instructions and the initial Food Liking Rating
 
-Description
------------
-- Accuracy incentive
-- Both multipliers onscreen simultaneously (0.1, 0.33, 0.5, 1, 2, 3, 10)
+- ``runSession.m``
 
+  - Launches a run of the experiment in-scanner
 
-Goal
------
-- Test whether subjects try harder with an accuracy incentive,
-  rather than a cumulative payoff
+- ``runPostMRI.m``
 
-    * This avoids the most difficult trials having the lowest value/cost
+  - Launches the post task ratings of Liking, Taste, and Health
 
-------
-v3.1.0
-------
-
-Description
------------
-
-- Time pressure (low)
-- Accuracy incentive
-- Both multipliers onscreen simultaneously (0.1, 0.33, 0.5, 1, 2, 3, 10)
+.. _Psychtoolbox: http://psychtoolbox.org/
+.. _Main Task Code: https://github.com/danieljwilson/cogReg_fMRI/tree/master/3_experiment/3_1_inputs/main_matlab
 
+----------
+Localizers
+----------
 
-Goal
------
-- Test whether time pressure increases the likelihood of biasing
-  first fixation toward the higher weighted stimulus
+The localizer task invovled two descreet phases.
 
-------
-v3.1.1
-------
+1. Pre-Scan
 
-Description
------------
+   - Localizer task training
 
-- Time pressure (low/high/no)
-- Accuracy incentive
-- Both multipliers onscreen simultaneously (0.1, 0.5, 1, 2, 3, 10)
+2. Scan
 
-Goal
------
-- Test whether time pressure increases the likelihood of biasing
-  first fixation toward the higher weighted stimulus under three conditions.
+   - In-scanner trials
 
-------
-v3.2.0
-------
+     - go-nogo: 2 runs
+     - switching task: 1 run
 
-Description
------------
+The code for the Localizers was written in ``Python``,
+using the `Psychopy`_ toolbox.
 
-- Full choice (multipliers and images)
-- Accuracy incentive
-- (0.1, 0.5, 1, 2, 3, 10)
+There are two key scrtips CONTINUE FROM HERE
 
-Goal
------
-- Test whether a stimulus (base value) or multiplier (weight)
-  bias exists.
+.. _Psychopy: https://www.psychopy.org/
 
-------
-v3.3.0
-------
+--------------
+Questionnaires
+--------------
 
-Description
------------
+Upon completion of all tasks we asked subjects to
+complete the following questionnaires:
 
-- Bias test: Attractiveness
-- Accuracy incentive
-- (0.1, 0.5, 1, 2, 3, 10)
+1. CONTINUE FROM HERE
 
-Goal
------
-- Test whether subjects over-weight attractive vs. unattractive
-  faces
+LINK TO QUESTIONNAIRES GOOGLE SHEET
diff --git a/docs/pages/getting-started.rst b/docs/pages/getting-started.rst
@@ -10,15 +10,17 @@ experiment and analyze data yourself.
 Running the Experiment
 ----------------------
 
-
-The experiment runs using Psychopy 3.1.
-
 The experiment protocol can be found on Dropbox at
-``DJW_Projects/01_MADE/PAPERWORK/MADE_v3_Protocol.gdoc``
+``DJW_Projects/02_FOOD_REG/PAPERWORK/fMRI_Food_Regulation_Experiment_Protocol.gdoc``
+
+The protocol includes information regarding:
 
-The questionnaire is hosted on Qualtrix.
-Contact daniel.j.wilson@gmail.com for login information.
+- Booking Scanner Time
+- Recruiting Participants
+- Running Study
 
+The study questionnaire is a Google Form, and lives on the lab's
+Google Drive account.
 
 ----------------------
 Updating Documentation