jspsych 6.3.0 → 7.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (397) hide show
  1. package/README.md +36 -37
  2. package/css/jspsych.css +39 -39
  3. package/dist/JsPsych.d.ts +112 -0
  4. package/dist/TimelineNode.d.ts +34 -0
  5. package/dist/index.browser.js +3164 -0
  6. package/dist/index.browser.js.map +1 -0
  7. package/dist/index.browser.min.js +2 -0
  8. package/dist/index.browser.min.js.map +1 -0
  9. package/dist/index.cjs +3158 -0
  10. package/dist/index.cjs.map +1 -0
  11. package/dist/index.d.ts +11 -0
  12. package/dist/index.js +3152 -0
  13. package/dist/index.js.map +1 -0
  14. package/dist/migration.d.ts +3 -0
  15. package/dist/modules/data/DataCollection.d.ts +45 -0
  16. package/dist/modules/data/DataColumn.d.ts +15 -0
  17. package/dist/modules/data/index.d.ts +25 -0
  18. package/dist/modules/data/utils.d.ts +3 -0
  19. package/dist/modules/extensions.d.ts +22 -0
  20. package/dist/modules/plugin-api/HardwareAPI.d.ts +15 -0
  21. package/dist/modules/plugin-api/KeyboardListenerAPI.d.ts +34 -0
  22. package/dist/modules/plugin-api/MediaAPI.d.ts +27 -0
  23. package/dist/modules/plugin-api/SimulationAPI.d.ts +41 -0
  24. package/dist/modules/plugin-api/TimeoutAPI.d.ts +5 -0
  25. package/dist/modules/plugin-api/index.d.ts +8 -0
  26. package/dist/modules/plugins.d.ts +129 -0
  27. package/dist/modules/randomization.d.ts +35 -0
  28. package/dist/modules/turk.d.ts +40 -0
  29. package/dist/modules/utils.d.ts +7 -0
  30. package/package.json +32 -15
  31. package/src/JsPsych.ts +884 -0
  32. package/src/TimelineNode.ts +536 -0
  33. package/src/index.ts +71 -0
  34. package/src/migration.ts +37 -0
  35. package/src/modules/data/DataCollection.ts +198 -0
  36. package/src/modules/data/DataColumn.ts +86 -0
  37. package/src/modules/data/index.ts +174 -0
  38. package/src/modules/data/utils.ts +75 -0
  39. package/src/modules/extensions.ts +23 -0
  40. package/src/modules/plugin-api/HardwareAPI.ts +32 -0
  41. package/src/modules/plugin-api/KeyboardListenerAPI.ts +165 -0
  42. package/src/modules/plugin-api/MediaAPI.ts +337 -0
  43. package/src/modules/plugin-api/SimulationAPI.ts +181 -0
  44. package/src/modules/plugin-api/TimeoutAPI.ts +16 -0
  45. package/src/modules/plugin-api/index.ts +28 -0
  46. package/src/modules/plugins.ts +158 -0
  47. package/src/modules/randomization.ts +327 -0
  48. package/src/modules/turk.ts +99 -0
  49. package/src/modules/utils.ts +30 -0
  50. package/.github/workflows/jest.yml +0 -20
  51. package/code-of-conduct.md +0 -56
  52. package/contributors.md +0 -61
  53. package/docs/CNAME +0 -1
  54. package/docs/about/about.md +0 -18
  55. package/docs/about/contributing.md +0 -43
  56. package/docs/about/license.md +0 -25
  57. package/docs/about/support.md +0 -7
  58. package/docs/core_library/jspsych-core.md +0 -734
  59. package/docs/core_library/jspsych-data.md +0 -589
  60. package/docs/core_library/jspsych-pluginAPI.md +0 -610
  61. package/docs/core_library/jspsych-randomization.md +0 -397
  62. package/docs/core_library/jspsych-turk.md +0 -102
  63. package/docs/extensions/extensions.md +0 -83
  64. package/docs/extensions/jspsych-ext-webgazer.md +0 -106
  65. package/docs/img/blue.png +0 -0
  66. package/docs/img/devtools-change-css.png +0 -0
  67. package/docs/img/devtools-css-errors.png +0 -0
  68. package/docs/img/devtools-inspect-element.png +0 -0
  69. package/docs/img/folder-setup.png +0 -0
  70. package/docs/img/folder-with-html.png +0 -0
  71. package/docs/img/githubreleases.jpg +0 -0
  72. package/docs/img/jspsych-favicon.png +0 -0
  73. package/docs/img/jspsych-logo-no-text-mono.svg +0 -493
  74. package/docs/img/jspsych-logo.jpg +0 -0
  75. package/docs/img/orange.png +0 -0
  76. package/docs/img/palmer_stim.png +0 -0
  77. package/docs/img/progress_bar.png +0 -0
  78. package/docs/img/prolific-study-completion.png +0 -0
  79. package/docs/img/prolific-study-link.png +0 -0
  80. package/docs/img/visual_search_example.jpg +0 -0
  81. package/docs/index.md +0 -9
  82. package/docs/overview/browser-device-support.md +0 -35
  83. package/docs/overview/callbacks.md +0 -184
  84. package/docs/overview/data.md +0 -281
  85. package/docs/overview/dynamic-parameters.md +0 -147
  86. package/docs/overview/exclude-browser.md +0 -32
  87. package/docs/overview/experiment-options.md +0 -149
  88. package/docs/overview/eye-tracking.md +0 -237
  89. package/docs/overview/fullscreen.md +0 -36
  90. package/docs/overview/media-preloading.md +0 -369
  91. package/docs/overview/mturk.md +0 -77
  92. package/docs/overview/plugins.md +0 -320
  93. package/docs/overview/progress-bar.md +0 -110
  94. package/docs/overview/prolific.md +0 -78
  95. package/docs/overview/record-browser-interactions.md +0 -23
  96. package/docs/overview/running-experiments.md +0 -95
  97. package/docs/overview/style.md +0 -293
  98. package/docs/overview/timeline.md +0 -457
  99. package/docs/plugins/jspsych-animation.md +0 -40
  100. package/docs/plugins/jspsych-audio-button-response.md +0 -60
  101. package/docs/plugins/jspsych-audio-keyboard-response.md +0 -58
  102. package/docs/plugins/jspsych-audio-slider-response.md +0 -53
  103. package/docs/plugins/jspsych-call-function.md +0 -81
  104. package/docs/plugins/jspsych-canvas-button-response.md +0 -66
  105. package/docs/plugins/jspsych-canvas-keyboard-response.md +0 -68
  106. package/docs/plugins/jspsych-canvas-slider-response.md +0 -89
  107. package/docs/plugins/jspsych-categorize-animation.md +0 -60
  108. package/docs/plugins/jspsych-categorize-html.md +0 -53
  109. package/docs/plugins/jspsych-categorize-image.md +0 -53
  110. package/docs/plugins/jspsych-cloze.md +0 -45
  111. package/docs/plugins/jspsych-external-html.md +0 -70
  112. package/docs/plugins/jspsych-free-sort.md +0 -56
  113. package/docs/plugins/jspsych-fullscreen.md +0 -57
  114. package/docs/plugins/jspsych-html-button-response.md +0 -42
  115. package/docs/plugins/jspsych-html-keyboard-response.md +0 -51
  116. package/docs/plugins/jspsych-html-slider-response.md +0 -45
  117. package/docs/plugins/jspsych-iat-html.md +0 -64
  118. package/docs/plugins/jspsych-iat-image.md +0 -64
  119. package/docs/plugins/jspsych-image-button-response.md +0 -48
  120. package/docs/plugins/jspsych-image-keyboard-response.md +0 -58
  121. package/docs/plugins/jspsych-image-slider-response.md +0 -54
  122. package/docs/plugins/jspsych-instructions.md +0 -58
  123. package/docs/plugins/jspsych-maxdiff.md +0 -41
  124. package/docs/plugins/jspsych-preload.md +0 -128
  125. package/docs/plugins/jspsych-rdk.md +0 -119
  126. package/docs/plugins/jspsych-reconstruction.md +0 -48
  127. package/docs/plugins/jspsych-resize.md +0 -39
  128. package/docs/plugins/jspsych-same-different-html.md +0 -53
  129. package/docs/plugins/jspsych-same-different-image.md +0 -66
  130. package/docs/plugins/jspsych-serial-reaction-time-mouse.md +0 -52
  131. package/docs/plugins/jspsych-serial-reaction-time.md +0 -57
  132. package/docs/plugins/jspsych-survey-html-form.md +0 -50
  133. package/docs/plugins/jspsych-survey-likert.md +0 -70
  134. package/docs/plugins/jspsych-survey-multi-choice.md +0 -48
  135. package/docs/plugins/jspsych-survey-multi-select.md +0 -53
  136. package/docs/plugins/jspsych-survey-text.md +0 -63
  137. package/docs/plugins/jspsych-video-button-response.md +0 -54
  138. package/docs/plugins/jspsych-video-keyboard-response.md +0 -50
  139. package/docs/plugins/jspsych-video-slider-response.md +0 -60
  140. package/docs/plugins/jspsych-virtual-chinrest.md +0 -105
  141. package/docs/plugins/jspsych-visual-search-circle.md +0 -52
  142. package/docs/plugins/jspsych-vsl-animate-occlusion.md +0 -55
  143. package/docs/plugins/jspsych-vsl-grid-scene.md +0 -62
  144. package/docs/plugins/jspsych-webgazer-calibrate.md +0 -60
  145. package/docs/plugins/jspsych-webgazer-init-camera.md +0 -31
  146. package/docs/plugins/jspsych-webgazer-validate.md +0 -43
  147. package/docs/plugins/list-of-plugins.md +0 -54
  148. package/docs/tutorials/hello-world.md +0 -162
  149. package/docs/tutorials/rt-task.md +0 -1334
  150. package/docs/tutorials/video-tutorials.md +0 -11
  151. package/examples/add-to-end-of-timeline.html +0 -38
  152. package/examples/case-sensitive-responses.html +0 -45
  153. package/examples/conditional-and-loop-functions.html +0 -64
  154. package/examples/css/jquery-ui.css +0 -1225
  155. package/examples/css-classes-parameter.html +0 -145
  156. package/examples/data-add-properties.html +0 -44
  157. package/examples/data-as-function.html +0 -39
  158. package/examples/data-from-timeline.html +0 -52
  159. package/examples/data-from-url.html +0 -21
  160. package/examples/demo-flanker.html +0 -117
  161. package/examples/demo-simple-rt-task.html +0 -120
  162. package/examples/demos/demo_1.html +0 -35
  163. package/examples/demos/demo_2.html +0 -50
  164. package/examples/demos/demo_3.html +0 -63
  165. package/examples/display-element-to-embed-experiment.html +0 -79
  166. package/examples/end-active-node.html +0 -52
  167. package/examples/end-experiment.html +0 -45
  168. package/examples/exclusions.html +0 -32
  169. package/examples/external_html/simple_consent.html +0 -4
  170. package/examples/img/1.gif +0 -0
  171. package/examples/img/10.gif +0 -0
  172. package/examples/img/11.gif +0 -0
  173. package/examples/img/12.gif +0 -0
  174. package/examples/img/2.gif +0 -0
  175. package/examples/img/3.gif +0 -0
  176. package/examples/img/4.gif +0 -0
  177. package/examples/img/5.gif +0 -0
  178. package/examples/img/6.gif +0 -0
  179. package/examples/img/7.gif +0 -0
  180. package/examples/img/8.gif +0 -0
  181. package/examples/img/9.gif +0 -0
  182. package/examples/img/age/of1.jpg +0 -0
  183. package/examples/img/age/of2.jpg +0 -0
  184. package/examples/img/age/of3.jpg +0 -0
  185. package/examples/img/age/om1.jpg +0 -0
  186. package/examples/img/age/om2.jpg +0 -0
  187. package/examples/img/age/om3.jpg +0 -0
  188. package/examples/img/age/yf1.jpg +0 -0
  189. package/examples/img/age/yf4.jpg +0 -0
  190. package/examples/img/age/yf5.jpg +0 -0
  191. package/examples/img/age/ym2.jpg +0 -0
  192. package/examples/img/age/ym3.jpg +0 -0
  193. package/examples/img/age/ym5.jpg +0 -0
  194. package/examples/img/backwardN.gif +0 -0
  195. package/examples/img/blue.png +0 -0
  196. package/examples/img/card.png +0 -0
  197. package/examples/img/con1.png +0 -0
  198. package/examples/img/con2.png +0 -0
  199. package/examples/img/fixation.gif +0 -0
  200. package/examples/img/happy_face_1.jpg +0 -0
  201. package/examples/img/happy_face_2.jpg +0 -0
  202. package/examples/img/happy_face_3.jpg +0 -0
  203. package/examples/img/happy_face_4.jpg +0 -0
  204. package/examples/img/inc1.png +0 -0
  205. package/examples/img/inc2.png +0 -0
  206. package/examples/img/normalN.gif +0 -0
  207. package/examples/img/orange.png +0 -0
  208. package/examples/img/redX.png +0 -0
  209. package/examples/img/ribbon.jpg +0 -0
  210. package/examples/img/sad_face_1.jpg +0 -0
  211. package/examples/img/sad_face_2.jpg +0 -0
  212. package/examples/img/sad_face_3.jpg +0 -0
  213. package/examples/img/sad_face_4.jpg +0 -0
  214. package/examples/js/snap.svg-min.js +0 -21
  215. package/examples/js/webgazer.js +0 -88886
  216. package/examples/jspsych-RDK.html +0 -58
  217. package/examples/jspsych-animation.html +0 -39
  218. package/examples/jspsych-audio-button-response.html +0 -58
  219. package/examples/jspsych-audio-keyboard-response.html +0 -68
  220. package/examples/jspsych-audio-slider-response.html +0 -61
  221. package/examples/jspsych-call-function.html +0 -32
  222. package/examples/jspsych-canvas-button-response.html +0 -95
  223. package/examples/jspsych-canvas-keyboard-response.html +0 -78
  224. package/examples/jspsych-canvas-slider-response.html +0 -67
  225. package/examples/jspsych-categorize-animation.html +0 -49
  226. package/examples/jspsych-categorize-html.html +0 -33
  227. package/examples/jspsych-categorize-image.html +0 -44
  228. package/examples/jspsych-cloze.html +0 -37
  229. package/examples/jspsych-free-sort.html +0 -109
  230. package/examples/jspsych-fullscreen.html +0 -45
  231. package/examples/jspsych-html-button-response.html +0 -43
  232. package/examples/jspsych-html-keyboard-response.html +0 -42
  233. package/examples/jspsych-html-slider-response.html +0 -53
  234. package/examples/jspsych-iat.html +0 -520
  235. package/examples/jspsych-image-button-response.html +0 -91
  236. package/examples/jspsych-image-keyboard-response.html +0 -85
  237. package/examples/jspsych-image-slider-response.html +0 -85
  238. package/examples/jspsych-instructions.html +0 -37
  239. package/examples/jspsych-maxdiff.html +0 -33
  240. package/examples/jspsych-preload.html +0 -140
  241. package/examples/jspsych-reconstruction.html +0 -43
  242. package/examples/jspsych-resize.html +0 -34
  243. package/examples/jspsych-same-different-html.html +0 -28
  244. package/examples/jspsych-same-different-image.html +0 -39
  245. package/examples/jspsych-serial-reaction-time-mouse.html +0 -98
  246. package/examples/jspsych-serial-reaction-time.html +0 -54
  247. package/examples/jspsych-survey-html-form.html +0 -33
  248. package/examples/jspsych-survey-likert.html +0 -42
  249. package/examples/jspsych-survey-multi-choice.html +0 -40
  250. package/examples/jspsych-survey-multi-select.html +0 -42
  251. package/examples/jspsych-survey-text.html +0 -34
  252. package/examples/jspsych-video-button-response.html +0 -65
  253. package/examples/jspsych-video-keyboard-response.html +0 -61
  254. package/examples/jspsych-video-slider-response.html +0 -63
  255. package/examples/jspsych-virtual-chinrest.html +0 -69
  256. package/examples/jspsych-visual-search-circle.html +0 -64
  257. package/examples/jspsych-vsl-animate-occlusion.html +0 -35
  258. package/examples/jspsych-vsl-grid-scene.html +0 -47
  259. package/examples/lexical-decision.html +0 -134
  260. package/examples/manual-preloading.html +0 -59
  261. package/examples/pause-unpause.html +0 -33
  262. package/examples/progress-bar.html +0 -68
  263. package/examples/save-trial-parameters.html +0 -98
  264. package/examples/sound/hammer.mp3 +0 -0
  265. package/examples/sound/sound.mp3 +0 -0
  266. package/examples/sound/speech_blue.mp3 +0 -0
  267. package/examples/sound/speech_green.mp3 +0 -0
  268. package/examples/sound/speech_joke.mp3 +0 -0
  269. package/examples/sound/speech_red.mp3 +0 -0
  270. package/examples/sound/tone.mp3 +0 -0
  271. package/examples/timeline-variables-sampling.html +0 -50
  272. package/examples/timeline-variables.html +0 -64
  273. package/examples/video/sample_video.mp4 +0 -0
  274. package/examples/webgazer.html +0 -162
  275. package/examples/webgazer_image.html +0 -60
  276. package/extensions/jspsych-ext-webgazer.js +0 -185
  277. package/jspsych.js +0 -3015
  278. package/license.txt +0 -21
  279. package/mkdocs.yml +0 -118
  280. package/plugins/jspsych-animation.js +0 -189
  281. package/plugins/jspsych-audio-button-response.js +0 -269
  282. package/plugins/jspsych-audio-keyboard-response.js +0 -212
  283. package/plugins/jspsych-audio-slider-response.js +0 -278
  284. package/plugins/jspsych-call-function.js +0 -58
  285. package/plugins/jspsych-canvas-button-response.js +0 -199
  286. package/plugins/jspsych-canvas-keyboard-response.js +0 -155
  287. package/plugins/jspsych-canvas-slider-response.js +0 -207
  288. package/plugins/jspsych-categorize-animation.js +0 -266
  289. package/plugins/jspsych-categorize-html.js +0 -220
  290. package/plugins/jspsych-categorize-image.js +0 -222
  291. package/plugins/jspsych-cloze.js +0 -112
  292. package/plugins/jspsych-external-html.js +0 -112
  293. package/plugins/jspsych-free-sort.js +0 -478
  294. package/plugins/jspsych-fullscreen.js +0 -106
  295. package/plugins/jspsych-html-button-response.js +0 -188
  296. package/plugins/jspsych-html-keyboard-response.js +0 -149
  297. package/plugins/jspsych-html-slider-response.js +0 -202
  298. package/plugins/jspsych-iat-html.js +0 -284
  299. package/plugins/jspsych-iat-image.js +0 -286
  300. package/plugins/jspsych-image-button-response.js +0 -327
  301. package/plugins/jspsych-image-keyboard-response.js +0 -263
  302. package/plugins/jspsych-image-slider-response.js +0 -369
  303. package/plugins/jspsych-instructions.js +0 -237
  304. package/plugins/jspsych-maxdiff.js +0 -173
  305. package/plugins/jspsych-preload.js +0 -345
  306. package/plugins/jspsych-rdk.js +0 -1373
  307. package/plugins/jspsych-reconstruction.js +0 -134
  308. package/plugins/jspsych-resize.js +0 -166
  309. package/plugins/jspsych-same-different-html.js +0 -168
  310. package/plugins/jspsych-same-different-image.js +0 -169
  311. package/plugins/jspsych-serial-reaction-time-mouse.js +0 -212
  312. package/plugins/jspsych-serial-reaction-time.js +0 -247
  313. package/plugins/jspsych-survey-html-form.js +0 -171
  314. package/plugins/jspsych-survey-likert.js +0 -195
  315. package/plugins/jspsych-survey-multi-choice.js +0 -208
  316. package/plugins/jspsych-survey-multi-select.js +0 -232
  317. package/plugins/jspsych-survey-text.js +0 -185
  318. package/plugins/jspsych-video-button-response.js +0 -335
  319. package/plugins/jspsych-video-keyboard-response.js +0 -279
  320. package/plugins/jspsych-video-slider-response.js +0 -351
  321. package/plugins/jspsych-virtual-chinrest.js +0 -471
  322. package/plugins/jspsych-visual-search-circle.js +0 -259
  323. package/plugins/jspsych-vsl-animate-occlusion.js +0 -196
  324. package/plugins/jspsych-vsl-grid-scene.js +0 -103
  325. package/plugins/jspsych-webgazer-calibrate.js +0 -166
  326. package/plugins/jspsych-webgazer-init-camera.js +0 -95
  327. package/plugins/jspsych-webgazer-validate.js +0 -304
  328. package/plugins/template/jspsych-plugin-template.js +0 -35
  329. package/tests/README.md +0 -7
  330. package/tests/jsPsych/case-sensitive-responses.test.js +0 -53
  331. package/tests/jsPsych/css-classes-parameter.test.js +0 -107
  332. package/tests/jsPsych/default-iti.test.js +0 -51
  333. package/tests/jsPsych/default-parameters.test.js +0 -58
  334. package/tests/jsPsych/endexperiment.test.js +0 -49
  335. package/tests/jsPsych/events.test.js +0 -606
  336. package/tests/jsPsych/functions-as-parameters.test.js +0 -210
  337. package/tests/jsPsych/init.test.js +0 -48
  338. package/tests/jsPsych/loads.test.js +0 -7
  339. package/tests/jsPsych/min-rt.test.js +0 -58
  340. package/tests/jsPsych/progressbar.test.js +0 -202
  341. package/tests/jsPsych/timeline-variables.test.js +0 -531
  342. package/tests/jsPsych/timelines.test.js +0 -569
  343. package/tests/jsPsych.data/data-csv-conversion.test.js +0 -85
  344. package/tests/jsPsych.data/data-json-conversion.test.js +0 -120
  345. package/tests/jsPsych.data/datacollection.test.js +0 -117
  346. package/tests/jsPsych.data/datacolumn.test.js +0 -50
  347. package/tests/jsPsych.data/datamodule.test.js +0 -152
  348. package/tests/jsPsych.data/dataparameter.test.js +0 -251
  349. package/tests/jsPsych.data/interactions.test.js +0 -109
  350. package/tests/jsPsych.data/trialparameters.test.js +0 -175
  351. package/tests/jsPsych.extensions/extensions.test.js +0 -207
  352. package/tests/jsPsych.extensions/test-extension.js +0 -42
  353. package/tests/jsPsych.pluginAPI/pluginapi.test.js +0 -341
  354. package/tests/jsPsych.pluginAPI/preloads.test.js +0 -43
  355. package/tests/jsPsych.randomization/randomziation.test.js +0 -27
  356. package/tests/jsPsych.utils/utils.test.js +0 -58
  357. package/tests/plugins/plugin-animation.test.js +0 -34
  358. package/tests/plugins/plugin-audio-button-response.test.js +0 -15
  359. package/tests/plugins/plugin-audio-keyboard-response.test.js +0 -15
  360. package/tests/plugins/plugin-audio-slider-response.test.js +0 -15
  361. package/tests/plugins/plugin-call-function.test.js +0 -49
  362. package/tests/plugins/plugin-categorize-animation.test.js +0 -263
  363. package/tests/plugins/plugin-categorize-html.test.js +0 -17
  364. package/tests/plugins/plugin-categorize-image.test.js +0 -17
  365. package/tests/plugins/plugin-cloze.test.js +0 -157
  366. package/tests/plugins/plugin-free-sort.test.js +0 -106
  367. package/tests/plugins/plugin-fullscreen.test.js +0 -41
  368. package/tests/plugins/plugin-html-button-response.test.js +0 -161
  369. package/tests/plugins/plugin-html-keyboard-response.test.js +0 -139
  370. package/tests/plugins/plugin-html-slider-response.test.js +0 -155
  371. package/tests/plugins/plugin-iat-html.test.js +0 -299
  372. package/tests/plugins/plugin-iat-image.test.js +0 -298
  373. package/tests/plugins/plugin-image-button-response.test.js +0 -174
  374. package/tests/plugins/plugin-image-keyboard-response.test.js +0 -147
  375. package/tests/plugins/plugin-image-slider-response.test.js +0 -174
  376. package/tests/plugins/plugin-instructions.test.js +0 -85
  377. package/tests/plugins/plugin-maxdiff.test.js +0 -39
  378. package/tests/plugins/plugin-preload.test.js +0 -916
  379. package/tests/plugins/plugin-rdk.test.js +0 -61
  380. package/tests/plugins/plugin-reconstruction.test.js +0 -16
  381. package/tests/plugins/plugin-resize.test.js +0 -16
  382. package/tests/plugins/plugin-same-different-html.test.js +0 -17
  383. package/tests/plugins/plugin-same-different-image.test.js +0 -17
  384. package/tests/plugins/plugin-serial-reaction-time-mouse.test.js +0 -42
  385. package/tests/plugins/plugin-serial-reaction-time.test.js +0 -109
  386. package/tests/plugins/plugin-survey-html-form.test.js +0 -44
  387. package/tests/plugins/plugin-survey-likert.test.js +0 -48
  388. package/tests/plugins/plugin-survey-multi-choice.test.js +0 -47
  389. package/tests/plugins/plugin-survey-multi-select.test.js +0 -71
  390. package/tests/plugins/plugin-survey-text.test.js +0 -115
  391. package/tests/plugins/plugin-video-button-response.test.js +0 -32
  392. package/tests/plugins/plugin-video-keyboard-response.test.js +0 -32
  393. package/tests/plugins/plugin-video-slider-response.test.js +0 -31
  394. package/tests/plugins/plugin-visual-search-circle.test.js +0 -16
  395. package/tests/plugins/plugin-vsl-animate-occlusion.test.js +0 -16
  396. package/tests/plugins/plugin-vsl-grid-scene.test.js +0 -16
  397. package/tests/testing-utils.js +0 -13
@@ -1,397 +0,0 @@
1
- # jsPsych.randomization
2
-
3
- The jsPsych.randomization module contains methods that are useful for generating random lists of trial variables.
4
-
5
- ---
6
-
7
- ## jsPsych.randomization.factorial
8
-
9
- ```
10
- jsPsych.randomization.factorial(factors, repetitions, unpack)
11
- ```
12
-
13
- ### Parameters
14
-
15
- | Parameter | Type | Description |
16
- | ----------- | ------- | ---------------------------------------- |
17
- | factors | object | The `factors` object should contain a property for each different factor. Each property-factor should have a value of an array, with each element of the array corresponding to a level of the factor. |
18
- | repetitions | integer | The number of times to repeat each unique combination of the factors in the output sample. |
19
- | unpack | boolean | If `true` then the output will be an object with a property for each factor in the original `factors` object. The value of each property-factor will be an array containing the levels of the factor in a random order. The order will be consistent across each property-factor (e.g., the first element of each property-factor will specify one unique combination of the factors). If `false`, then the return value will be an array of objects where each property-factor contains only a single value. |
20
-
21
- ### Return value
22
-
23
- The return value depends on the `unpack` parameter. See description of the parameter above, and examples below.
24
-
25
- ### Description
26
-
27
- This method takes a list of factors and their levels, and creates a full factorial design by creating each unique combination of the factors. The returned set of combinations is in a random order.
28
-
29
- ### Examples
30
-
31
- #### Create full factorial design
32
- ```javascript
33
- var factors = {
34
- stimulus: ['a.jpg', 'b.jpg'],
35
- ms_delay: [100, 200]
36
- }
37
-
38
- var full_design = jsPsych.randomization.factorial(factors, 1);
39
-
40
- /*
41
- output:
42
- full_design = [
43
- {stimulus: 'a.jpg', ms_delay: 200},
44
- {stimulus: 'b.jpg', ms_delay: 200},
45
- {stimulus: 'b.jpg', ms_delay: 100},
46
- {stimulus: 'a.jpg', ms_delay: 100},
47
- ]
48
- */
49
- ```
50
-
51
- #### Create full factorial design with repeats
52
- ```javascript
53
- var factors = {
54
- stimulus: ['a.jpg', 'b.jpg'],
55
- ms_delay: [100, 200]
56
- }
57
-
58
- var full_design = jsPsych.randomization.factorial(factors, 2);
59
-
60
- /*
61
- output:
62
- full_design = [
63
- {stimulus: 'b.jpg', ms_delay: 200},
64
- {stimulus: 'b.jpg', ms_delay: 100},
65
- {stimulus: 'b.jpg', ms_delay: 100},
66
- {stimulus: 'a.jpg', ms_delay: 100},
67
- {stimulus: 'a.jpg', ms_delay: 200},
68
- {stimulus: 'b.jpg', ms_delay: 200},
69
- {stimulus: 'a.jpg', ms_delay: 100},
70
- {stimulus: 'a.jpg', ms_delay: 200},
71
- ]
72
- */
73
- ```
74
-
75
- #### Create full factorial design, unpacked
76
- ```javascript
77
- var factors = {
78
- stimulus: ['a.jpg', 'b.jpg'],
79
- ms_delay: [100, 200]
80
- }
81
-
82
- var full_design = jsPsych.randomization.factorial(factors, 1, true);
83
-
84
- /*
85
- output:
86
- full_design = {
87
- stimulus: ['a.jpg','b.jpg','b.jpg','a.jpg'],
88
- ms_delay: [200, 100, 200, 100]
89
- ]
90
- */
91
- ```
92
-
93
- ---
94
- ## jsPsych.randomization.randomID
95
-
96
- ```
97
- jsPsych.randomization.randomID(length)
98
- ```
99
-
100
- ### Parameters
101
-
102
- | Parameter | Type | Description |
103
- | --------- | ------- | --------------------------------------- |
104
- | length | integer | The length of the randomly generated ID |
105
-
106
- ### Return value
107
-
108
- Returns a string of length `length` where each character is randomly selected from the numbers 0-9 and all lowercase English letters a-z.
109
-
110
- ### Description
111
-
112
- Generates a random string that is likely to be unique. If length is undefined, then the string length is 32.
113
-
114
- ### Example
115
-
116
- ```javascript
117
-
118
- console.log(jsPsych.randomization.randomID());
119
- // outputs: "t7dwz0e713pc8juuaayyfvpkdd9un239"
120
-
121
- console.log(jsPsych.randomization.randomID(8));
122
- // outputs: "3xtpcbck"
123
-
124
- ```
125
-
126
- ---
127
- ## jsPsych.randomization.repeat
128
-
129
- ```
130
- jsPsych.randomization.repeat(array, repetitions, unpack)
131
- ```
132
-
133
- ### Parameters
134
-
135
- | Parameter | Type | Description |
136
- | ----------- | ---------------- | ---------------------------------------- |
137
- | array | array | The array of values to randomize & repeat. |
138
- | repetitions | integer or array | The number of times to repeat each element of the `array` in the final sample. If this parameter is defined as an integer, then each element of `array` is repeated the same number of times. This parameter can also be an array of the same length as `array`, in which case each element of `array` will be repeated the number of times defined in the corresponding position of the `repetitions` array. |
139
- | unpack | boolean | If each element of `array` is an object with an equivalent set of properties, then setting `unpack` to `true` will make the return value an object with a property for each of the unique properties among the elements of the `array`. Each property in the output object will be an array containing the values for that property in the randomized order. The order will be consistent across properties. If this is `false` then the output is just an array containing a randomized order of the original `array` elements. |
140
-
141
- ### Return value
142
-
143
- The return value depends on the `unpack` parameter. See description of the parameter above, and examples below.
144
-
145
- ### Description
146
-
147
- This method takes an array of values and generates a new random order of the array, with the option of repeating each element of the array a specified number of times.
148
-
149
- If the array elements are objects with the same set of properties, then this method can optionally return a single object where each property is a randomized order of the properties defined in the original set of objects. This is useful for randomizing sets of parameters that are used to define a jsPsych block.
150
-
151
- ### Examples
152
-
153
- #### Shuffle an array, no repeats
154
-
155
- ```javascript
156
-
157
- var myArray = [1,2,3,4,5];
158
- var shuffledArray = jsPsych.randomization.repeat(myArray, 1);
159
-
160
- // output: shuffledArray = [3,2,4,1,5]
161
- ```
162
-
163
- #### Shuffle an array with repeats
164
-
165
- ```javascript
166
-
167
- var myArray = [1,2,3,4,5];
168
- var shuffledArray = jsPsych.randomization.repeat(myArray, 2);
169
-
170
- // output: shuffledArray = [1,3,4,2,2,4,5,1,5,3]
171
- ```
172
-
173
- #### Shuffle an array of objects
174
-
175
- ```javascript
176
-
177
- var trial1 = {
178
- stimulus: 'img/faceA.jpg',
179
- correct_key: 'p',
180
- person_name: 'Joe'
181
- }
182
-
183
- var trial2 = {
184
- stimulus: 'img/faceB.jpg',
185
- correct_key: 'p',
186
- person_name: 'Fred'
187
- }
188
-
189
- var trial3 = {
190
- stimulus: 'img/faceC.jpg',
191
- correct_key: 'q',
192
- person_name: 'Mary'
193
- }
194
-
195
- var myArray = [ trial1, trial2, trial3 ];
196
- var shuffledArray = jsPsych.randomization.repeat(myArray, 2);
197
-
198
- // output: shuffledArray = [ trial1, trial3, trial3, trial2, trial1, trial2 ]
199
- ```
200
-
201
- #### Shuffle an array of objects, with unpack
202
-
203
- ```javascript
204
-
205
- var trial1 = {
206
- stimulus: 'img/faceA.jpg',
207
- correct_key: 'p',
208
- person_name: 'Joe'
209
- }
210
-
211
- var trial2 = {
212
- stimulus: 'img/faceB.jpg',
213
- correct_key: 'p',
214
- person_name: 'Fred'
215
- }
216
-
217
- var trial3 = {
218
- stimulus: 'img/faceC.jpg',
219
- correct_key: 'q',
220
- person_name: 'Mary'
221
- }
222
-
223
- var myArray = [ trial1, trial2, trial3 ];
224
- var shuffledArray = jsPsych.randomization.repeat(myArray, 2, true);
225
-
226
- /*
227
- output: shuffledArray = {
228
- stimulus: ['img/faceB.jpg','img/faceA.jpg','img/faceC.jpg','img/faceA.jpg','img/faceC.jpg','img/faceB.jpg'],
229
- correct_key: ['p', 'p', 'q', 'p', 'q', 'p'],
230
- person_name: ['Fred', 'Joe', 'Mary', 'Joe', 'Mary', 'Fred']
231
- }
232
- */
233
- ```
234
- ---
235
- ## jsPsych.randomization.sampleWithReplacement
236
-
237
- ```
238
- jsPsych.randomization.sampleWithReplacement(array, sampleSize, weights)
239
- ```
240
-
241
- ### Parameters
242
-
243
- | Parameter | Type | Description |
244
- | ---------- | ------- | ---------------------------------------- |
245
- | array | array | The array of values to sample from |
246
- | sampleSize | numeric | The number of samples to draw |
247
- | weights | array | The relative weight of each element in `array`. This array is normalized, so the values do not need to sum to 1. The length must match the length of `array`. |
248
-
249
- ### Return value
250
-
251
- An array containing the sample.
252
-
253
- ### Description
254
-
255
- This method returns a sample drawn at random from a set of values with replacement. The relative probability of drawing each item can be controlled by specifying the `weights`.
256
-
257
- ### Examples
258
-
259
- #### Sample with equal probability
260
-
261
- ```javascript
262
-
263
- var myArray = [1,2,3,4,5];
264
- var sample = jsPsych.randomization.sampleWithReplacement(myArray, 10);
265
-
266
- // output: sample = [3, 1, 2, 2, 5, 1, 4, 3, 1, 5];
267
- ```
268
-
269
- #### Sample with unequal probability
270
-
271
- ```javascript
272
-
273
- var myArray = [1,2,3,4,5];
274
- var sample = jsPsych.randomization.sampleWithReplacement(myArray, 10, [6,1,1,1,1]);
275
-
276
- // output: sample = [3, 4, 5, 1, 2, 1, 3, 1, 1, 1];
277
- ```
278
-
279
- ---
280
- ## jsPsych.randomization.sampleWithoutReplacement
281
-
282
- ```
283
- jsPsych.randomization.sampleWithoutReplacement(array, sampleSize)
284
- ```
285
-
286
- ### Parameters
287
-
288
- | Parameter | Type | Description |
289
- | ---------- | ------- | ---------------------------------- |
290
- | array | array | The array of values to sample from |
291
- | sampleSize | numeric | The number of samples to draw |
292
-
293
- ### Return value
294
-
295
- An array containing the sample.
296
-
297
- ### Description
298
-
299
- This method returns a sample drawn at random from a set of values without replacement. The sample size must be less than or equal to the length of the array.
300
-
301
- ### Examples
302
-
303
- #### Sample without replacement
304
-
305
- ```javascript
306
-
307
- var myArray = [1,2,3,4,5];
308
- var sample = jsPsych.randomization.sampleWithoutReplacement(myArray, 2);
309
-
310
- // output: sample = [3,2];
311
- ```
312
-
313
- ---
314
- ## jsPsych.randomization.shuffle
315
-
316
- ```
317
- jsPsych.randomization.shuffle(array)
318
- ```
319
-
320
- ### Parameters
321
-
322
- | Parameter | Type | Description |
323
- | --------- | ----- | ------------------------------ |
324
- | array | array | The array of values to shuffle |
325
-
326
- ### Return value
327
-
328
- Returns an array with the same elements as the input array in a random order.
329
-
330
- ### Description
331
-
332
- A simple method for shuffling the order of an array.
333
-
334
- ### Examples
335
-
336
- #### Shuffle an array
337
-
338
- ```javascript
339
-
340
- var myArray = [1,2,3,4,5];
341
- var shuffledArray = jsPsych.randomization.shuffle(myArray);
342
-
343
- // output: shuffledArray = [3,2,4,1,5]
344
- ```
345
-
346
- ---
347
- ## jsPsych.randomization.shuffleNoRepeats
348
-
349
- ```
350
- jsPsych.randomization.shuffleNoRepeats(array, equalityTest)
351
- ```
352
-
353
- ### Parameters
354
-
355
- | Parameter | Type | Description |
356
- | ------------ | -------- | ---------------------------------------- |
357
- | array | array | The array of values to shuffle |
358
- | equalityTest | function | A function to use to evaluate the equality of neighbors in the array. The function should accept two parameters, which are the two elements to be tested. It should return `true` if they are equal and `false` if not. The default function, if none is specified, is to use the `===` operator. This will work for primitive values, but fail for Objects and Arrays. An example function is given below in the examples. |
359
-
360
- ### Return value
361
-
362
- Returns an array with the same elements as the input array in a random order, with no repeating neighbors.
363
-
364
- ### Description
365
-
366
- Shuffle an array, ensuring that neighboring elements in the array are different.
367
-
368
- *Warning: if you provide an array that has very few valid permutations with no neighboring elements, then this method will fail and cause the browser to hang.*
369
-
370
- ### Examples
371
-
372
- #### Basic example
373
-
374
- ```javascript
375
-
376
- var myArray = [1,2,3,4,5,1,2,3,4,5,1,2,3,4,5];
377
- var shuffledArray = jsPsych.randomization.shuffleNoRepeats(myArray);
378
-
379
- // output: shuffledArray = [2, 3, 5, 1, 2, 4, 1, 5, 4, 1, 3, 5, 4, 3, 2]
380
- ```
381
-
382
- #### Custom equalityTest
383
-
384
- ```javascript
385
- var myObjects = [
386
- {color:"blue"},
387
- {color:"red"},
388
- {color:"yellow"},
389
- {color:"orange"}
390
- ];
391
-
392
- var repeatedSet = jsPsych.randomization.repeat(myObjects,3);
393
- var shuffled = jsPsych.randomization.shuffleNoRepeats(repeatedSet, function(a,b) { return a.color === b.color });
394
-
395
- // console.log(JSON.stringify(shuffled))
396
- // "[{"color":"red"},{"color":"yellow"},{"color":"blue"},{"color":"yellow"},{"color":"orange"},{"color":"red"},{"color":"yellow"},{"color":"orange"},{"color":"blue"},{"color":"orange"},{"color":"red"},{"color":"blue"}]"
397
- ```
@@ -1,102 +0,0 @@
1
- # jsPsych.turk
2
-
3
- The jsPsych.turk module contains functions for interacting with Mechanical Turk.
4
-
5
- ---
6
- ## jsPsych.turk.submitToTurk
7
-
8
- ```
9
- jsPsych.turk.submitToTurk(data)
10
- ```
11
-
12
- ### Parameters
13
-
14
- Parameter | Type | Description
15
- ----------|------|------------
16
- data | object | The `data` parameter is an object of `key: value` pairs. Any pairs in the `data` parameter will be saved by Mechanical Turk, and can be downloaded in a CSV file through the Mechanical Turk interface. **Important**: the `data` parameter must contain at least one `key: value` pair, even just a dummy value, or the HIT will not be submitted correctly.
17
-
18
- ### Return value
19
-
20
- Returns nothing.
21
-
22
- ### Description
23
-
24
- This method will submit a HIT to Mechanical Turk, causing the HIT to finish.
25
-
26
- This method will only work when called from within the mechanical turk website. If you are using an external HIT to send workers to your own server, this method will not work on an externally hosted page. It will work if your external content is loaded in the iframe on the Mechanical Turk website.
27
-
28
- ### Example
29
-
30
- ```html
31
-
32
- <p>Enter the code you were given:</p>
33
- <input type="text" id="code"></input>
34
- <button onclick="sendData();">Submit HIT</button>
35
-
36
- <script>
37
- // this content must be loaded in the iframe on the mechanical turk website.
38
- // usually, this means that the content is part of your 'recruitment ad', the
39
- // page the workers can see when they are deciding whether or not to accept a HIT.
40
- // one option is to include a simple form on this page that workers submit, with a
41
- // special code that they get at the end of the experiment.
42
-
43
- function sendData() {
44
- jsPsych.turk.submitToTurk({
45
- code: document.getElementById('code').value
46
- });
47
- }
48
- </script>
49
- ```
50
-
51
- ---
52
-
53
- ## jsPsych.turk.turkInfo
54
-
55
- ```
56
- jsPsych.turk.turkInfo()
57
- ```
58
-
59
- ### Parameters
60
-
61
- None.
62
-
63
- ### Return value
64
-
65
- Returns an object with six properties:
66
-
67
- * `.assignmentId` contains the assignment ID string of the HIT.
68
- * `.hitId` contains the HIT ID.
69
- * `.workerId` contains the worker ID of the worker completing the HIT.
70
- * `.turkSubmitTo` contains the URL for submitting the HIT. This parameter is used in the `jsPsych.turk.submitToTurk` method, and is probably not useful outside of that context.
71
- * `.previewMode` is a boolean value indicating whether or not the worker has accepted the HIT yet. If the page is viewed inside Mechancial Turk and the worker has not clicked 'Accept HIT' then this will be true. If the page is viewed outside Mechanical Turk or the worker has acccepted the HIT, then it will be false.
72
- * `.outsideTurk` is a boolean value indicating if the page is being viewed within Mechanical Turk, or if it is being viewed from another source (e.g., someone directly going to the page URL instead of going through mturk).
73
-
74
- ### Description
75
-
76
- This method returns basic information about the current Mechanical Turk session, including the worker ID, assignment ID, and HIT ID.
77
-
78
- ### Example
79
-
80
- ```javascript
81
-
82
- var turkInfo = jsPsych.turk.turkInfo();
83
-
84
- alert('Worker ID is: ' + turkInfo.workerId);
85
-
86
- alert('Assignment ID is: ' + turkInfo.assignmentId);
87
-
88
- alert('HIT ID is: ' + turkInfo.hitId);
89
-
90
- // true if the page is viewed within Mechanical Turk,
91
- // but worker has not accepted the HIT yet.
92
- // false if the page is viewed outside Mechanical Turk,
93
- // OR the worker has accepted the HIT.
94
- alert('Preview mode? ' + turkInfo.previewMode);
95
-
96
- // true if the page is viewed outside mechanical turk,
97
- // false otherwise.
98
- alert('Outside turk? ' + turkInfo.outsideTurk);
99
- ```
100
-
101
-
102
-
@@ -1,83 +0,0 @@
1
- # Extensions
2
-
3
- Extensions are jsPsych modules that can interface with any plugin to extend the functionality of the plugin. A canonical example of an extension is eye tracking. An eye tracking extension allows a plugin to gather gaze data and add it to the plugin's data object.
4
-
5
- ## Using an Extension
6
-
7
- To use an extension in an experiment, you'll load the extension file via a `<script>` tag (just like adding a plugin) and then initialize the extension in the parameters of `jsPsych.init()`.
8
-
9
- ```html
10
- <head>
11
- <script src="jspsych/jspsych.js"></script>
12
- <script src="jspsych/extensions/some-extension.js"></script>
13
- </head>
14
- ```
15
-
16
- ```js
17
- jsPsych.init({
18
- timeline: [...],
19
- extensions: [
20
- {type: 'some-extension', params: {...} }
21
- ]
22
- })
23
- ```
24
-
25
- To enable an extension during a trial, add the extension to the `extensions` list for the trial. Some extensions may also support or require an object of parameters to configure the extension:
26
-
27
- ```js
28
- var trial = {
29
- extensions: [
30
- {type: 'some-extension', params: {...} }
31
- ]
32
- }
33
- ```
34
-
35
- ## List of Extensions
36
-
37
- Extension | Description
38
- ------ | -----------
39
- [jspsych&#8209;ext&#8209;webgazer.js](/extensions/jspsych-ext-webgazer.md) | Enables eye tracking using the [WebGazer](https://webgazer.cs.brown.edu/) library.
40
-
41
- ## Writing an Extension
42
-
43
- To create a new extension you must create an object that supports a few event callbacks. A barebones extension file looks like this:
44
-
45
- ```js
46
- jsPsych.extensions['new-extension'] = (function () {
47
-
48
- var extension = {};
49
-
50
- extension.initialize = function(params){
51
- // params are passed from the extensions parameter in jsPsych.init
52
- }
53
-
54
- extension.on_start = function(params){
55
- // params are passed from the extensions parameter in the trial object
56
- }
57
-
58
- extension.on_load = function(params){
59
- // params are passed from the extensions parameter in the trial object
60
- }
61
-
62
- extension.on_finish = function(params){
63
- // params are passed from the extensions parameter in the trial object
64
- return {
65
- // any data that the extension returns here will be added to the trial data
66
- }
67
- }
68
-
69
- return extension;
70
- });
71
- ```
72
-
73
- The four events that an extension must support are shown in the sample code.
74
-
75
- `extension.initialize` is called with `jsPsych.init()`. This is where setup code for the extension can happen. This event will happen once per experiment, unlike the other events which occur with each trial. The `params` object can include whatever parameters are necessary to configure the extension. The `params` object is passed from the call to `jsPsych.init()` to the `extension.initialize` method. `extension.initialize` must return a `Promise` that resolves when the extension is finished initializing.
76
-
77
- `extension.on_start` is called at the start of the plugin execution, prior to calling `plugin.trial`. This is where trial-specific initialization can happen, such as creating empty containers to hold data or resetting internal state. The `params` object is passed from the declaration of the extension in the trial object. You can use `params` to customize the behavior of the extension for each trial.
78
-
79
- `extension.on_load` is called after `plugin.trial` has executed, which is typically when the plugin has finished executing initial DOM-modifying code and has set up various event listeners. This is where the extension can begin actively interacting with the DOM and recording data. The `params` object is passed from the declaration of the extension in the trial object. You can use `params` to customize the behavior of the extension for each trial.
80
-
81
- `extension.on_finish` is called after the plugin completes. This can be used for any teardown at the end of the trial. This method should return an object of data to append to the plugin's data. Note that this event fires *before* the `on_finish` event for the plugin, so data added by the extension is accessible in any trial `on_finish` event handlers. The `params` object is passed from the declaration of the extension in the trial object. You can use `params` to customize the behavior of the extension for each trial.
82
-
83
- The extension can also include any additional methods that are necessary for interacting with it. See the [webgazer extension](/extensions/jspsych-ext-webgazer.md) for an example.
@@ -1,106 +0,0 @@
1
- # jspsych-ext-webgazer
2
-
3
- This extension supports eye tracking through the [WebGazer](https://webgazer.cs.brown.edu/) library. For a narrative description of how to use this extension see the [eye tracking overview](/overview/eye-tracking.md).
4
-
5
- ## Parameters
6
-
7
- ### Initialization Parameters
8
-
9
- Initialization parameters can be set when calling `jsPsych.init()`
10
-
11
- ```js
12
- jsPsych.init({
13
- extensions: [
14
- {type: 'webgazer', params: {...}}
15
- ]
16
- })
17
- ```
18
-
19
- Parameter | Type | Default Value | Description
20
- ----------|------|---------------|------------
21
- webgazer | object | `undefined` | You can explicitly pass a reference to a loaded instance of the webgazer.js library. If no explicit reference is passed then the extension will look for a global `webgazer` object. If you are loading webgazer.js via a `<script>` tag you do not need to set this parameter in most circumstances.
22
- round_predictions | bool | true | Whether to round the `x`,`y` coordinates predicted by WebGazer to the nearest whole number. This *greatly* reduces the size of the data, as WebGazer records data to 15 decimal places by default. Given the noise of the system, there's really no need to record data to this level of precision.
23
-
24
- ### Trial Parameters
25
-
26
- Trial parameters can be set when adding the extension to a trial object.
27
-
28
- ```js
29
- var trial = {
30
- type: '...',
31
- extensions: [
32
- {type: 'webgazer', params: {...}}
33
- ]
34
- }
35
- ```
36
-
37
- Parameter | Type | Default Value | Description
38
- ----------|------|---------------|------------
39
- targets | array | [] | A list of elements on the page that you would like to record the coordinates of for comparison with the WebGazer data. Each entry in the array should be a valid [CSS selector string](https://www.w3schools.com/cssref/css_selectors.asp) that identifies the element. The selector string should be valid for exactly one element on the page. If the selector is valid for more than one element then only the first matching element will be recorded.
40
-
41
- ## Data Generated
42
-
43
- Name | Type | Value
44
- -----|------|------
45
- webgazer_data | array | An array of objects containing gaze data for the trial. Each object has an `x`, a `y`, and a `t` property. The `x` and `y` properties specify the gaze location in pixels and `t` specifies the time in milliseconds since the start of the trial.
46
- webgazer_targets | array | An array of objects contain the pixel coordinates of elements on the screen specified by the `.targets` parameter. Each object contains a `selector` property, containing the CSS selector string used to find the element, plus `top`, `bottom`, `left`, and `right` parameters which specify the [bounding rectangle](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of the element.
47
-
48
- ## Functions
49
-
50
- In addition to the jsPsych webgazer-* plugins, the jsPsych webgazer extension provides a set of functions that allow the researcher to interact more directly with WebGazer. These functions can be called at any point during an experiment, and are crucial for building trial plugins that interact with WebGazer. All of the functions below must be prefixed with `jsPsych.extensions.webgazer` (e.g. `jsPsych.extensions.webgazer.faceDetected()`).
51
-
52
- ### faceDetected()
53
-
54
- Returns `true` if WebGazer is ready to make predictions (`webgazer.getTracker().predictionReady` is `true`).
55
-
56
- ### showPredictions()
57
-
58
- Turns on WebGazer's real-time visualization of predicted gaze location.
59
-
60
- ### hidePredictions()
61
-
62
- Turns off WebGazer's real-time visualization of predicted gaze location.
63
-
64
- ### showVideo()
65
-
66
- Turns on a display of the webcam image, guiding box for positioning the face, and WebGazer's estimate of the location of facial landmarks.
67
-
68
- ### hideVideo()
69
-
70
- Turns off the camera display.
71
-
72
- ### resume()
73
-
74
- Turns on gaze prediction. The extension will automatically handle this for you in most cases. You probably only need to use this if you are writing your own plugin that interfaces directly with WebGazer.
75
-
76
- ### pause()
77
-
78
- Turns off gaze prediction. The extension will automatically handle this for you in most cases. You probably only need to use this if you are writing your own plugin that interfaces directly with WebGazer.
79
-
80
- ### startMouseCalibration()
81
-
82
- Turns on mouse movement and mouse clicks as calibration events. While the `webgazer-calibration` plugin can also be used to run a parmeterized calibration routine, this calibration function call allows you to continuously calibrate WebGazer to any mouse movements or clicks throughout the experiment. For example, any *-button-response trial would also function as a WebGazer calibration event.
83
-
84
- ### stopMouseCalibration()
85
-
86
- Stops WebGazer from using mouse movements and mouse clicks as calibration events.
87
-
88
- ### calibratePoint(x, y)
89
-
90
- Instructs WebGazer to register the location `x`, `y` (in screen pixel coordinates) as a calibration event. Can be used for passive viewing calibration, i.e., instructing participants to fixate at a particular location.
91
-
92
- ### setRegressionType(regression_type)
93
-
94
- Change the method that WebGazer is using to perform feature -> location regression. Valid options are `ridge`, `weightedRidge`, and `threadedRidge`. See the WebGazer docs for more information about these options.
95
- The extension uses the default mode specified by WebGazer (currently `ridge`).
96
-
97
- ### getCurrentPrediction()
98
-
99
- Get the current predicted gaze location from WebGazer. Returns an object with `x`, `y`, and `eyeFeature` properties. This function is asynchronus, so proper use requires either the `await` keyword in the context of another `async function` or using `.then()`.
100
-
101
- ```js
102
- jsPsych.extensions.webgazer.getCurrentPrediction().then(function(data){
103
- console.log(`Currently looking at coordinate ${data.x}, ${data.y}`)
104
- });
105
- ```
106
-
package/docs/img/blue.png DELETED
Binary file
Binary file
Binary file