User Manual: Inquisit Progressive Ratio Button Press Task


___________________________________________________________________________________________________________________	

								*Progressive Ratio Button Press Task*
___________________________________________________________________________________________________________________	

Script Author: Katja Borchert, Ph.D. (katjab@millisecond.com) for Millisecond Software, LLC
Date: 07-06-2020
last updated:  02-25-2022 by K. Borchert (katjab@millisecond.com) for Millisecond Software, LLC

Script Copyright © 02-25-2022 Millisecond Software

___________________________________________________________________________________________________________________
BACKGROUND INFO 	
___________________________________________________________________________________________________________________	

This script implements a template for a progressive ratio button press task to investigate 
approach-avoidance behavior towards different stimulus categories. This template script implements the 
following four categories as example categories:
1) Alcohol Bottle Images
2) Soda Bottle Images
3) Scrambled Alcohol Bottle Images
4) Scrambled Soda Bottle Images

The implemented procedure is based on:
Ferrey, A. E., Frischen, A., & Fenske,M. J. (2012). Hot or not: Response inhibition reduces the hedonic value 
and motivational incentive of sexual stimuli. Frontiers in Psychology, 3, 1–7.

___________________________________________________________________________________________________________________
TASK DESCRIPTION	
___________________________________________________________________________________________________________________	

Participants get the choice to view one image of four different categories (here: alcohol bottles, soda bottles,
scrambled alcohol bottles, scrambled soda bottles).
In order to view the image they have to press the assigned response key for the category of choice.
The number of key presses required to view an image a particular category doubles each time
the participant selects to view an image of that specific category.

___________________________________________________________________________________________________________________	
DURATION 
___________________________________________________________________________________________________________________	
the default set-up of the script takes appr. 8 minutes to complete

___________________________________________________________________________________________________________________	
DATA FILE INFORMATION 
___________________________________________________________________________________________________________________		
The default data stored in the data files are:

(1) Raw data file: 'progressiveratio_raw*.iqdat' (a separate file for each participant)*

build:							The specific Inquisit version used (the 'build') that was run
computer.platform:				the platform the script was run on (win/mac/ios/android)
date, time: 					date and time script was run 
subject, group: 				with the current subject/groupnumber
session:						with the current session id

blockcode, blocknum:			the name and number of the current block (built-in Inquisit variable)
trialcode, trialnum: 			the name and number of the currently recorded trial (built-in Inquisit variable)
									Note: trialnum is a built-in Inquisit variable; it counts all trials run; even those
									that do not store data to the data file. 
										
roundCount:						the round counter
countImages_round:				counts the number of images presented during the current round

category1_responseButton:		the assigned key (1-4) for category1 during the current round
category2_responseButton:		the assigned key (1-4) for category2 during the current round
category3_responseButton:		the assigned key (1-4) for category3 during the current round
category4_responseButton:		the assigned key (1-4) for category4 during the current round										
										
presentedStim:					the presented image 
	
response:						scancode of selected response button
									!Note:
									scancode 2 => button 1 was pressed
									scancode 3 => button 2 was pressed
									scancode 4 => button 3 was pressed
									scancode 5 => button 4 was pressed									
									57 = spacebar
 
latency:						response time (in ms); measured from onset of trial

selectedCategory:				stores the selected category
									1 => here: alcohol bottles
									2 => here: soda bottles
									3 => here: scrambled alcohol bottles
									4 => here: scrambled soda bottles

category1_countPresses:			the number of key presses for category1 during the current round 
category1_currentThreshold:		the number of key presses required to view image of category1 during the current round 
category1_totalPresses:			sums up all key presses for category1 across all rounds
category1_CountImages:			the number of category1 images presented across all rounds
(same for category2-4)									

(2) Summary data file: 'progressiveratio_summary*.iqdat' (a separate file for each participant)*

inquisit.version:				Inquisit version run
computer.platform:				the platform the script was run on (win/mac/ios/android)
startdate:						date script was run
starttime:						time script was started
subjectid:						assigned subject id number
groupid:						assigned group id number
sessionid:						assigned session id number
elapsedtime:					time it took to run script (in ms); measured from onset to offset of script
completed:						0 = script was not completed (prematurely aborted); 
								1 = script was completed (all conditions run)
									
category1_totalPresses:			sums up all key presses for category1 across all rounds
category1_CountImages:			the number of category1 images presented across all rounds
(same for category2-4)								
							
							
* separate data files: to change to one data file for all participants (on Inquisit Lab only), go to section
"DATA" and follow further instructions

___________________________________________________________________________________________________________________	
EXPERIMENTAL SET-UP 
___________________________________________________________________________________________________________________	

8 rounds: each round presents 10 images
- each round randomly assigns the response buttons 1-4 to the four categories
- the required counts for each category are reset (each category starts with 1 button press)

Trial Sequence:

StartTrial
- the button press counts are reset for each category back to 0 

CategorySelection: 
-participants press key 1-4 to make a selection
=> the script keeps a count of all button presses for each category
=> after each button press the script compares the number of button presses made to the number
of button presses required to present the image of a category
=> if the required number has been reached, the image presentation trial is called;
Otherwise the categorySelection trial is repeated.

Image Presentation:
- the selected image is presented for 1s (editable parameter)
- the required counts for the currently selected category are doubled 


Note: this script only provides 10 images per category. Thus each round uses the same 10 images for
each category. To ensure that no image is ever repeated, each category requires 80 images.
Add the needed images under 'Editable Stimuli' and follow further instructions provided.

___________________________________________________________________________________________________________________
STIMULI
___________________________________________________________________________________________________________________
provided by Millisecond Software - the provided images are only demonstration images.
They can be edited under section Editable Stimuli

___________________________________________________________________________________________________________________	
INSTRUCTIONS 
___________________________________________________________________________________________________________________	
provided by Millisecond Software - can be edited under section Editable Instructions
___________________________________________________________________________________________________________________	
EDITABLE CODE 
___________________________________________________________________________________________________________________	
check below for (relatively) easily editable parameters, stimuli, instructions etc. 
Keep in mind that you can use this script as a template and therefore always "mess" with the entire code 
to further customize your experiment.

The parameters you can change are: