Merge pull request #38 from yeatmanlab/enh/image-swipe-multi-response

Add image versions of the multi response and swipe response plugins

.changeset/fast-guests-hammer.md

@@ -0,0 +1,7 @@
+---
+"@jspsych-contrib/plugin-image-multi-response": major
+"@jspsych-contrib/plugin-image-swipe-response": major
+"@jspsych-contrib/plugin-html-multi-response": patch
+---
+
+First release of plugin-image-multi-response and plugin-image-swipe-response. Fix documentation link in plugin-html-multi-response

README.md

@@ -23,6 +23,8 @@ Plugin/Extension | Contributor | Description
 [html-multi-response](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-html-multi-response/README.md) | [Adam Richie-Halford](https://github.com/richford) | This plugin collects responses to an arbitrary HTML string using both button clicks and key presses.
 [html-swipe-response](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-html-swipe-response/README.md) | [Adam Richie-Halford](https://github.com/richford) | This plugin collects responses to an arbitrary HTML string using swipe gestures and keyboard responses.
 [html-vas-response](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-html-vas-response/README.md) | [Isaac Kinley](https://github.com/kinleyid) | This plugin collects responses to an arbitrary HTML string using a point-and-click visual analogue scale.
+[image-multi-response](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-image-multi-response/README.md) | [Adam Richie-Halford](https://github.com/richford) | This plugin collects responses to an image stimulus using both button clicks and key presses.
+[image-swipe-response](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-image-swipe-response/README.md) | [Adam Richie-Halford](https://github.com/richford) | This plugin collects responses to an image stimulus using swipe gestures and keyboard responses.
 [libet-intentional-blinding](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-libet-intentional-binding/README.md) | [Isaac Kinley](https://github.com/kinleyid) | This plugin measures intentional binding using a Libet clock, and allows the participant to estimate the timing of events by adjusting the clock hand themselves.
 [rdk](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-rdk/docs/jspsych-rdk.md#jspsych-rdk-plugin) | [Sivananda Rajananda](https://github.com/vrsivananda) | This plugin displays a Random Dot Kinematogram (RDK) and allows the subject to report the primary direction of motion by pressing a key on the keyboard.
 [rok](https://github.com/jspsych/jspsych-contrib/blob/main/packages/plugin-rok/docs/jspsych-rok.md#jspsych-rok-plugin) | [Younes Strittmatter](https://github.com/younesStrittmatter) | This plugin displays a Random Object Kinematogram (ROK) and allows the subject to report the primary direction of motion or the primary orientation by pressing a key on the keyboard.

packages/plugin-html-multi-response/src/index.ts

@@ -76,7 +76,7 @@ type Info = typeof info;
  * html-multi-response
  * jsPsych plugin for displaying an html stimulus and getting a response
  * @author Adam Richie-Halford
- * @see {@link https://DOCUMENTATION_URL DOCUMENTATION LINK TEXT}
+ * @see {@link https://www.jspsych.org/plugins/jspsych-html-multi-response/ html-multi-response plugin documentation on jspsych.org}
  */
 class HtmlMultiResponsePlugin implements JsPsychPlugin<Info> {
   static info = info;

packages/plugin-image-multi-response/README.md

@@ -0,0 +1,27 @@
+# image-multi-response
+
+## Overview
+
+This plugin displays image content and records responses generated by both button click and the keyboard.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time.
+
+## Loading
+
+```js
+<script src="https://unpkg.com/@jspsych-contrib/[email protected]">
+```
+
+## Compatibility
+
+jsPsych v7.0
+
+## Documentation
+
+See [documentation](docs/jspsych-image-multi-response.md)
+
+## Author / Citation
+
+Created by [Adam Richie-Halford](https://github.com/richford)
+
+Citation:
+
+Pending

packages/plugin-image-multi-response/docs/jspsych-image-multi-response.md

@@ -0,0 +1,44 @@
+# jspsych-image-multi-response plugin
+
+This plugin displays image content and records responses generated by both button click and the keyboard. Allowing multiple response modalities is useful when designing assessments that will be administered on both desktop and mobile (e.g., phone or tablet) devices. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time.
+
+## Parameters
+
+In addition to the [parameters available in all plugins](https://www.jspsych.org/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Parameters can be left unspecified if the default value is acceptable.
+
+| Parameter | Type | Default Value | Description |
+| ----------|------|---------------|------------ |
+| stimulus | HTML string | `undefined` | The HTML content to be displayed. |
+| button_choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button. |
+| keyboard_choices | array of strings | `"NO_KEYS"` | This array contains the key(s) that the subject is allowed to press in order to respond to the stimulus. Keys should be specified as characters (e.g., `'a'`, `'q'`, `' '`, `'Enter'`, `'ArrowDown'`) - see [this page](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) and [this page (event.key column)](https://www.freecodecamp.org/news/javascript-keycode-list-keypress-event-key-codes/) for more examples. Any key presses that are not listed in the array will be ignored. Specifying `"ALL_KEYS"` means that all keys will be accepted as valid responses. The default value of `"NO_KEYS"` will mean that no responses are allowed. | |
+| button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on. |
+| prompt | string | null | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). |
+| trial_duration | numeric | null | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, the trial will wait for a response indefinitely. |
+| stimulus_duration | numeric | null | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is null, then the stimulus will remain visible until the trial ends. |
+| margin_vertical | string | '0px' | Vertical margin of the button(s). |
+| margin_horizontal | string | '8px' | Horizontal margin of the button(s). |
+| response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can set this parameter to `false` to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. |
+
+## Data Generated
+
+In addition to the [default data collected by all plugins](../overview/plugins.md#data-collected-by-all-plugins), this plugin collects the following data for each trial.
+
+| Name      | Type    | Value                                    |
+| --------- | ------- | ---------------------------------------- |
+| keyboard_response | string | Indicates which key the subject pressed. If the subject responded using button clicks, then this field will be `null`. |
+| button_response | numeric | Indicates which button the subject pressed. The first button in the `choices` array is 0, the second is 1, and so on. If the subject responded using the keyboard, then this field will be `null`. |
+| response_source | string | Indicates the source of the response. This will either be `"button"` or `"keyboard"`. |
+| rt        | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. |
+| stimulus  | string  | The HTML content that was displayed on the screen. |
+
+## Example
+
+```javascript
+var trial = {
+  type: jsPsychHtmlMultiResponse,
+  stimulus: '<p style="font-size:48px; color:green;">BLUE</p>',
+  button_choices: ['Red', 'Green', 'Blue'],
+  keyboard_choices: ['r', 'g', 'b'],
+  prompt: "<p>Is the ink color (r)ed, (g)reen, or (b)lue?<br>Click the buttons or press the <kbd>r</kbd>, <kbd>g</kbd>, or <kbd>b</kbd> keys to respond.</p>"
+};
+```

packages/plugin-image-multi-response/examples/example.html

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<script src="https://unpkg.com/[email protected]"></script>
+		<script src="../dist/index.browser.js"></script>
+		<link rel="stylesheet" href="https://unpkg.com/[email protected]/css/jspsych.css">
+	</head>
+	<body></body>
+	<script>
+
+		var jsPsych = initJsPsych({
+      on_finish: function() {
+        jsPsych.data.displayData();
+      }
+    });
+
+		//---------Create trials---------
+
+    const timeline = [];
+
+		// Add a trial that only accepts keyboard responses
+		const keyboard_trial = {
+			type: jsPsychImageMultiResponse,
+      stimulus: './blue_text_green_color.png',
+      keyboard_choices: ['r', 'g', 'b'],
+      prompt: "<p>Is the ink color red, green, or blue?<br>Press the <kbd>r</kbd>, <kbd>g</kbd>, or <kbd>b</kbd> keys to respond.</p>"
+		};
+
+		// Add a trial that only accepts button responses
+		const button_trial = {
+			type: jsPsychImageMultiResponse,
+      stimulus: './green_text_red_color.png',
+      button_choices: ['Red', 'Green', 'Blue'],
+      prompt: "<p>Is the ink color red, green, or blue?<br>Click the buttons to respond.</p>"
+		};
+
+    const multi_trial = {
+      type: jsPsychImageMultiResponse,
+      stimulus: './red_text_blue_color.png',
+      button_choices: ['Red', 'Green', 'Blue'],
+      keyboard_choices: ['r', 'g', 'b'],
+      prompt: "<p>Is the ink color red, green, or blue?<br>Click the buttons or press the <kbd>r</kbd>, <kbd>g</kbd>, or <kbd>b</kbd> keys to respond.</p>"
+    };
+
+    timeline.push(keyboard_trial, button_trial, multi_trial);
+
+		//---------Run the experiment---------
+
+		jsPsych.run(timeline);
+
+	</script>
+</html>

packages/plugin-image-multi-response/jest.config.cjs

@@ -0,0 +1 @@
+module.exports = require("@jspsych/config/jest").makePackageConfig(__dirname);

packages/plugin-image-multi-response/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@jspsych-contrib/plugin-image-multi-response",
+  "version": "0.1.0",
+  "description": "",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "typings": "dist/index.d.ts",
+  "unpkg": "dist/index.browser.min.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "source": "src/index.ts",
+  "scripts": {
+    "test": "jest",
+    "test:watch": "npm test -- --watch",
+    "tsc": "tsc",
+    "build": "rollup --config",
+    "build:watch": "npm run build -- --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jspsych/jspsych-contrib.git",
+    "directory": "packages/plugin-image-multi-response"
+  },
+  "author": "Adam Richie-Halford",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jspsych/jspsych-contrib/issues"
+  },
+  "homepage": "https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-image-multi-response",
+  "peerDependencies": {
+    "jspsych": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@jspsych/config": "^1.0.0",
+    "@jspsych/test-utils": "^1.0.0",
+    "jspsych": "^7.0.0"
+  }
+}

packages/plugin-image-multi-response/rollup.config.mjs

@@ -0,0 +1,3 @@
+import { makeRollupConfig } from "@jspsych/config/rollup";
+
+export default makeRollupConfig("jsPsychImageMultiResponse");