jspsych 6.3.1 → 7.1.2

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

@@ -1,54 +0,0 @@
-# jspsych-image-slider-response
-
-This plugin displays and image and allows the subject to respond by dragging a slider.
-
-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 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. If the stimulus is an **animated gif**, you must set this parameter to false, because the canvas rendering method will only present static images.
-
-## 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 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/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                              |
-| --------------------- | ------- | ------------- | ---------------------------------------- |
-| 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           | string  | 'ArrowRight'  | This is the key that the subject can press in order to advance to the next page. This key should be specified as a string (e.g., `'a'`, `'ArrowLeft'`, `' '`, `'Enter'`). |
-| key_backward          | string  | 'ArrowLeft'   | This is the key that the subject can press to return to the previous page. This key should be specified as a string (e.g., `'a'`, `'ArrowLeft'`, `' '`, `'Enter'`). |
-| 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/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name         | Type        | Value                                    |
-| ------------ | ----------- | ---------------------------------------- |
-| view_history | array       | An array containing the order of pages the subject viewed (including when the subject returned to previous pages) and the time spent viewing each page. Each object in the array represents a single page view, and contains keys called `page_index` (the page number, starting with 0) and `viewing_time` (duration of the page view). 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 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,41 +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/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
-----------|------|---------------|------------
-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/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 maxdiff table first appears on the screen until the subject's response.
-labels | object | An object with two keys, `left` and `right`, containing the labels (strings) corresponding to the left and right response columns. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. 
-response | object | An object with two keys, `left` and `right`, containing the alternatives selected on the left and right columns. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. 
-
-
-## 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-preload.md

@@ -1,128 +0,0 @@
-# jspsych-preload
-
-This plugin loads images, audio, and video files. It is used for loading files into the browser's memory before they are needed in the experiment, in order to improve stimulus and response timing, and avoid disruption to the experiment flow. We recommend using this plugin anytime you are loading media files, and especially when your experiment requires large and/or many media files. See the [Media Preloading page](/overview/media-preloading/) for more information.
-
-The preload trial will end as soon as all files have loaded successfully. The trial will end or stop with an error message when one of these two scenarios occurs (whichever comes first): (a) all files have not finished loading when the `max_load_time` duration is reached, or (b) all file requests have responded with either a load or fail event, and one or more files has failed to load. The `continue_after_error` parameter determines whether the trial will stop with an error message or end (allowing the experiment to continue) when preloading is not successful.
-
-## Parameters
-
-In addition to the [parameters available in all plugins](/overview/plugins#parameters-available-in-all-plugins), this plugin accepts the following parameters. While there are no specific parameters that are required, the plugin expects to be given a set of files to load through one or more of the following parameters: `auto_preload` or `trials` (for automatic loading), and/or `images`, `audio`, `video` (for manual loading). To automatically load files based on a timeline of trials, either set the `auto_preload` parameter is `true` (to load files based on the main timeline passed to `jsPsych.init`) or use the `trials` parameter to load files based on a specific subset of trials. To manually load a set of files, use the `images`, `audio`, and `video` parameters. You can combine automatic and manual loading methods in a single preload trial.
-
-All other parameters can be left unspecified if the default value is acceptable.
-
-| Parameter             | Type           | Default Value                    | Description                              |
-| --------------------- | -------------- | -------------------------------- | ---------------------------------------- |
-| auto_preload          | boolean        | false                            | If `true`, the plugin will preload any files that can be automatically preloaded based on the main experiment timeline that is passed to `jsPsych.init`. If `false`, any file(s) to be preloaded should be specified by passing a timeline array to the `trials` parameter and/or an array of file paths to the `images`, `audio`, and/or `video` parameters. Setting this parameter to `false` is useful when you plan to preload your files in smaller batches throughout the experiment. |
-| trials                | timeline array | []                               | An array containing one or more jsPsych trial or timeline objects. This parameter is useful when you want to automatically preload stimuli files from a specific subset of the experiment. See [Creating an Experiment: The Timeline](/overview/timeline) for information on constructing timelines. |
-| images                | array          | []                               | Array containing file paths for one or more image files to preload. This option is typically used for image files that can't be automatically preloaded from the timeline. |
-| audio                 | array          | []                               | Array containing file paths for one or more audio files to preload. This option is typically used for audio files that can't be automatically preloaded from the timeline. |
-| video                 | array          | []                               | Array containing file paths for one or more video files to preload. This option is typically used for video files that can't be automatically preloaded from the timeline. |
-| message               | HTML string    | null                             | HTML-formatted message to show above the progress bar while the files are loading. If `null`, then no message is shown. |
-| show_progress_bar     | boolean        | true                             | If `true`, a progress bar will be shown while the files are loading. If `false`, no progress bar is shown. |
-| continue_after_error  | boolean        | false                            | If `false`, then the experiment will stop during this trial if either (a) one or more of the files fails to load, and/or (b) all files do not finish loading before the `max_load_time` duration is reached. The trial will display the `error_message`, as well as the detailed error messages if `show_detailed_errors` is `true`. If `true`, the experiment will continue even if loading fails or times out, and information about loading success/failure will be stored in the trial data (see "Data Generated" below). |
-| error_message         | HTML string    | 'The experiment failed to load.' | HTML-formatted message to be shown on the page after loading fails or times out. Only applies when `continue_after_error` is `false`. |
-| show_detailed_errors  | boolean        | false                            | If `true`, and if `continue_after_error` is `false`, then a list of detailed errors will be shown below the `error_message`. This list will contain the file paths for any files that produced a loading failure, as well as a message indicating that loading timed out, if that was the case. This setting is intended to help the researcher with testing/debugging. If `false`, and if `continue_after_error` is `false`, then only the `error_message` will be shown if loading fails or times out. |
-| max_load_time         | numeric        | null                             | Duration to wait, in milliseconds, for all files to load before loading times out. If one or more files has not finished loading within this time limit, then the trial will stop with an error (if `continue_after_error` is `false`), or the trial will end with information about the loading time-out in the trial data (see "Data Generated" below). If `null`, the trial will wait indefinitely for all files to either load or produce an error. |
-| on_error              | function       | null                             | Function to be called immediately after a file loading request has returned an error. The function receives a single argument, which is the file path that produced the error. This callback is cancelled as soon as the trial ends. See example below. |
-| on_success            | function       | null                             | Function to be called immediately after a file has successfully loaded. The function receives a single argument, which is the file path that finished loading. This callback is cancelled as soon as the trial ends. See example below. |
-
-## 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 | If `true`, then all files loaded successfully within the `max_load_time`. If `false`, then one or more file requests returned a failure and/or the file loading did not complete within the `max_load_time` duration. |
-| timeout        | boolean | If `true`, then the files did not finish loading within the `max_load_time` duration. If `false`, then the file loading did not timeout. Note that when the preload trial does not timeout (`timeout: false`), it is still possible for loading to fail (`success: false`). This happens if one or more files fails to load and all file requests trigger either a success or failure event before the `max_load_time` duration. |
-| failed_images  | array | One or more image file paths that produced a loading failure before the trial ended. |
-| failed_audio   | array | One or more audio file paths that produced a loading failure before the trial ended. |
-| failed_video   | array | One or more video file paths that produced a loading failure before the trial ended. |
-
-
-## Examples
-
-#### Loading files automatically based on the main timeline
-
-```javascript
-var preload = {
-	type: 'preload',
-	auto_preload: true // automatically load all files based on the main timeline
-};
-
-// define other trials to add to the timeline...
-
-jsPsych.init({
-    timeline: [preload, trial1, trial2, trial3]
-});
-```
-
-#### Loading files manually
-
-```javascript
-var preload = {
-	type: 'preload',
-	images: ['file1.png']
-};
-```
-
-#### Combining automatic and manual methods
-
-```javascript
-// automatically load stimuli from the main timeline,
-// and manually add any other stimuli files that can't be loaded automatically
-var preload = {
-	type: 'preload',
-	auto_preload: true,  
-    images: ['image1.png','image2.png']
-};
-
-// define other trials to add to the timeline...
-
-jsPsych.init({
-    timeline: [preload, trial1, trial2, trial3]
-});
-```
-
-#### Loading files in batches
-
-```javascript
-var block_1 = {
-    timeline: [...]
-}
-
-var block_2 = {
-    timeline: [...]
-}
-
-var preload_1 = {
-	type: 'preload',
-	trials: block_1 // automatically load block_1 stimuli
-};
-
-var preload_2 = {
-	type: 'preload',
-	trials: block_2 // automatically load block_2 stimuli
-};
-
-jsPsych.init(
-    // add each preload trial to the timeline before the appropriate trial block
-    timeline: [preload_1, block_1, preload_2, block_2]
-)
-```
-
-#### Using the on_success and on_error functions
-
-```javascript
-var preload = {
-	type: 'preload',
-    audio: ['sound.mp3'],
-	on_success: function(file) {
-        console.log('File loaded: ',file);
-    },
-    on_error: function(file) {
-        console.log('Error loading file: ',file);
-    }
-};
-```
-
-For more examples, see the jspsych-preload.html file in the jsPsych examples folder and the [Media Preloading](/overview/media-preloading) documentation page.

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/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        | Descripton                               |
-| ------------------------ | ---------------- | -------------------- | ---------------------------------------- |
-| choices                  | array of strings | jsPsych.ALL_KEYS     | The valid keys that the subject can press as a response. Must be an array of strings. If left unspecified, any key is a valid key. |
-| correct_choice           | array or string  | *undefined*          | The keys that are considered the correct response for that particular trial. Can be a single string or an array of strings. 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/plugins#data-collected-by-all-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. |
-| response         | string      | The key that the subject pressed.        |
-| 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 | array       | The array that holds the number of miliseconds for each frame in this trial. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. |
-| 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/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
-----------|------|---------------|------------
-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 | string | 'h' | The key to press for increasing the parameter value.
-key_decrease | string | '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/plugins#data-collected-by-all-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/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
-----------|------|---------------|------------
-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/plugins#data-collected-by-all-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/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*   | 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             | string  | 'q'           | The key that subjects should press to indicate that the two stimuli are the same. |
-| different_key        | 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/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | array   | An array of length 2 containing the HTML-formatted content that the subject saw for each trial. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. |
-| 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 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. |
-| response_stim1  | string  | Indicates which key the subject pressed to continue. |
-
-## 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/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*   | 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             | string  | 'q'           | The key that subjects should press to indicate that the two stimuli are the same. |
-| different_key        | 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/plugins#data-collected-by-all-plugins), this plugin collects the following data for each trial.
-
-| Name      | Type    | Value                                    |
-| --------- | ------- | ---------------------------------------- |
-| stimulus  | array   | An array of length 2 containing the paths to the image files that the subject saw for each trial. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. |
-| 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 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. |
-| response_stim1 | string  | Indicates which key the subject pressed to continue. |
-
-## 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'
-}
-```