User Manual: Inquisit Epworth Sleepiness Scale


___________________________________________________________________________________________________________________	

									EPWORTH SLEEPINESS SCALE (ESS)
___________________________________________________________________________________________________________________	

Script Author: Katja Borchert, Ph.D. (katjab@millisecond.com) for Millisecond Software, LLC
Date: 10-09-2013
last updated:  06-12-2023 by K. Borchert (katjab@millisecond.com) for Millisecond Software, LLC

Script Copyright © 06-12-2023 Millisecond Software

___________________________________________________________________________________________________________________
BACKGROUND INFO 	
___________________________________________________________________________________________________________________
This script implements the Epworth Sleepiness Scale (ESS) as described in:
Johns, M.W. (1991). A new method for measuring daytime sleepiness: The Epworth sleepiness scale.
Sleep, 14, 540-545. 

This script uses the 1997 version of the ESS which includes a small revision of the original 1991 instructions.
The script uses radioButtons instead of textboxes.

More information on the ESS (as well as instruction revisions done in 1997):
http://epworthsleepinessscale.com/

___________________________________________________________________________________________________________________
OVERVIEW
___________________________________________________________________________________________________________________
Script offers an optional surveyPage that collects demographics (-> see section Editable Parameters parameters.skipdemographics), 
followed by a surveyPage that presents the 8 ESS questions. By default the 8 ESS questions cannot be skipped.
At the end, an optional feedback page offers feedback in the form of  the totalscore and a generic interpretation
of the ESS scores. The feedback is not original to the ESS and can be edited under section Editable Stimuli (item.feedback) 
or can be skipped altogether, see section Editable Parameters -> parameters.skipfeedback (default setting).

___________________________________________________________________________________________________________________	
DURATION 
___________________________________________________________________________________________________________________	
the default set-up of the script takes appr. 1 minute to complete

___________________________________________________________________________________________________________________	
DATA OUTPUT DICTIONARY
___________________________________________________________________________________________________________________
The fields in the data files are:

(1) Raw data file: 'ess.iqdat'

date, time:						date and time script was run with the current group/subjectnumber 
subject, group, session:	  	with the current subject/groupnumber/session id
build:							the Inquisit build 

q*_response:					response given (in assigned values)
								Scale: 0 (never) - 3 (high chance)
								no reversed scored questions
									
q*_latency:						how much time (in ms) the participant spent on the surveyPage with this particular 
								question (the last time this particular surveyPage was visited)


(2) Summary data file: 'ess_summary*.iqdat' (a separate data file per 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)

textbox.name.response:				name response if applicable (by default, demographic questions are skipped)
textbox.age.response:				age  response if applicable (by default, demographic questions are skipped)
dropdown.gender.response:			gender  response if applicable (by default, demographic questions are skipped)

totalScore:							the participant's total ESS score
									Note: 
									In general, the higher the score, the higher your daytime sleepiness.
									The general guideline is that a score at or below 10 is within normal range.

									It's important to note that 
									A) higher scores by themselves are not diagnostic of any sleep disorder.
									B) a score at or below 10 does not exclude the diagnosis of a sleep disorder.
														

Note: calculation of totalscore
Based on info from http://epworthsleepinessscale.com/ rational numbers that are not integers (e.g. 1.5) 
are sometimes chosen by  participants on the paper test. While not encouraged, choosing rational numbers 
other than integers doesn't invalidate the answer. 
The totalscore in this script takes all responses and adds them up and only then rounds it to the nearest integer.

___________________________________________________________________________________________________________________	
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:

/skipDemographics:			false = script does collect demographic data 
							true = script does NOT collect demographic data (default)
							
/skipFeedback:				false = script does provide feedback to participants
							true = script does NOT provide feedback to participants (default)
							Note: to customize feedback go to EDITABLE CODE -> Editable Stimuli