jspsych 6.2.0 → 7.1.0

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

@@ -1,57 +0,0 @@
-# jspsych-serial-reaction-time plugin
-
-The serial reaction time plugin implements a generalized version of the SRT task [(Nissen & Bullemer, 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 presses a key that corresponds to the darkened key. Feedback is optionally displayed, showing the participant which square the key they pressed matches.
-
-## 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.
-choices | array | `[['3','5','7','9']]` | The dimensions of this array must match the dimensions of `grid`. Each entry in this array is the key that should be pressed for that corresponding location in the grid. Entries can be left blank if there is no key associated with that location of the grid.
-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.
-show_response_feedback | boolean | false | If true, show feedback indicating where the user responded and whether it was correct.
-feedback_duration | numeric | 200 |The length of time in milliseconds to show the 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.
-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.
-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 target.
-
-## Examples
-
-#### Basic example with four squares in a single row
-```javascript
-var trial = {
-  type: 'serial-reaction-time',
-  grid: [[1,1,1,1]],
-  target: [0,1]
-}
-```
-
-#### 2x2 grid, Showing feedback for 500ms
-```javascript
-var trial = {
-  type: 'serial-reaction-time',
-  grid: [[1,1],[1,1]],
-  choices: [['r','t'],['f','g']],
-  target: [1,0],
-  show_response_feedback: true,
-  feedback_duration: 500
-}
-```

package/docs/plugins/jspsych-survey-html-form.md

@@ -1,50 +0,0 @@
-# jspsych-survey-html-form plugin
-
-The survey-html-form plugin displays a set of `<inputs>` from a HTML string. The type of input can be freely chosen, for a list of possible input types see the [MDN page on inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). The subject provides answers to the input fields.
-
-## 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
-----------|------|---------------|------------
-html | string | *undefined* | HTML formatted string containing all the input elements to display. Every element has to have its own distinctive name attribute. The `<form>` tag must not be included and is generated by the plugin. This string can contain other HTML elements besides the input fields.
-preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
-button_label | string |  'Continue' | The text that appears on the button to finish the trial.
-dataAsArray | boolean |  false | Retrieve the data as an array e.g. [{name: "INPUT_NAME", value: "INPUT_VALUE"}, ...] instead of an object e.g. {INPUT_NAME: INPUT_VALUE, ...}. This might be useful if you omit naming your inputs.
-autofocus | string | empty string | The HTML element ID of a form field to autofocus on. The focused element is the element that will receive keyboard events. For elements like `<input type="text">` or `<textbox>`, autofocus means that the cursor will appear in the text input area when the trial loads.
-autocomplete | boolean | false | This determines whether or not all of the input elements on the page should allow autocomplete. Setting this to true will enable autocomplete or auto-fill for the form.
-
-## 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
------|------|------
-responses | string | A JS object encoded in JSON format containing the response for each input. The encoded object will have a separate variable for the response to each input, with each variable being named after its corresponding input element. Each response is a string containing whatever the subject answered for this particular input.
-rt | numeric | The response time in milliseconds for the subject to make a response.
-
-## Examples
-
-### Basic example
-
-```javascript
-var form_trial = {
-  type: 'survey-html-form',
-  preamble: '<p> How are you feeling <b>right now?</b> </p>',
-  html: '<p> I am feeling <input name="first" type="text" />, <input name="second" type="text" />, and <input name="third" type="text" />.</p>'
-};
-```
-
-### Example using the autofocus parameter
-
-In this example, the browser will focus on the element with the ID `test-resp-box` when the trial loads. For `<input type="text">` elements, this means that the cursor will appear inside the text box.
-
-```javascript
-var autofocus_trial = {
-  type: 'survey-html-form',
-  preamble: '<p> What is your favorite bird?</p>',
-  html: '<p>My favorite bird is <input type="text" id="test-resp-box" name="response" size="10" /></p>',
-  autofocus: 'test-resp-box'
-};
-```

package/docs/plugins/jspsych-survey-likert.md

@@ -1,70 +0,0 @@
-# jspsych-survey-likert plugin
-
-The survey-likert plugin displays a set of questions with Likert scale responses. The subject responds by selecting a radio button.
-
-## 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
-----------|------|---------------|------------
-questions | array | *undefined* | An array of objects, each object represents a question that appears on the screen. Each object contains a prompt, labels and required parameter that will be applied to the question. See examples below for further clarification.`prompt`: Type string, default value is *undefined*. The strings are the question that will be associated with a slider. `labels`: Type array, default value is *undefined*. Each array element is an array of strings. The innermost arrays contain a set of labels to display for an individual question. If you want to use blank responses and only label the end points or some subset of the options, just insert a blank string for the unlabeled responses.`required`: Type boolean, default value is false. Makes answering questions required. `name`: Name of the question. Used for storing data. If left undefined then default names (`Q0`, `Q1`, `...`) will be used for the questions.
-randomize_question_order | boolean | `false` | If true, the display order of `questions` is randomly determined at the start of the trial. In the data object, `Q0` will still refer to the first question in the array, regardless of where it was presented visually.
-preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
-scale_width | numeric | null | The width of the likert scale in pixels. If left `null`, then the width of the scale will be equal to the width of the widest content on the page.
-button_label | string |  'Continue' | Label of the button.
-autocomplete | boolean | false | This determines whether or not all of the input elements on the page should allow autocomplete. Setting this to true will enable autocomplete or auto-fill for the form.
-
-## 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
------|------|------
-responses | JSON string | A string in JSON format containing the response for each question. The encoded object will have a separate variable for the response to each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. The responses are recorded as integers, representing the position of the slider on the scale. If the `name` parameter is defined for the question, then the response will use the value of `name` as the key for the response in the `responses` object.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the questions first appear on the screen until the subject's response.
-question_order | JSON string | A string in JSON format containing an array with the order of questions. For example `[2,0,1]` would indicate that the first question was `trial.questions[2]` (the third item in the `questions` parameter), the second question was `trial.questions[0]`, and the final question was `trial.questions[1]`.
-
-## Examples
-
-#### Basic example
-
-```javascript
-var scale_1 = [
-  "Strongly Disagree", 
-  "Disagree", 
-  "Neutral", 
-  "Agree", 
-  "Strongly Agree"
-];
-
-var likert_page = {
-  type: 'survey-likert',
-  questions: [
-    {prompt: "I like vegetables.", labels: scale_1}
-  ]
-};
-```
-
-#### Multiple questions in a random order
-
-```javascript
-var scale_1 = [
-  "Strongly Disagree", 
-  "Disagree", 
-  "Neutral", 
-  "Agree", 
-  "Strongly Agree"
-];
-
-var likert_page = {
-  type: 'survey-likert',
-  questions: [
-    {prompt: "I like vegetables.", name: 'Vegetables', labels: scale_1},
-    {prompt: "I like fruit.", name: 'Fruit', labels: scale_1},
-    {prompt: "I like meat.", name: 'Meat', labels: scale_1},
-    {prompt: "I like dairy.", name: 'Dairy', labels: scale_1}
-  ],
-  randomize_question_order: true
-};
-```

package/docs/plugins/jspsych-survey-multi-choice.md

@@ -1,48 +0,0 @@
-# jspsych-survey-multi-choice plugin
-
-The survey-multi-choice plugin displays a set of questions with multiple choice response fields. The subject selects a single answer.
-
-## 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
-----------|------|---------------|------------
-questions | array | *undefined* | An array of objects, each object represents a question that appears on the screen. Each object contains a prompt, options, required, and horizontal parameter that will be applied to the question. See examples below for further clarification.`prompt`: Type string, default value is *undefined*. The string is prompt/question that will be associated with a group of options (radio buttons). All questions will get presented on the same page (trial).`options`: Type array, defualt value is *undefined*. An array of strings. The array contains a set of options to display for an individual question.`required`: Type boolean, default value is null. The boolean value indicates if a question is required('true') or not ('false'), using the HTML5 `required` attribute. If this parameter is undefined, the question will be optional. `horizontal`:Type boolean, default value is false. If true, then the question is centered and the options are displayed horizontally. `name`: Name of the question. Used for storing data. If left undefined then default names (`Q0`, `Q1`, `...`) will be used for the questions.
-randomize_question_order | boolean | `false` | If true, the display order of `questions` is randomly determined at the start of the trial. In the data object, `Q0` will still refer to the first question in the array, regardless of where it was presented visually.
-preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
-button_label | string |  'Continue' | Label of the button.
-autocomplete | boolean | false | This determines whether or not all of the input elements on the page should allow autocomplete. Setting this to true will enable autocomplete or auto-fill for the form.
-
-## 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
------|------|------
-responses | JSON string | A string in JSON format containing the response for each question. The encoded object will have a separate variable for the response to each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. The responses are recorded as the name of the option label. If the `name` parameter is defined for the question, then the response will use the value of `name` as the key for the response in the `responses` object.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the questions first appear on the screen until the subject's response.
-question_order | JSON string | A string in JSON format containing an array with the order of questions. For example `[2,0,1]` would indicate that the first question was `trial.questions[2]` (the third item in the `questions` parameter), the second question was `trial.questions[0]`, and the final question was `trial.questions[1]`.
-
-## Examples
-
-```javascript
-var page_1_options = ["Strongly Disagree", "Disagree", "Neutral", "Agree", "Strongly Agree"];
-var page_2_options = ["Strongly Disagree", "Disagree", "Somewhat Disagree", "Neural", "Somewhat Agree", "Agree", "Strongly Agree"];
-
-var multi_choice_block = {
-  type: 'survey-multi-choice',
-  questions: [
-    {prompt: "I like vegetables", name: 'Vegetables', options: page_1_options, required:true}, 
-    {prompt: "I like fruit", name: 'Fruit', options: page_2_options, required: false}
-  ],
-};
-
-var multi_choice_block_horizontal = {
-  type: 'survey-multi-choice',
-  questions: [
-    {prompt: "I like vegetables", options: page_1_options, required: true, horizontal: true,}, 
-    {prompt: "I like fruit", options: page_2_options, required: false, horizontal: true}
-  ],
-};
-```

package/docs/plugins/jspsych-survey-multi-select.md

@@ -1,53 +0,0 @@
-# jspsych-survey-multi-select plugin
-
-The survey-multi-select plugin displays a set of questions with multiple select response fields. The subject could select multiple answers.
-
-## 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
-----------|------|---------------|------------
-questions | array | *undefined* | An array of objects, each object represents a question that appears on the screen. Each object contains a prompt, options and horizontal parameter that will be applied to the question. See examples below for further clarification.`prompt`: Type string, default value of *undefined*. The string is the prompt/question that will be associated with a group of options (check boxes). All questions will get presented on the same page (trial).`options`: Type array, default value of *undefined*. The array contains a set of options to display for an individual question.`horizontal`: Type boolean, default value of false. If true, the questions are centered and options are displayed horizontally. `required`: Type boolean, default value of true. If true, then at least one option must be selected. `name`: Name of the question. Used for storing data. If left undefined then default names (`Q0`, `Q1`, `...`) will be used for the questions.
-randomize_question_order | boolean | `false` | If true, the display order of `questions` is randomly determined at the start of the trial. In the data object, `Q0` will still refer to the first question in the array, regardless of where it was presented visually.
-preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
-button_label | string |  'Continue' | Label of the button.
-required_message | string | 'You must choose at least one response for this question' | Message to display if required response is not given.
-autocomplete | boolean | false | This determines whether or not all of the input elements on the page should allow autocomplete. Setting this to true will enable autocomplete or auto-fill for the form.
-
-## 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
------|------|------
-responses | JSON string | An array containing all selected choices in JSON format for each question. The encoded object will have a separate variable for the response to each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. The responses are recorded as the name of the option label. If the `name` parameter is defined for the question, then the response will use the value of `name` as the key for the response in the `responses` object.
-rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the questions first appear on the screen until the subject's response.
-question_order | JSON string | A string in JSON format containing an array with the order of questions. For example `[2,0,1]` would indicate that the first question was `trial.questions[2]` (the third item in the `questions` parameter), the second question was `trial.questions[0]`, and the final question was `trial.questions[1]`.
-
-## Examples
-
-#### Basic example with multiple questions on a page.
-
-```javascript
-var multi_select_block = {
-    type: 'survey-multi-select',
-    questions: [
-      {
-        prompt: "Which of these colors do you like?", 
-        options: ["Red", "Yellow", "Green", "Blue", "Black"], 
-        horizontal: true,
-        required: true,
-        name: 'Colors'
-      }, 
-      {
-        prompt: "Which of these foods do you like?", 
-        options: ["Apples", "Bananas", "Carrots", "Donuts", "Eggplant"], 
-        horizontal: true,
-        required: true,
-        name: 'Foods'
-      }
-    ], 
-    randomize_question_order: true
-};
-```

package/docs/plugins/jspsych-survey-text.md

@@ -1,63 +0,0 @@
-# jspsych-survey-text plugin
-
-The survey-text plugin displays a set of questions with free response text fields. The subject types in answers.
-
-## 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
-----------|------|---------------|------------
-questions | array | *undefined* | An array of objects, each object represents a question that appears on the screen. Each object contains a prompt, value, required, rows, and columns parameter that will be applied to the question. See examples below for further clarification. `prompt`: Type string, default value of *undefined*. The string is the prompt for the subject to respond to. Each question gets its own response field. `placeholder`: Type string, default value of `""`. The string will create placeholder text in the text field. `required`: Boolean; if `true` then the user must enter a response to submit. `rows`: Type integer, default value of 1. The number of rows for the response text box. `columns`: Type integer, default value of 40. The number of columns for the response text box. `name`: Name of the question. Used for storing data. If left undefined then default names (`Q0`, `Q1`, `...`) will be used for the questions.
-randomize_question_order | boolean | `false` | If true, the display order of `questions` is randomly determined at the start of the trial. In the data object, `Q0` will still refer to the first question in the array, regardless of where it was presented visually.
-preamble | string | empty string | HTML formatted string to display at the top of the page above all the questions.
-button_label | string |  'Continue' | The text that appears on the button to finish the trial.
-autocomplete | boolean | false | This determines whether or not all of the input elements on the page should allow autocomplete. Setting this to true will enable autocomplete or auto-fill for the form.
-
-## 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
------|------|------
-responses | JSON string | A string in JSON format containing the response for each question. The encoded object will have a separate variable for the response to each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. Each response is a string containing whatever the subject typed into the associated text box. If the `name` parameter is defined for the question, then the response will use the value of `name` as the key for the response in the `responses` object.
-rt | numeric | The response time in milliseconds for the subject to make a response.
-question_order | JSON string | A string in JSON format containing an array with the order of questions. For example `[2,0,1]` would indicate that the first question was `trial.questions[2]` (the third item in the `questions` parameter), the second question was `trial.questions[0]`, and the final question was `trial.questions[1]`.
-
-## Examples
-
-### Basic example
-
-```javascript
-var survey_trial = {
-  type: 'survey-text',
-  questions: [
-    {prompt: "How old are you?"}, 
-    {prompt: "Where were you born?", placeholder: "City, State/Province, Country"}
-  ],
-};
-```
-
-### Custom number of rows and columns
-
-```javascript
-var survey_trial = {
-  type: 'survey-text',
-  questions: [
-    {prompt: "How old are you?", rows: 5, columns: 40}, 
-    {prompt: "Where were you born?", rows: 3, columns: 50}
-  ],
-};
-```
-
-### Defining the name of questions
-
-```javascript
-var survey_trial = {
-  type: 'survey-text',
-  questions: [
-    {prompt: "How old are you?", name: 'Age'}, 
-    {prompt: "Where were you born?", name: 'BirthLocation'}
-  ],
-};
-```

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

@@ -1,52 +0,0 @@
-# jspsych-video-button-response plugin
-
-This plugin plays a video 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 when the subject responds, when the video file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a button response from being made before the video has finished playing. The button itself can be customized using HTML formatting.
-
-## 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 | array | *undefined* | An array of file paths to the video. You can specify multiple formats of the same video (e.g., .mp4, .ogg, .webm) to maximize the [cross-browser compatibility](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats). Usually .mp4 is a safe cross-browser option. The plugin does not reliably support .mov files. The player will use the first source file in the array that is compatible with the browser, so specify the files in order of preference.
-choices | array of strings | *undefined* | 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.
-margin_vertical | string | '0px' | Vertical margin of the button(s).
-margin_horizontal | string | '8px' | Horizontal margin of the button(s).
-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).
-width | numeric | width of the video file | The width of the video display in pixels.
-height | numeric | heigh of the video file | The height of the video display in pixels.
-autoplay | boolean | true | If true, the video will begin playing as soon as it has loaded.
-controls | boolean | false | If true, controls for the video player will be available to the subject. They will be able to pause the video or move the playback to any point in the video.
-start | numeric | null | If given a value, the video will start at this time point in seconds.
-stop| numeric | null | If given a value, the video will stop at this time point in seconds.
-rate | numeric | null | The playback rate of the video. 1 is normal, <1 is slower, >1 is faster.
-trial_ends_after_video | bool | false | If true, then the trial will end as soon as the video file finishes playing.
-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.
-response_allowed_while_playing | boolean | true | If true, then responses are allowed while the video is playing. If false, then the video must finish playing before the button choices are enabled and a response is accepted. Once the video has played all the way through, the buttons are enabled and a response is allowed (including while the video is being re-played via on-screen playback controls). 
-
-
-## 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
------|------|------
-button_pressed | numeric | Indicates which button the subject pressed. The first button in the `choices` array is 0, the second is 1, and so on.
-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 | JSON encoding of the `stimulus` array.
-
-## Example
-
-```javascript
-var trial = {
-	type: 'video-button-response',
-	stimulus: [
-		'video/sample_video.mp4',
-		'video/sample_video.ogg'
-	],
-	choices: ['Happy','Sad','Angry','Peaceful'],
-	prompt: '<p>Which emotion the best descriptor of the main character\'s feelings?</p>'
-}
-```

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

@@ -1,48 +0,0 @@
-# jspsych-video-keyboard-response plugin
-
-This plugin plays a video file and records a keyboard response. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically when the subject responds, when the video file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent a keyboard response from being recorded before the video has finished playing.
-
-## 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 | array | *undefined* | An array of file paths to the video. You can specify multiple formats of the same video (e.g., .mp4, .ogg, .webm) to maximize the [cross-browser compatibility](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats). Usually .mp4 is a safe cross-browser option. The plugin does not reliably support .mov files. The player will use the first source file in the array that is compatible with the browser, so specify the files in order of preference.
-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).
-width | numeric | width of the video file | The width of the video display in pixels.
-height | numeric | heigh of the video file | The height of the video display in pixels.
-autoplay | boolean | true | If true, the video will begin playing as soon as it has loaded.
-controls | boolean | false | If true, controls for the video player will be available to the subject. They will be able to pause the video or move the playback to any point in the video.
-start | numeric | null | If given a value, the video will start at this time point in seconds.
-stop| numeric | null | If given a value, the video will stop at this time point in seconds.
-rate | numeric | null | The playback rate of the video. 1 is normal, <1 is slower, >1 is faster.
-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.
-trial_ends_after_video | bool | false | If true, then the trial will end as soon as the video file finishes playing.
-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.
-response_allowed_while_playing | boolean | true | If true, then responses are allowed while the video is playing. If false, then the video must finish playing before a keyboard response is accepted. Once the video has played all the way through, a valid keyboard response is allowed (including while the video is being re-played via on-screen playback controls). 
-
-## 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 | JSON encoding of the `stimulus` array.
-
-## Example
-
-```javascript
-var trial = {
-	type: 'video-keyboard-response',
-	stimulus: [
-		'video/sample_video.mp4',
-		'video/sample_video.ogg'
-	],
-	choices: ['y','n'],
-	width: 640
-}
-```

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

@@ -1,58 +0,0 @@
-# jspsych-video-slider-response plugin
-
-This plugin plays a video and allows the subject to respond by dragging a slider. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically when the subject responds, when the video file has finished playing, or if the subject has failed to respond within a fixed length of time. You can also prevent the slider response from being made before the video has finished playing.
-
-## 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 | array | *undefined* | An array of file paths to the video. You can specify multiple formats of the same video (e.g., .mp4, .ogg, .webm) to maximize the [cross-browser compatibility](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats). Usually .mp4 is a safe cross-browser option. The plugin does not reliably support .mov files. The player will use the first source file in the array that is compatible with the browser, so specify the files in order of preference.
-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).
-width | numeric | width of the video file | The width of the video display in pixels.
-height | numeric | heigh of the video file | The height of the video display in pixels.
-autoplay | boolean | true | If true, the video will begin playing as soon as it has loaded.
-controls | boolean | false | If true, controls for the video player will be available to the subject. They will be able to pause the video or move the playback to any point in the video.
-start | numeric | null | If given a value, the video will start at this time point in seconds.
-stop| numeric | null | If given a value, the video will stop at this time point in seconds.
-rate | numeric | null | The playback rate of the video. 1 is normal, <1 is slower, >1 is faster.
-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.
-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.
-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.
-button_label | string | 'Continue' | Label of the button to end the trial.
-trial_ends_after_video | bool | false | If true, then the trial will end as soon as the video file finishes playing.
-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.
-response_allowed_while_playing | boolean | true | If true, then responses are allowed while the video is playing. If false, then the video must finish playing before the slider is enabled and the trial can end via the next button click. Once the video has played all the way through, the slider is enabled and a response is allowed (including while the video is being re-played via on-screen playback controls). 
-
-
-## 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 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 | JSON encoding of the `stimulus` array.
-slider_start | numeric | The starting value of the slider.
-start | numeric | The start time of the video clip.
-
-## Example
-
-```javascript
-var trial = {
-	type: 'video-slider-response',
-	stimulus: [
-		'video/sample_video.mp4',
-		'video/sample_video.ogg'
-	],
-	labels: ["Did not like", "Liked"],
-	prompt: "<p>Please rate your enjoyment of the video clip.</p>"
-}
-```

package/docs/plugins/jspsych-visual-search-circle.md

@@ -1,52 +0,0 @@
-# jspsych-visual-search-circle plugin
-
-This plugin presents a customizable visual-search task modelled after [Wang, Cavanagh, & Green (1994)](http://dx.doi.org/10.3758/BF03206946). The subject indicates whether or not a target is present among a set of distractors. The stimuli are displayed in a circle, evenly-spaced, equidistant from a fixation point. Here is an example using normal and backward Ns:
-
-![Sample Visual Search Stimulus](/img/visual_search_example.jpg)
-
-## 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_present | boolean | *undefined* | Is the target present?
-set_size | numeric | *undefined* | How many items should be displayed?
-target | string | *undefined* | Path to image file that is the search target.
-foil | string or array | *undefined* | Path to image file that is the foil/distractor. Can specify an array of distractors if the distractors are all different images.
-fixation_image | string | *undefined* | Path to image file that is a fixation target.
-target_size | array | `[50, 50]` | Two element array indicating the height and width of the search array element images.
-fixation_size | array | `[16, 16]` | Two element array indicating the height and width of the fixation image.
-circle_diameter | numeric | 250 | The diameter of the search array circle in pixels.
-target_present_key | numeric | 74 | The key to press if the target is present in the search array.
-target_absent_key | numeric | 70 | The key to press if the target is not present in the search array.
-trial_duration | numeric | null | The maximum amount of time the subject is allowed to search before the trial will continue. A value of null will allow the subject to search indefinitely.
-fixation_duration | numeric | 1000 | How long to show the fixation image for before the search array (in milliseconds).
-
-## 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
------|------|------
-correct | boolean | True if the subject gave the correct response.
-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.
-set_size | numeric | The number of items in the search array
-target_present | boolean | True if the target is present in the search array
-locations | JSON string | JSON-encoded array where each element of the array is the pixel value of the center of an image in the search array. If the target is present, then the first element will represent the location of the target.
-
-## Example
-
-#### Search for the backward N
-
-```javascript
-var trial_1 = {
-  type: 'visual-search-circle',
-  target: 'img/backwardN.gif',
-  foil: 'img/normalN.gif',
-  fixation_image: 'img/fixation.gif',
-  target_present: true,
-  set_size: 4
-}
-```

package/docs/plugins/jspsych-vsl-animate-occlusion.md

@@ -1,55 +0,0 @@
-# jspsych-vsl-animate-occlusion plugin
-
-The VSL (visual statistical learning) animate occlusion plugin displays an animated sequence of shapes that disappear behind an occluding rectangle while they change from one shape to another. This plugin can be used to replicate the experiments described in:
-
-Fiser, J., & Aslin, R. N. (2002). Statistical learning of higher-order temporal structure from visual shape sequences. *Journal of Experimental Psychology: Learning, Memory, and Cognition, 28*(3), 458.
-
-## Dependency
-
-This plugin requires the Snap.svg library, available at [http://www.snapsvg.io](http://www.snapsvg.io). You must include the library in the `<head>` section of your experiment page.
-
-## 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* | Each element of the array is a stimulus. A stimulus is a path to an image file. The order of stimuli in the array determines the order of the animation sequence.
-canvas_size | array | `[400, 400]` | Array specifying the width and height of the area that the animation will display in. Stimuli will move to the edges of this area, so increasing the width without increasing the `timing_cycle` parameter will speed up the images.
-image_size | array | `[100, 100]` | Array specifying the width and height of the images to show. The occluding rectangle will have a width equal to the width of image_size.
-initial_direction | string | "left" | Which direction the stimulus should move first (subsequent directions will alternate). Choices are "left" or "right".
-occlude_center | boolean | true | If true, display a rectangle in the center of the screen that is just wide enough to occlude the image completely as it passes behind.
-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.
-cycle_duration | numeric | 1000 | How long it takes for a stimulus in the sequence to make a complete cycle (move to the edge and back to the center) in milliseconds.
-pre_movement_duration | numeric | 500 | How long to wait before the stimuli starts moving from behind the center rectangle.
-
-## 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 | JSON string | A JSON encoded array where each element of the array is a stimulus from the sequence, in the order that they were shown.
-responses | JSON string | A JSON encoded array containing all response information. The encoded object is an array containing one element for each valid response. Each response item has three properties: `key` the key code of the response key, `stimulus` the index of the stimulus that was displayed when the response was made, and `rt` the response time measured since the start of the sequence.
-
-## Examples
-
-#### Displaying a simple sequence.
-
-```javascript
-var trial = {
-  type: 'vsl-animate-occlusion',
-  stimuli: [
-    "img/1.gif",
-    "img/2.gif",
-    "img/3.gif",
-    "img/4.gif",
-    "img/5.gif",
-    "img/6.gif",
-    "img/7.gif",
-    "img/8.gif",
-    "img/9.gif",
-    "img/10.gif"
-  ]
-}
-```