jspsych 6.2.0 → 7.1.0

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

@@ -1,57 +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.
-
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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 keycodes | `jsPsych.ALL_KEYS` | This array contains the keys that the subject is allowed to press in order to respond to the stimulus. Keys can be specified as their [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) or as characters (e.g., `'a'`, `'q'`). 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.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-key_press | numeric | Indicates which key the subject pressed. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response.
-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
-};
-```

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

@@ -1,52 +0,0 @@
-# jspsych-image-slider-response
-
-This plugin displays and image and allows the subject to respond by dragging a slider.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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 to 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. 
-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 advance/submit
-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
-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 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.md#data-collected-by-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 path of the image that was displayed.
-slider_start | numeric | The starting value of the slider.
-
-## Examples
-
-#### Displaying trial until subject gives a response
-
-```javascript
-var trial = {
-	type: 'image-slider-response',
-	stimulus: 'img/happy_face_1.png',
-	labels: ['happy', 'sad'],
-	prompt: "<p>How happy/sad is this person?</p>",
-  response_ends_trial: false
-};
-```

package/docs/plugins/jspsych-instructions.md

@@ -1,58 +0,0 @@
-# jspsych-instructions plugin
-
-This plugin is for showing instructions to the subject. It allows subjects to navigate through multiple pages of instructions at their own pace, recording how long the subject spends on each page. Navigation can be done using the mouse or keyboard. Subjects can be allowed to navigate forwards and backwards through pages, if desired.
-
-## Parameters	
-
-In addition to the [parameters available in all plugins](overview.md#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
-----------|------|---------------|------------
-pages | array | *undefined* | Each element of the array is the content for a single page. Each page should be an HTML-formatted string.
-key_forward | key code | 'rightarrow' | This is the key that the subject can press in order to advance to the next page. Keys can be specified as their [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) or as characters (e.g., `'a'`, `'q'`).
-key_backward | key code | 'leftarrow' | This is the key that the subject can press to return to the previous page.
-allow_backward | boolean | true | If true, the subject can return to previous pages of the instructions. If false, they may only advace to the next page.
-allow_keys | boolean | true | If true, the subject can use keyboard keys to navigate the pages. If false, they may not.
-show_clickable_nav | boolean | false | If true, then a `Previous` and `Next` button will be displayed beneath the instructions. Subjects can click the buttons to navigate.
-button_label_previous | string | 'Previous' | The text that appears on the button to go backwards.
-button_label_next | string | 'Next' | The text that appears on the button to go forwards.
-show_page_number | boolean | false | If true, and clickable navigation is enabled, then Page x/y will be shown between the nav buttons.
-page_label | string | 'Page' | The text that appears before x/y pages displayed when show_page_number is true.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-view_history | JSON string | A JSON string containing the order of pages the subject viewed (including when the subject returned to previous pages) and the time spent viewing each page.
-rt | numeric | The response time in milliseconds for the subject to view all of the pages.
-
-## Example
-
-#### Showing simple text instructions
-
-```javascript
-var trial = {
-	type: 'instructions',
-	pages: [
-		'Welcome to the experiment. Click next to begin.',
-		'This is the second page of instructions.',
-		'This is the final page.'
-	],
-	show_clickable_nav: true
-}
-```
-
-#### Including images
-
-```javascript
-var trial = {
-	type: 'instructions',
-	pages: [
-		'Welcome to the experiment. Click next to begin.',
-		'Here is a picture of what you will do: <img src="instruction_image.jpg"></img>'
-	],
-	show_clickable_nav: true
-}
-```

package/docs/plugins/jspsych-maxdiff.md

@@ -1,42 +0,0 @@
-# jspsych-maxdiff plugin
-
-The maxdiff plugin displays a table with rows of alternatives to be selected for two mutually-exclusive categories, typically as 'most' or 'least' on a particular criteria (e.g. importance, preference, similarity). The participant responds by selecting one radio button corresponding to an alternative in both the left and right response columns. The same alternative cannot be endorsed on both the left and right response columns (e.g. 'most' and 'least') simultaneously.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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
-----------|------|---------------|------------
-alternatives | array | *undefined* | An array of one or more alternatives of string type to fill the rows of the maxdiff table. If `required` is true, then the array must contain two or more alternatives, so that at least one can be selected for both the left and right columns.
-labels | array | *undefined* | An array with exactly two labels of string type to display as column headings (to the left and right of the alternatives) for responses on the criteria of interest.
-randomize_alternative_order | boolean | `false` | If true, the display order of `alternatives` is randomly determined at the start of the trial.
-preamble | string | empty string | HTML formatted string to display at the top of the page above the maxdiff table.
-required | boolean | `false` | If true, prevents the user from submitting the response and proceeding until a radio button in both the left and right response columns has been selected.
-button_label | string |  'Continue' | Label of the button.
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-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 maxdiff table first appears on the screen until the subject's response.
-labels | JSON string | A string in JSON format containing the labels corresponding to the left and right response columns. 
-left | string | The alternative endorsed on the left column.
-right | string | The alternative endorsed on the right column.
-
-
-## Examples
-
-#### Basic example
-
-```javascript
-var maxdiff_page = {
-  type: 'maxdiff',
-  alternatives: ['apple', 'orange', 'pear', 'banana'],
-  labels: ['Most Preferred', 'Least Preferred'],
-  preamble: '<p> Please select your <b>most preferred</b> and <b>least preferred</b> fruits. </p>'
-};
-```

package/docs/plugins/jspsych-rdk.md

@@ -1,119 +0,0 @@
-# jspsych-rdk plugin
-
-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. The stimulus can be displayed until a keyboard response is given or until a certain duration of time has passed. The RDK is fully customizable (see documentation below) and can display multiple apertures at the same time, each with its own parameters.
-
-We would appreciate it if you cited this paper when you use the RDK: 
-<b>Rajananda, S., Lau, H. & Odegaard, B., (2018). A Random-Dot Kinematogram for Web-Based Vision Research. Journal of Open Research Software. 6(1), p.6. DOI: [http://doi.org/10.5334/jors.194]</b>
-
-For optimal performance, fullscreen mode should be manually triggered by the user (e.g. F11 key in Chrome for Windows). Usage of the default Fullscreen trigger from the JsPsych API library  with this plugin might result in the stimuli being displayed incorrectly.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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| Descripton|
-|---------|----|-------------|-----------|
-|choices|array|[]|The valid keys that the subject can press as a response. Must be an array of chars or numbers (corresponding to JavaScript character codes). If left unspecified, any key is a valid key.|
-|correct_choice|array, char, or number|undefined|The keys that are considered the correct response for that particular trial. Can be a single char, a single number, an array of chars, or an array of numbers. Numbers here correspond to the JavaScript character codes. This needs to be linked with the `coherent_direction` parameter (See Examples section below for an illustration.) This is used to determine whether the subject chose the correct response. The boolean indicating whether or not the subject chose the correct response is returned in the `correct` key of the data object. |
-|trial_duration|numeric|500|The amount of time that the stimulus is displayed on the screen in ms. If -1, the stimulus will be displayed until the subject keys in a valid response. (`choices` parameter must contain valid keys or else the stimuli will run indefinitely).|
-|response_ends_trial|boolean|true|If true, then the subject's response will end the trial. If false, the stimuli will be presented for the full `trial_duration` (the response will be recorded as long as the subject responds within the trial duration).|
-|number_of_apertures|numeric|1|The number of apertures or RDKs on the screen. If set to more than one, remember to set the location (i.e., aperture_center_x and aperture_center_y) parameters to separate them. <br>In addition, each aperture can be customized individually by passing in an array of values as the parameter (see example below). If a single value (not an array) is passed as the parameter, then all apertures will have the same parameter.|
-|number_of_dots|numeric|300|Number of dots per set. Equivalent to number of dots per frame.|
-|number_of_sets|numeric|1|Number of sets to cycle through. Each frame displays one set of dots. (E.g. If 2 sets of dots, frame 1 will display dots from set 1, frame 2 will display dots from set 2, frame 3 will display sets from set 1, etc.)|
-|coherent_direction|numeric|0|The direction of movement for coherent dots in degrees. 0 degrees is in the 3 o'clock direction, and increasing this number moves counterclockwise. (E.g. 12 o'clock is 90, 9 o'clock is 180, etc.) Range is 0 - 360.|
-|coherence|numeric|0.5|The proportion of dots that move together in the coherent direction. Range is 0 to 1.|
-|opposite_coherence|numeric|0|The proportion of moving in the direction opposite of the coherent direction. Range is 0 to (1-coherence).|
-|dot_radius|numeric|2|The radius of each individual dot in pixels.|
-|dot_life|numeric|-1|The number of frames that pass before a dot disappears and reappears in a new frame. -1 denotes that the dot life is infinite (i.e., a dot will only disappear and reappear if it moves out of the aperture).|
-|move_distance|numeric|1|The number of pixel lengths the dot will move in each frame (analogous to speed of dots).|
-|aperture_width|numeric|600|The width of the aperture in pixels. For a square aperture, this will determine both the width and height. For circular aperture, this will determine the diameter.|
-|aperture_height|numeric|400|The height of the aperture in pixels. For square and circle apertures, this will be ignored.|
-|dot_color|string|"white"|The color of the dots.|
-|background_color|string|"gray"|The color of the background.|
-|RDK_type|numeric|3|The Signal Selection Rule (Same/Different) and Noise Type (Random Position/Walk/Direction):<br><br>1 - Same && Random Position<br>2 - Same && Random Walk<br>3 - Same && Random Direction<br>4 - Different && Random Position<br>5 - Different && Random Walk<br>6 - Different && Random Direction<br><br>(See 'RDK parameter' below for more detailed information)<br>|
-|aperture_type|numeric|2|The shape of the aperture.<br><br>1 - Circle<br>2 - Ellipse<br>3 - Square<br>4 - Rectangle<br>|
-|reinsert_type|numeric|2|The type of reinsertion of a dot that has gone out of bounds<br><br>1 - Randomly appear anywhere in the aperture<br>2 - Appear on the opposite edge of the aperture. For squares and rectangles, a random point on the opposite edge is chosen as the reinsertion point. For circles and ellipses, the exit point is reflected about center to become the reinsertion point.<br>|
-|aperture_center_x|numeric|window.innerWidth/2|The x-coordinate of the center of the aperture, in pixels.<br>|
-|aperture_center_y|numeric|window.innerHeight/2|The y-coordinate of the center of the aperture, in pixels.<br>|
-|fixation_cross|boolean|false|Whether or not a fixation cross is presented in the middle of the screen.<br>|
-|fixation_cross_width|numeric|20|The width of the fixation cross in pixels.<br>|
-|fixation_cross_height|numeric|20|The height of the fixation cross in pixels.<br>|
-|fixation_cross_color|string|"black"|The color of the fixation cross.<br>|
-|fixation_cross_thickness|numeric|1|The thickness of the fixation cross in pixels.<br>|
-|border|boolean|false|The presence of a border around the aperture.<br>|
-|border_thickness|numeric|1|The thickness of the border in pixels.<br>|
-|border_color|string|"black"|The color of the border.<br>|
-
-### RDK type parameter
-** See Fig. 1 in Scase, Braddick, and Raymond (1996) for a visual depiction of these different signal selection rules and noise types.
-
-#### Signal Selection rule:
--**Same**: Each dot is designated to be either a coherent dot (signal) or incoherent dot (noise) and will remain so throughout all frames in the display. Coherent dots will always move in the direction of coherent motion in all frames.
--**Different**: Each dot can be either a coherent dot (signal) or incoherent dot (noise) and will be designated randomly (weighted based on the coherence level) at each frame. Only the dots that are designated to be coherent dots will move in the direction of coherent motion, but only in that frame. In the next frame, each dot will be designated randomly again on whether it is a coherent or incoherent dot.
-
-#### Noise Type:
--**Random position**: The incoherent dots appear in a random location in the aperture in each frame.<br/>
--**Random walk**: The incoherent dots will move in a random direction (designated randomly in each frame) in each frame.<br/>
--**Random direction**: Each incoherent dot has its own alternative direction of motion (designated randomly at the beginning of the trial), and moves in that direction in each frame.<br/>
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects all parameter data described above and the following data for each trial.
-
-|Name|Type|Value|
-|----|----|-----|
-|rt|numeric|The response time in ms for the subject to make a response.|
-|key_press|numeric|The key that the subject pressed. The value corresponds to the Javascript Char Code (Key Code).|
-|correct|boolean|Whether or not the subject's key press corresponded to those provided in correct_choice.|
-|frame_rate|numeric|The average frame rate for the trial. 0 denotes that the subject responded before the appearance of the second frame.|
-|number_of_frames|numeric|The number of frames that was shown in this trial.|
-|frame_rate_array|JSON string|The array that holds the number of miliseconds for each frame in this trial.|
-|canvas_width|numeric|The width of the canvas in pixels.|
-|canvas_height|numeric|The height of the canvas in pixels.|
-
-## Example
-
-#### Setting the correct_choice parameter by linking it to the coherent_direction parameter:
-
-```javascript
-var trial_right = {
-	coherent_direction: 0,
-	correct_choice: "P"
-};
-
-var trial_left = {
-	coherent_direction: 180,
-	correct_choice: "Q"
-};
-```
-
-#### Displaying a trial with 2 choices and 1 correct choice
-
-```javascript
-var test_block = {
-	type: "rdk", 
-	post_trial_gap: 0,
-	number_of_dots: 200,
-	RDK_type: 3,
-	choices: ["a", "l"],
-	correct_choice: "a",
-	coherent_direction: 180,
-	trial_duration: 1000
-};
-```
-
-#### Displaying a trial with multiple apertures
-
-```javascript
-var test_block = {
-    type: "rdk", 
-    number_of_apertures: 3, //This needs to be set if more than one aperture
-    trial_duration: 10000,
-    RDK_type: 3, //Applied to all apertures if only one value
-    aperture_width: 200, //Applied to all apertures if only one value
-    number_of_dots: [50, 200, 100], //Different parameter for each aperture. Array length must equal number_of_apertures
-    aperture_center_x: [(window.innerWidth/2)-300,window.innerWidth/2,(window.innerWidth/2)+300] //Separate the apertures on the screen (window.innerWidth/2 is the middle of the screen)
-};
-```
-

package/docs/plugins/jspsych-reconstruction.md

@@ -1,48 +0,0 @@
-# jspsych-reconstruction plugin
-
-This plugin allows a subject to interact with a stimulus by modifying a parameter of the stimulus and observing the change in the stimulus in real-time.
-
-The stimulus must be defined through a function that returns an HTML-formatted string. The function should take a single value, which is the parameter that can be modified by the subject. The value can only range from 0 to 1. See the example at the bottom of the page for a sample function.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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
-----------|------|---------------|------------
-stim_function | function | *undefined* | A function with a single parameter that returns an HTML-formatted string representing the stimulus.
-starting_value | numeric | 0.5 | The starting value of the stimulus parameter.
-step_size | numeric | 0.05 | The change in the stimulus parameter caused by pressing one of the modification keys.
-key_increase | key code | 'h' | The key to press for increasing the parameter value.
-key_decrease | key code | 'g' | The key to press for decreasing the parameter value.
-button_label | string | 'Continue' | The text that appears on the button to finish the trial.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-start_value | numeric | The starting value of the stimulus parameter.
-final_value | numeric | The final value of the stimulus parameter.
-rt | numeric | The length of time, in milliseconds, that the trial lasted.
-
-## Examples
-
-#### Make a block larger and smaller
-
-```javascript
-var sample_function = function(param){
-	var size = 50 + Math.floor(param*250);
-	var html = '<div style="display: block; margin: auto; height: 300px;">'+
-	'<div style="display: block; margin: auto; background-color: #000000; '+
-	'width: '+size+'px; height: '+size+'px;"></div></div>';
-	return html;
-}
-
-var trial = {
-	type: 'reconstruction',
-	stim_function: sample_function,
-	starting_value: 0.25
-}
-```

package/docs/plugins/jspsych-resize.md

@@ -1,39 +0,0 @@
-# jspsych-resize
-
-This plugin displays a resizable div container that allows the user to drag until the container is the same size as the item being measured. Once the user measures the item as close as possible, clicking the button sets a scaling factor for the div containing jsPsych content. This causes the stimuli that follow to have a known size, independent of monitor resolution.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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
-----------|------|---------------|------------
-item_height | numeric | 1 | The height of the item to be measured. Any units can be used as long as you are consistent with using the same units for all parameters.
-item_width | numeric | 1 | The width of the item to be measured.
-pixels_per_unit | numeric | 100 | After the scaling factor is applied, this many pixels will equal one unit of measurement.
-prompt | string | `''` | HTML content to display below the resizable box, and above the button.
-button_label | string | 'Continue' | Label to display on the button to complete calibration.
-starting_size | numeric | 100 | The initial size of the box, in pixels, along the largest dimension. The aspect ratio will be set automatically to match the item width and height.
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-final_width_px | numeric | Final width of the resizable div container, in pixels.
-scale_factor | numeric | Scaling factor that will be applied to the div containing jsPsych content.
-
-## Examples
-
-#### Measuring a credit card and resizing the display to have 150 pixels equal an inch.
-
-```javascript
-var inputs = {
-  type: 'resize',
-  item_width: 3 + 3/8,
-  item_height: 2 + 1/8,
-  prompt: "<p>Click and drag the lower right corner of the box until the box is the same size as a credit card held up to the screen.</p>",
-  pixels_per_unit: 150
-};
-```

package/docs/plugins/jspsych-same-different-html.md

@@ -1,53 +0,0 @@
-# jspsych-same-different-html plugin
-
-The same-different-html plugin displays two stimuli sequentially. Stimuli are HTML objects. The subject responds using the keyboard, and indicates whether the stimuli were the same or different. Same does not necessarily mean identical; a category judgment could be made, for example.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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* | A pair of stimuli, represented as an array with two entries, one for each stimulus. A stimulus is a string containing valid HTML markup. Stimuli will be shown in the order that they are defined in the array.
-answer | string | *undefined* | Either `'same'` or `'different'`.
-same_key | numeric or string | 'Q' | The key that subjects should press to indicate that the two stimuli are the same.
-different_key | numeric or string | 'P' | The key that subjects should press to indicate that the two stimuli are different.
-first_stim_duration | numeric | 1000 | How long to show the first stimulus for in milliseconds. If the value of this parameter is null then the stimulus will be shown until the subject presses any key.
-gap_duration | numeric | 500 | How long to show a blank screen in between the two stimuli.
-second_stim_duration | numeric | 1000 | How long to show the second stimulus for in milliseconds. If the value of this parameter is null then the stimulus will be shown until the subject responds.
-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).
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-stimulus | string | An JSON-encoded array of length 2 containing either the path to the image file or the string containing the HTML formatted content that the subject saw for each trial.
-key_press | numeric | Indicates which key the subject pressed. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the second stimulus first appears on the screen until the subject's response.
-correct | boolean | `true` if the subject's response matched the `answer` for this trial.
-answer | string | The correct answer to the trial, either `'same'` or `'different'`.
-
-Additionally, if `first_stim_duration` is  null, then the following data is also collected:
-
-Name | Type | Value
------|------|------
-rt_stim1 | numeric | The response time in milliseconds for the subject to continue after the first stimulus. The time is measured from when the first stimulus appears on the screen until the subject's response.
-key_press_stim1 | numeric | Indicates which key the subject pressed to continue. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response.
-
-## Examples
-
-#### Basic example
-
-```javascript
-  var trial = {
-    type: 'same-different-html',
-    stimuli: ['<p>Climbing</p>', '<p>Walking</p>'],
-    prompt: "<p>Press S if the texts imply the same amount of physical exertion. Press D if the texts imply different amount of physical exertion.</p>",
-    same_key: 'S',
-    different_key: 'D',
-    answer: 'different'
-  }
-```

package/docs/plugins/jspsych-same-different-image.md

@@ -1,66 +0,0 @@
-# jspsych-same-different plugin
-
-The same-different plugin displays two stimuli sequentially. Stimuli are image objects. The subject responds using the keyboard, and indicates whether the stimuli were the same or different. Same does not necessarily mean identical; a category judgment could be made, for example.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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* | A pair of stimuli, represented as an array with two entries, one for each stimulus. The stimulus is a path to an image file. Stimuli will be shown in the order that they are defined in the array.
-answer | string | *undefined* | Either `'same'` or `'different'`.
-same_key | numeric or string | 'Q' | The key that subjects should press to indicate that the two stimuli are the same.
-different_key | numeric or string | 'P' | The key that subjects should press to indicate that the two stimuli are different.
-first_stim_duration | numeric | 1000 | How long to show the first stimulus for in milliseconds. If the value of this parameter is null then the stimulus will be shown until the subject presses any key.
-gap_duration | numeric | 500 | How long to show a blank screen in between the two stimuli.
-second_stim_duration | numeric | 1000 | How long to show the second stimulus for in milliseconds. If the value of this parameter is null then the stimulus will be shown until the subject responds.
-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).
-
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-stimulus | string | An JSON-encoded array of length 2 containing either the path to the image file or the string containing the HTML formatted content that the subject saw for each trial.
-key_press | numeric | Indicates which key the subject pressed. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the second stimulus first appears on the screen until the subject's response.
-correct | boolean | `true` if the subject's response matched the `answer` for this trial.
-answer | string | The correct answer to the trial, either `'same'` or `'different'`.
-
-Additionally, if `first_stim_duration` is  null, then the following data is also collected:
-
-Name | Type | Value
------|------|------
-rt_stim1 | numeric | The response time in milliseconds for the subject to continue after the first stimulus. The time is measured from when the first stimulus appears on the screen until the subject's response.
-key_press_stim1 | numeric | Indicates which key the subject pressed to continue. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response.
-
-## Examples
-
-#### Presenting two different emotional expressions
-
-```javascript
-var block = {
-  type: 'same-different-image',
-  stimuli: ['img/happy_face_1.jpg', 'img/sad_face_3.jpg'],
-  prompt: "<p>Press S if the faces had the same emotional expression. Press D if the faces had different emotional expressions.</p>",
-  same_key: 'S',
-  different_key: 'D',
-  answer: 'different'
-}
-```
-
-#### Presenting the same emotional expression
-
-```javascript
-var block = {
-  type: 'same-different-image',
-  stimuli: ['img/happy_face_1.jpg', 'img/happy_face_3.jpg'],
-  prompt: "<p>Press S if the faces had the same emotional expression. Press D if the faces had different emotional expressions.</p>",
-  same_key: 'S',
-  different_key: 'D',
-  answer: 'same'
-}
-```

package/docs/plugins/jspsych-serial-reaction-time-mouse.md

@@ -1,50 +0,0 @@
-# jspsych-serial-reaction-time-mouse plugin
-
-The serial reaction time mouse plugin implements a generalized version of the SRT task [(Nissen & Bullmer, 1987)](https://doi.org/10.1016%2F0010-0285%2887%2990002-8). Squares are displayed in a grid-based system on the screen, and one square changes color. The participant must click on the square that changes color.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](overview.md#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
-----------|------|---------------|------------
-target | array | *undefined* | The location of the target. The array should be the `[row, column]` of the target.
-grid | array | `[[1,1,1,1]]` | This array represents the grid of boxes shown on the screen. Each inner array represents a single row. The entries in the inner arrays represent the columns. If an entry is `1` then a square will be drawn at that location on the grid. If an entry is `0` then the corresponding location on the grid will be empty. Thus, by mixing `1`s and `0`s it is possible to create many different grid-based arrangements.
-grid_square_size | numeric | 100 | The width and height in pixels of each square in the grid.
-target_color | hex color code | `#999` | The color of the target square.
-response_ends_trial | boolean | `true` | If true, the trial ends after a key press. Feedback is displayed if `show_response_feedback` is true.
-pre_target_duration | numeric | 0 | The number of milliseconds to display the grid *before* the target changes color.
-trial_duration | numeric | null | The maximum length of time of the trial, not including feedback.
-fade_duration | numeric | null | If a positive number, the target will progressively change color at the start of the trial, with the transition lasting this many milliseconds.
-allow_nontarget_responses | boolean | false | If true, the user can make nontarget response.
-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 keys to press).
-
-## Data Generated
-
-In addition to the [default data collected by all plugins](overview.md#data-collected-by-plugins), this plugin collects the following data for each trial.
-
-Name | Type | Value
------|------|------
-grid | JSON | A JSON-encoded representation of the grid.
-target | JSON | A JSON-encoded representation of the target on the grid.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the second stimulus first appears on the screen until the subject's response.
-
-## Examples
-
-#### Basic example with four squares in a single row
-```javascript
-var trial = {
-  type: 'serial-reaction-time-mouse',
-  grid: [[1,1,1,1]],
-  target: [0,1]
-}
-```
-
-#### 2x2 grid with extra space in the middle
-```javascript
-var trial = {
-  type: 'serial-reaction-time-mouse',
-  grid: [[1,0,1],[0,0,0],[1,0,1]],
-  target: [0,2]
-}
-```