jspsych 6.3.0 → 7.1.1

package/docs/plugins/jspsych-external-html.md

@@ -1,70 +0,0 @@
-# jspsych-external-html plugin
-
-The HTML plugin displays an external HTML document (often a consent form). Either a keyboard response or a button press can be used to continue to the next trial. It allows the experimenter to check if conditions are met (such as indicating informed consent) before continuing.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter      | Type     | Default Value                | Description                              |
-| -------------- | -------- | ---------------------------- | ---------------------------------------- |
-| url            | string   | *undefined*                  | The URL of the page to display.          |
-| cont_key       | string   | null                         | The key character the subject can use to advance to the next trial. If left as null, then the subject will not be able to advance trials using the keyboard. |
-| cont_btn       | string   | null                         | The ID of a clickable element on the page. When the element is clicked, the trial will advance. |
-| check_fn       | function | `function(){ return true; }` | This function is called with the jsPsych `display_element` as the only argument when the subject attempts to advance the trial. The trial will only advance if the function return `true`. This can be used to verify that the subject has correctly filled out a form before continuing, for example. |
-| force_refresh  | boolean  | false                        | If `true`, then the plugin will avoid using the cached version of the HTML page to load if one exists. |
-| execute_script | boolean  | false                        | If `true`, then scripts on the remote page will be executed. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name | Type    | Value                                    |
-| ---- | ------- | ---------------------------------------- |
-| url  | string  | The URL of the page.                     |
-| rt   | numeric | The response time in milliseconds for the subject to finish the trial. |
-
-## Examples
-
-### Loading a consent form
-
-##### This content would be in a file called 'external_page.html'
-```html
-<div id="consent">
-  <p>
-    This is a demo experiment, with this minimal consent form being loaded
-    as an external html document. To continue, click the checkbox below
-    and hit "Start Experiment".
-  </p>
-  <p>
-    <input type="checkbox" id="consent_checkbox" />
-    I agree to take part in this study.
-  </p>
-  <button type="button" id="start">Start Experiment</button>
-</div>
-```
-
-##### jsPsych code to load above page.
-```javascript
-// sample function that might be used to check if a subject has given
-// consent to participate.
-var check_consent = function(elem) {
-  if (document.getElementById('consent_checkbox').checked) {
-    return true;
-  }
-  else {
-    alert("If you wish to participate, you must check the box next to the statement 'I agree to participate in this study.'");
-    return false;
-  }
-  return false;
-};
-
-
-// declare the block.
-var trial = {
-  type:'external-html',
-  url: "external_page.html",
-  cont_btn: "start",
-  check_fn: check_consent
-};
-```

package/docs/plugins/jspsych-free-sort.md

@@ -1,56 +0,0 @@
-# jspsych-free-sort plugin
-
-The free-sort plugin displays one or more images on the screen that the participant can interact with by clicking and dragging with a mouse, or touching and dragging with a touchscreen device. When the trial starts, the images can be positioned outside or inside the sort area. All images must be moved into the sorting area before the participant can click a button to end the trial. All of the moves that the participant performs are recorded, as well as the final positions of all images. This plugin could be useful when asking participants to position images based on similarity to one another, or to recall image spatial locations.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-stimuli | array | *undefined* | Each element of this array is an image path.
-stim_height | numeric | 100 | The height of the images in pixels.
-stim_width | numeric | 100 | The width of the images in pixels.
-scale_factor | numeric | 1.5 | How much larger to make the stimulus while moving (1 = no scaling).
-sort_area_height | numeric | 800 | The height of the container that participants can move the stimuli in. Stimuli will be constrained to this area.
-sort_area_width | numeric | 800 | The width of the container that participants can move the stimuli in. Stimuli will be constrained to this area.
-sort_area_shape | string | "ellipse" | The shape of the sorting area, can be "ellipse" or "square".
-prompt | string | null | This string can contain HTML markup. The intention is that it can be used to provide a reminder about the action the participant is supposed to take (e.g., which key to press).
-prompt_location | string | "above" | Indicates whether to show the prompt `"above"` or `"below"` the sorting area.
-button_label | string | 'Continue' | The text that appears on the button to continue to the next trial.
-change_border_background_color | boolean | true | If `true`, the sort area border color will change while items are being moved in and out of the sort area, and the background color will change once all items have been moved into the sort area. If `false`, the border will remain black and the background will remain white throughout the trial.
-border_color_in | string | '#a1d99b' | If `change_border_background_color` is `true`, the sort area border will change to this color when an item is being moved into the sort area, and the background will change to this color when all of the items have been moved into the sort area.
-border_color_out | string | '#fc9272' | If `change_border_background_color` is `true`, this will be the color of the sort area border when there are one or more items that still need to be moved into the sort area.
-border_width | numeric | null | The width in pixels of the border around the sort area. If `null`, the border width will be 3% of the `sort_area_height`.
-counter_text_unfinished | string | You still need to place %n% item%s% inside the sort area. | Text to display when there are one or more items that still need to be placed in the sort area. If "%n%" is included in the string, it will be replaced with the number of items that still need to be moved inside. If "%s%" is included in the string, a "s" will be included when the number of items remaining is greater than one.
-counter_text_finished | string | All items placed. Feel free to reposition items if necessary. | Text that will take the place of the counter_text_unfinished text when all items have been moved inside the sort area.
-stim_starts_inside | boolean | false | If `false`, the images will be positioned to the left and right of the sort area when the trial loads. If `true`, the images will be positioned at random locations inside the sort area when the trial loads.
-column_spread_factor | numeric | 1 | When the images appear outside the sort area, this determines the x-axis spread of the image columns. Default value is 1. Values less than 1 will compress the image columns along the x-axis, and values greater than 1 will spread them farther apart.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-init_locations | array | An array containing objects representing the initial locations of all the stimuli in the sorting area. Each element in the array represents a stimulus, and has a "src", "x", and "y" value. "src" is the image path, and "x" and "y" are the object location. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. 
-moves | array | An array containing objects representing all of the moves the participant made when sorting. Each object represents a move. Each element in the array has a "src", "x", and "y" value. "src" is the image path, and "x" and "y" are the object location after the move. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. 
-final_locations | array | An array containing objects representing the final locations of all the stimuli in the sorting area. Each element in the array represents a stimulus, and has a "src", "x", and "y" value. "src" is the image path, and "x" and "y" are the object location. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. 
-rt | numeric | The response time in milliseconds for the participant to finish all sorting.
-
-## Examples
-
-#### Basic example
-
-```javascript
-var sorting_stimuli = [];
-for (var i = 1; i <= 12; i++) {
-    sorting_stimuli.push("img/cell_img_" + i + ".jpg");
-}
-
-var sort_trial = {
-    type: 'free-sort',
-    stimuli: sorting_stimuli,
-    prompt: "<p>Click and drag the images below to sort them so that similar items are close together.</p>"
-};
-```

package/docs/plugins/jspsych-fullscreen.md

@@ -1,57 +0,0 @@
-# jspsych-fullscreen plugin
-
-The fullscreen plugin allows the experiment to enter or exit fullscreen mode. For security reasons, all browsers require that entry into fullscreen mode is triggered by a user action. To enter fullscreen mode, this plugin has the user click a button. Exiting fullscreen mode can be done without user input.
-
-Safari does not support keyboard input when the browser is in fullscreen mode. Therefore, the function will not launch fullscreen mode on Safari. The experiment will ignore any trials using the fullscreen plugin in Safari.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-fullscreen_mode | boolean | `true` | A value of `true` causes the experiment to enter fullscreen mode. A value of `false` causes the browser to exit fullscreen mode.
-message | string | `<p>The experiment will switch to full screen mode when you press the button below</p>` | The HTML content to display above the button to enter fullscreen mode.
-button_label | string |  'Continue' | The text that appears on the button to enter fullscreen mode.
-delay_after | numeric | 1000 | The length of time to delay after entering fullscreen mode before ending the trial. This can be useful because entering fullscreen is jarring and most browsers display some kind of message that the browser has entered fullscreen mode.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-success | boolean | true if the browser supports fullscreen mode (i.e., is not Safari)
-
-## Examples
-
-#### Entering and exiting fullscreen
-
-```javascript
-var timeline = [];
-
-timeline.push({
-  type: 'fullscreen',
-  fullscreen_mode: true
-});
-
-timeline.push({
-  type: 'html-keyboard-response',
-  stimulus: 'This trial will be in fullscreen mode.'
-});
-
-// exit fullscreen mode
-timeline.push({
-  type: 'fullscreen',
-  fullscreen_mode: false
-});
-
-timeline.push({
-  type: 'html-keyboard-response',
-  stimulus: 'This trial will NOT be in fullscreen mode.'
-});
-
-jsPsych.init({
-  timeline: timeline
-});
-```

package/docs/plugins/jspsych-html-button-response.md

@@ -1,42 +0,0 @@
-# jspsych-html-button-response
-
-This plugin displays HTML content and records responses generated by button click. 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. The button itself can be customized using HTML formatting.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other 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.
-choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button.
-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#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-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.
-response | numeric | Indicates which button the subject pressed. The first button in the `choices` array is 0, the second is 1, and so on.
-stimulus | string | The HTML content that was displayed on the screen.
-
-## Examples
-
-#### Displaying question until subject gives a response
-
-```javascript
-var trial = {
-	type: 'html-button-response',
-	stimulus: '<p>Running</p>',
-	choices: ['Healthy', 'Unhealthy'],
-	prompt: "<p>Is this activity healthy or unhealthy?</p>"
-};
-```

package/docs/plugins/jspsych-html-keyboard-response.md

@@ -1,51 +0,0 @@
-# jspsych-html-keyboard-response
-
-This plugin displays HTML content and records responses generated with 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.
-
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter           | Type             | Default Value      | Description                              |
-| ------------------- | ---------------- | ------------------ | ---------------------------------------- |
-| stimulus            | HTML string      | *undefined*        | The string to be displayed.              |
-| choices             | array of strings | `jsPsych.ALL_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. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| 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). |
-| 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. |
-| 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, then the trial will wait for a response indefinitely. |
-| 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#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| response  | string  | Indicates which key the subject pressed. |
-| 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. |
-
-## Examples
-
-#### Displaying trial until subject gives a response
-
-```javascript
-var trial = {
-	type: 'html-keyboard-response',
-	stimulus: '<p>Running</p>',
-	choices: ['e', 'i'],
-	prompt: "<p>Is this activity healthy or unhealthy? Press 'e' for healthy and 'i' for unhealthy.</p>"
-};
-```
-
-#### Showing a 1 second fixation cross; no response allowed
-
-```javascript
-var trial = {
-	type: 'html-keyboard-response',
-	stimulus: '<p style="font-size: 48px;">+</p>',
-	choices: jsPsych.NO_KEYS,
-	trial_duration: 1000,
-};
-```

package/docs/plugins/jspsych-html-slider-response.md

@@ -1,45 +0,0 @@
-# jspsych-html-slider-response
-
-This plugin displays HTML content and allows the subject to respond by dragging a slider.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-stimulus | HTML string | *undefined* | The string to be displayed
-labels | array of strings | [] | Labels displayed at equidistant locations on the slider. For example, two labels will be placed at the ends of the slider. Three labels would place two at the ends and one in the middle. Four will place two at the ends, and the other two will be at 33% and 67% of the slider width.
-button_label | string | 'Continue' | Label of the button to end the trial.
-min | integer | 0 | Sets the minimum value of the slider.
-max | integer | 100 | Sets the maximum value of the slider.
-slider_start | integer | 50 | Sets the starting value of the slider
-step | integer | 1 | Sets the step of the slider. This is the smallest amount by which the slider can change.
-slider_width | integer | null | Set the width of the slider in pixels. If left null, then the width will be equal to the widest element in the display.
-require_movement | boolean | false | If true, the subject must move the slider before clicking the continue button.
-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).
-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.
-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, then the trial will wait for a response indefinitely.
-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#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-response | numeric | The numeric value of the slider.
-rt | numeric | The 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.
-slider_start | numeric | The starting value of the slider.
-
-## Examples
-
-```javascript
-var trial = {
-	type: 'html-slider-response',
-	stimulus: '<p>Running</p>',
-	labels: ['healthy', 'unhealthy'],
-	prompt: "<p>How healthy/unhealthy is this activity?</p>"
-};
-```

package/docs/plugins/jspsych-iat-html.md

@@ -1,64 +0,0 @@
-# jspsych-iat-html plugin
-
-This plugin runs a single trial of the [implicit association test (IAT)](https://implicit.harvard.edu/implicit/iatdetails.html), using HTML content as the stimulus.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter               | Type             | Default Value                            | Description                              |
-| ----------------------- | ---------------- | ---------------------------------------- | ---------------------------------------- |
-| stimulus                | string           | *undefined*                              | The HTML-formatted stimulus to display.  |
-| html_when_wrong         | string           | `<span style="color: red; font-size: 80px">X</span>` | The content to display when a user presses the wrong key. |
-| bottom_instructions     | string           | `<p>If you press the wrong key, a red X will appear. Press any key to continue.</p>` | Instructions about making a wrong key press and whether another key press is needed to continue. |
-| force_correct_key_press | boolean          | false                                    | If this is `true` and the user presses the wrong key then they have to press the other key to continue. An example would be two keys 'e' and 'i'. If the key associated with the stimulus is 'e' and key 'i' was pressed, then pressing 'e' is needed to continue the trial. When this is `true`, then parameter `key_to_move_forward` is not used. |
-| display_feedback        | boolean          | false                                    | If `true`, then `html_when_wrong` and `wrong_image_name` is required. If `false`, `trial_duration` is needed and trial will continue automatically. |
-| left_category_key       | string           | 'e'                                      | Key press that is associated with the `left_category_label`. |
-| right_category_key      | string           | 'i'                                      | Key press that is associated with the `right_category_label`. |
-| left_category_label     | string           | ['left']                                 | An array that contains the words/labels associated with a certain stimulus. The labels are aligned to the left side of the page. |
-| right_category_label    | string           | ['right']                                | An array that contains the words/labels associated with a certain stimulus. The labels are aligned to the right side of the page. |
-| stim_key_association    | string           | *undefined*                              | Either 'left' or 'right'. This indicates whether the stimulus is associated with the key press and category on the left or right side of the page (`left_category_key` or `right_category_key`). |
-| key_to_move_forward     | array of strings | jsPsych.ALL_KEYS                         | This array contains the characters the subject is allowed to press to move on to the next trial if their key press was incorrect and feedback was displayed. Can also have 'other key' as an option which will only allow the user to select the right key to move forward. |
-| 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`, then the trial will wait for a response indefinitely. |
-| 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 use this parameter 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#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | string  | Either the path to the image file or the string containing the HTML-formatted content that the subject saw on this trial. |
-| response  | string  | Indicates which key the subject pressed. |
-| 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. |
-| correct   | boolean | Boolean indicating whether the user's key press was correct or incorrect for the given stimulus. |
-
-## Examples
-
-```javascript
-var trial_block = {
-  type: 'iat-html',
-  stimulus: 'Golf',
-  stim_key_association: 'left',
-  html_when_wrong: '<span style="color: red; font-size: 80px">X</span>',
-  bottom_instructions: '<p>If you press the wrong key, a red X will appear. Press the other key to continue</p>',
-  force_correct_key_press: true,
-  display_feedback: true,
-  trial_duration: 3000, //Only if display_feedback is false
-  left_category_key: 'e',
-  right_category_key: 'i',
-  left_category_label: ['OLD'],
-  right_category_label: ['YOUNG'],
-  response_ends_trial: true
-}
-
-var timeline = [];
-timeline.push(trial_block);
-
-jsPsych.init({
-  timeline: timeline,
-  on_finish: function() {
-    jsPsych.data.displayData();
-  }
-});
-```

package/docs/plugins/jspsych-iat-image.md

@@ -1,64 +0,0 @@
-jspsych-iat-image plugin
-
-This plugin runs a single trial of the [implicit association test (IAT)](https://implicit.harvard.edu/implicit/iatdetails.html), using an image as the stimulus.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter               | Type                | Default Value                            | Description                              |
-| ----------------------- | ------------------- | ---------------------------------------- | ---------------------------------------- |
-| stimulus                | string              | *undefined*                              | The stimulus to display. The path to an image. |
-| html_when_wrong         | string              | `<span style="color: red; font-size: 80px">X</span>` | The HTML to display when a user presses the wrong key. |
-| bottom_instructions     | string              | `<p>If you press the wrong key, a red X will appear. Press any key to continue.</p>` | Instructions about making a wrong key press and whether another key press is needed to continue. |
-| force_correct_key_press | boolean             | false                                    | If this is `true` and the user presses the wrong key then they have to press the other key to continue. An example would be two keys 'e' and 'i'. If the key associated with the stimulus is 'e' and key 'i' was pressed, then pressing 'e' is needed to continue the trial. When this is `true`, then parameter `key_to_move_forward` is not used. |
-| display_feedback        | boolean             | false                                    | If `true`, then `image_when_wrong` and `wrong_image_name` are required. If `false`, `trial_duration` is needed and trial will continue automatically. |
-| left_category_key       | string              | 'e'                                      | Key press that is associated with the `left_category_label`. |
-| right_category_key      | string              | 'i'                                      | Key press that is associated with the `right_category_label`. |
-| left_category_label     | string              | ['left']                                 | An array that contains the words/labels associated with a certain stimulus. The labels are aligned to the left side of the page. |
-| right_category_label    | string              | ['right']                                | An array that contains the words/labels associated with a certain stimulus. The labels are aligned to the right side of the page. |
-| stim_key_association    | string              | 'undefined'                              | Either 'left' or 'right'. This indicates whether the stimulus is associated with the key press and category on the left or right side of the page (`left_category_key` or `right_category_key`). |
-| key_to_move_forward     | array of characters | jsPsych.ALL_KEYS                         | This array contains the characters the subject is allowed to press to move on to the next trial if their key press was incorrect and feedback was displayed. Can also have 'other key' as an option which will only allow the user to select the right key to move forward. |
-| 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`, then the trial will wait for a response indefinitely. |
-| 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 use this parameter 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#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | string  | Either the path to the image file or the string containing the HTML-formatted content that the subject saw on this trial. |
-| response  | string  | Indicates which key the subject pressed. |
-| 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. |
-| correct   | boolean | Boolean indicating whether the user's key press was correct or incorrect for the given image. |
-
-## Examples
-
-```javascript
-var trial_block = {
-  type: 'iat-image',
-  stimulus: 'img/blue.png',
-  stim_key_association: 'left',
-  html_when_wrong: '<span style="color: red; font-size: 80px">X</span>',
-  bottom_instructions: '<p>If you press the wrong key, a red X will appear. Press the other key to continue</p>',
-  force_correct_key_press: true,
-  display_feedback: true,
-  trial_duration: 3000, //Only if display_feedback is false
-  left_category_key: 'e',
-  right_category_key: 'i',
-  left_category_label: ['OLD'],
-  right_category_label: ['YOUNG'],
-  response_ends_trial: true
-}
-
-var timeline = [];
-timeline.push(trial_block);
-
-jsPsych.init({
-  timeline: timeline,
-  on_finish: function() {
-    jsPsych.data.displayData();
-  }
-});
-```

package/docs/plugins/jspsych-image-button-response.md

@@ -1,48 +0,0 @@
-# jspsych-image-button-response
-
-This plugin displays an image and records responses generated with a button click. 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. The button itself can be customized using HTML formatting.
-
-Image files can be automatically preloaded by jsPsych using the [`preload` plugin](jspsych-preload.md). However, if you are using timeline variables or another dynamic method to specify the image stimulus, you will need to [manually preload](/overview/media-preloading/#manual-preloading) the images.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-Parameter | Type | Default Value | Description
-----------|------|---------------|------------
-stimulus | string | undefined | The path of the image file to be displayed.
-stimulus_height | integer | null | Set the height of the image in pixels. If left null (no value specified), then the image will display at its natural height.
-stimulus_width | integer | null | Set the width of the image in pixels. If left null (no value specified), then the image will display at its natural width.
-maintain_aspect_ration | boolean | true | If setting *only* the width or *only* the height and this parameter is true, then the other dimension will be scaled to maintain the image's aspect ratio. 
-choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button.
-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).
-stimulus_duration | numeric | null | How long to show the stimulus for in milliseconds. If the value is null, then the stimulus will be shown until the subject makes a response.
-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.
-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.
-render_on_canvas | boolean | true | If true, the image will be drawn onto a canvas element. This prevents a blank screen (white flash) between consecutive image trials in some browsers, like Firefox and Edge. If false, the image will be shown via an img element, as in previous versions of jsPsych.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-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.
-response | numeric | Indicates which button the subject pressed. The first button in the `choices` array is 0, the second is 1, and so on.
-stimulus | string | The path of the image that was displayed.
-
-## Examples
-
-#### Displaying question until subject gives a response
-
-```javascript
-var trial = {
-	type: 'image-button-response',
-	stimulus: 'img/happy_face_1.png',
-	choices: ['Happy', 'Sad'],
-	prompt: "<p>Is this person happy or sad?</p>"
-};
-```

package/docs/plugins/jspsych-image-keyboard-response.md

@@ -1,58 +0,0 @@
-# jspsych-image-keyboard-response
-
-This plugin displays and image and records responses generated with 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.
-
-Image files can be automatically preloaded by jsPsych using the [`preload` plugin](jspsych-preload.md). However, if you are using timeline variables or another dynamic method to specify the image stimulus, you will need to [manually preload](/overview/media-preloading/#manual-preloading) the images.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter             | Type             | Default Value      | Description                              |
-| --------------------- | ---------------- | ------------------ | ---------------------------------------- |
-| stimulus              | string           | *undefined*        | The path of the image file to be displayed. |
-| stimulus_height       | integer          | null               | Set the height of the image in pixels. If left null (no value specified), then the image will display at its natural height. |
-| stimulus_width        | integer          | null               | Set the width of the image in pixels. If left null (no value specified), then the image will display at its natural width. |
-| maintain_aspect_ratio | boolean          | true               | If setting *only* the width or *only* the height and this parameter is true, then the other dimension will be scaled to maintain the image's aspect ratio. |
-| choices               | array of strings | `jsPsych.ALL_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. The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. |
-| 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). |
-| stimulus_duration     | numeric          | null               | How long to show the stimulus for in milliseconds. If the value is `null`, then the stimulus will be shown until the subject makes a response. |
-| 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`, then the trial will wait for a response indefinitely. |
-| 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. |
-| render_on_canvas      | boolean          | true               | If `true`, the image will be drawn onto a canvas element. This prevents a blank screen (white flash) between consecutive image trials in some browsers, like Firefox and Edge. If `false`, the image will be shown via an img element, as in previous versions of jsPsych. |
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](/overview/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| response  | string  | Indicates which key the subject pressed. |
-| 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 path of the image that was displayed. |
-
-## Examples
-
-#### Displaying trial until subject gives a response
-
-```javascript
-var trial = {
-	type: 'image-keyboard-response',
-	stimulus: 'img/happy_face_1.png',
-	choices: ['e', 'i'],
-	prompt: "<p>Is this person happy or sad? Press 'e' for happy and 'i' for sad.</p>",
-	response_ends_trial: false
-};
-```
-
-#### Displaying image for a fixed duration; no response allowed
-
-```javascript
-var trial = {
-	type: 'image-button-response',
-	stimulus: 'img/happy_face_1.png',
-	choices: jsPsych.NO_KEYS,
-	prompt: "<p>Study this face for 5 seconds.</p>",
-	trial_duration: 5000
-};
-```