Is the pitch high or low?
" +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md b/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md new file mode 100644 index 00000000..7b00816b --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md @@ -0,0 +1,47 @@ +# jspsych-audio-keyboard-response + +This plugin plays audio files and records responses generated with the keyboard. + +If the browser supports it, audio files are played using the WebAudio API.This allows for reasonably precise timing +of the playback. The timing of responses generated is measured against the WebAudio specific clock, improving the measurement +of response times. If the browser does not support the WebAudio API, then the audio file is played with HTML5 audio. Audio +files are automatically preloaded by jsPsych. + + The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + + +## Parameters + +This table lists the parameters associated with this plugin. 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 | audio file | *undefined* | The audio file to be played +choices | array of keycodes | `jsPsych.ALL_KEYS` | This array contains the keys that the subject is allowed to press in order to respond to the stimulus. Keys can be specified as their [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) or as characters (e.g. `'a'`, `'q'`). The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. +prompt | string | "" | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g. which key to press). +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. +trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'audio-keyboard-response', + stimulus: 'sound/tone.mp3', + choices: ['e', 'i'], + prompt: "Is the pitch high or low? Press 'e' for low and 'i' for high.
", + response_ends_trial: false +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-audio-slider-response.md b/docs/markdown_docs/plugins/jspsych-audio-slider-response.md new file mode 100644 index 00000000..9008bb73 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-audio-slider-response.md @@ -0,0 +1,51 @@ +# jspsych-audio-slider-response + +This plugin plays audio files and records responses generated with a button click. + +If the browser supports it, audio files are played using the WebAudio API.This allows for reasonably precise timing +of the playback. The timing of responses generated is measured against the WebAudio specific clock, improving the measurement +of response times. If the browser does not support the WebAudio API, then the audio file is played with HTML5 audio. Audio +files are automatically preloaded by jsPsych. + +The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + +## Parameters + +This table lists the parameters associated with this plugin. 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 | audio file | *undefined* | Audio file to be played +labels | array of keycodes/strings | Labels of the slider +button_label | String | *undefined* | 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 +step | integer | 1 | Sets the step of the slider +prompt | String | '' | 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 | integer | -1 | How long to show the stimulus for in milliseconds. If the value is -1, then the stimulus will be shown until the subject makes a response. +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'audio-slider-response', + stimulus: 'sound/tone.mp3', + labels: ['low', 'high'], + button_label: 'Submit', + prompt: "Is the pitch high or low?
", + response_ends_trial: false +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-button-response.md b/docs/markdown_docs/plugins/jspsych-button-response.md deleted file mode 100644 index ae0e6d8e..00000000 --- a/docs/markdown_docs/plugins/jspsych-button-response.md +++ /dev/null @@ -1,43 +0,0 @@ -# jspsych-button-response - -This plugin displays an image or HTML-formatted content and allows the subject to respond by pressing a button on the screen. The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. The button itself can be customized using HTML formatting. - -Because this plugin can display any HTML content, it is quite versatile. It can be used for any situation in which the response generated by the subject is a single button press. - -## Parameters - -This table lists the parameters associated with this plugin. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable. - -Parameter | Type | Default Value | Description -----------|------|---------------|------------ -stimulus | string | *undefined* | The stimulus to display. Either HTML-formatted, or the path to an image. -is_html | boolean | false | If `stimulus` is an HTML-formatted string, this parameter needs to be set to `true`. -choices | array | [ ] | This array contains the labels for the buttons. -button_html | string or array | `''` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on. -prompt | string | "" | 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). -timing_stim | numeric | -1 | How long to show the stimulus for in milliseconds. If the value is -1, then the stimulus will be shown until the subject makes a response. -timing_response | numeric | -1 | 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 -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `timing_response` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. - -## Data Generated - -In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), this plugin collects the following data for each trial. - -Name | Type | Value ------|------|------ -stimulus | string | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. -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. - -## Examples - -#### Displaying image until subject gives a response - -```javascript -var trial = { - type: 'button-response', - stimulus: 'img/happy_face_1.jpg', - choices: ['Happy', 'Sad'], - prompt: "What emotion is this person showing?
" -}; -``` diff --git a/docs/markdown_docs/plugins/jspsych-call-function.md b/docs/markdown_docs/plugins/jspsych-call-function.md index 10918a67..6e761d9c 100644 --- a/docs/markdown_docs/plugins/jspsych-call-function.md +++ b/docs/markdown_docs/plugins/jspsych-call-function.md @@ -11,7 +11,6 @@ This table lists the parameters associated with this plugin. Parameters with a d Parameter | Type | Default Value | Description ----------|------|---------------|------------ func | function | *undefined* | The function to call. -post_trial_gap | numeric | 0 | Unlike other plugins where the default value of this parameter is 1,000ms, the default here is 0. ## Data Generated diff --git a/docs/markdown_docs/plugins/jspsych-categorize-animation.md b/docs/markdown_docs/plugins/jspsych-categorize-animation.md index 24365c26..ce0e5e3b 100644 --- a/docs/markdown_docs/plugins/jspsych-categorize-animation.md +++ b/docs/markdown_docs/plugins/jspsych-categorize-animation.md @@ -18,7 +18,7 @@ frame_time | numeric | 250 | How long to display each image (in milliseconds). sequence_reps | numeric | 1 | How many times to show the entire sequence. allow_response_before_complete | boolean | false | If true, the subject can respond before the animation sequence finishes. prompt | string | "" | 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). -timing_feedback_duration | numeric | 2000 | How long to show the feedback (milliseconds). +feedback_duration | numeric | 2000 | How long to show the feedback (milliseconds). ## Data Generated diff --git a/docs/markdown_docs/plugins/jspsych-categorize.md b/docs/markdown_docs/plugins/jspsych-categorize-html.md similarity index 81% rename from docs/markdown_docs/plugins/jspsych-categorize.md rename to docs/markdown_docs/plugins/jspsych-categorize-html.md index f9fc6ae7..0e60505f 100644 --- a/docs/markdown_docs/plugins/jspsych-categorize.md +++ b/docs/markdown_docs/plugins/jspsych-categorize-html.md @@ -1,6 +1,6 @@ -# jspsych-categorize +# jspsych-categorize-html -The categorize plugin shows an image or HTML object on the screen. The subject responds by pressing a key. Feedback indicating the correctness of the response is given. +The categorize html plugin shows an HTML object on the screen. The subject responds by pressing a key. Feedback indicating the correctness of the response is given. ## Parameters @@ -8,8 +8,7 @@ This table lists the parameters associated with this plugin. Parameters with a d Parameter | Type | Default Value | Description ----------|------|---------------|------------ -stimulus | string | *undefined* | The stimulus to display. Either HTML-formatted, or the path to an image. -is_html | boolean | false | If `stimulus` is an HTML-formatted string, this parameter needs to be set to `true`. +stimulus | html string | *undefined* | The HTML stimulus to display. key_answer | numeric | *undefined* | The [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) indicating the correct response. 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. text_answer | string | "" | A label that is associated with the correct answer. Used in conjunction with the `correct_text` and `incorrect_text` parameters. @@ -20,9 +19,9 @@ force_correct_button_press | boolean | false | If set to true, then the subject show_stim_with_feedback | boolean | true | If set to true, then the stimulus will be shown during feedback. If false, then only the text feedback will display during feedback. show_feedback_on_timeout | boolean | false | If true, then category feedback will be displayed for an incorrect response after a timeout (timing_response is exceeded). If false, then a timeout message will be shown. timeout_message | string | "Please respond faster." | The message to show on a timeout non-response. -timing_stim | numeric | -1 | How long to show the stimulus for (milliseconds). If -1, then the stimulus is shown until a response is given. -timing_feedback_duration | numeric | 2000 | How long to show the feedback for (milliseconds). -timing_response | numeric | -1 | The maximum time allowed for a response. If -1, then the experiment will wait indefinitely for a response. +stimulus_duration | numeric | -1 | How long to show the stimulus for (milliseconds). If -1, then the stimulus is shown until a response is given. +feedback_duration | numeric | 2000 | How long to show the feedback for (milliseconds). +trial_duration | numeric | -1 | The maximum time allowed for a response. If -1, then the experiment will wait indefinitely for a response. ## Data Generated @@ -49,7 +48,6 @@ var categorization_trial = { choices: [80, 81], correct_text: "Correct, this is a %ANS%.
", incorrect_text: "Incorrect, this is a %ANS%.
", - is_html: true, - prompt: "Press P for letter. Press Q for number.
" + prompt: "Press P for letter. Press Q for number.
" }; ``` diff --git a/docs/markdown_docs/plugins/jspsych-categorize-image.md b/docs/markdown_docs/plugins/jspsych-categorize-image.md new file mode 100644 index 00000000..2881d485 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-categorize-image.md @@ -0,0 +1,53 @@ +# jspsych-categorize-html + +The categorize image plugin shows an image object on the screen. The subject responds by pressing a key. Feedback indicating the correctness of the response is given. + +## Parameters + +This table lists the parameters associated with this plugin. 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. +key_answer | numeric | *undefined* | The [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) indicating the correct response. +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. +text_answer | string | "" | A label that is associated with the correct answer. Used in conjunction with the `correct_text` and `incorrect_text` parameters. +correct_text | string | "Correct." | String to show when the correct answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). +incorrect_text | string | "Wrong." | String to show when the wrong answer is given. Can contain HTML formatting. The special string `%ANS%` can be used within the string. If present, the plugin will put the `text_answer` for the trial in place of the %ANS% string (see example below). +prompt | string | "" | 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). +force_correct_button_press | boolean | false | If set to true, then the subject must press the correct response key after feedback is given in order to advance to the next trial. +show_stim_with_feedback | boolean | true | If set to true, then the stimulus will be shown during feedback. If false, then only the text feedback will display during feedback. +show_feedback_on_timeout | boolean | false | If true, then category feedback will be displayed for an incorrect response after a timeout (timing_response is exceeded). If false, then a timeout message will be shown. +timeout_message | string | "Please respond faster." | The message to show on a timeout non-response. +stimulus_duration | numeric | -1 | How long to show the stimulus for (milliseconds). If -1, then the stimulus is shown until a response is given. +feedback_duration | numeric | 2000 | How long to show the feedback for (milliseconds). +trial_duration | numeric | -1 | The maximum time allowed for a response. If -1, then the experiment will wait indefinitely for a response. + + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), this plugin collects the following data for each trial. + +Name | Type | Value +-----|------|------ +stimulus | string | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. +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. +correct | boolean | `true` if the subject got the correct answer, `false` otherwise. + +## Examples + +#### Categorizing HTML content + +```javascript +var categorization_trial = { + type: 'categorize', + stimulus: 'img/someImage.png', + key_answer: 80, + text_answer: 'letter', + choices: [80, 81], + correct_text: "Correct, this is a %ANS%.
", + incorrect_text: "Incorrect, this is a %ANS%.
", + prompt: "Press P for letter. Press Q for number.
" +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-html.md b/docs/markdown_docs/plugins/jspsych-external-html.md similarity index 98% rename from docs/markdown_docs/plugins/jspsych-html.md rename to docs/markdown_docs/plugins/jspsych-external-html.md index 465e2647..521a5b6d 100644 --- a/docs/markdown_docs/plugins/jspsych-html.md +++ b/docs/markdown_docs/plugins/jspsych-external-html.md @@ -1,4 +1,4 @@ -# jspsych-html plugin +# jspsych-external-html plugin The HTML plugin displays an external HTML document (often a consent form). Either a keyboard response or a button press can be used to continue to the next trial. It allows the experimenter to check if conditions are met (such as indicating informed consent) before continuing. @@ -61,7 +61,7 @@ var check_consent = function(elem) { // declare the block. var trial = { - type:'html', + type:'external-html', url: "external_page.html", cont_btn: "start", check_fn: check_consent diff --git a/docs/markdown_docs/plugins/jspsych-html-button-response.md b/docs/markdown_docs/plugins/jspsych-html-button-response.md new file mode 100644 index 00000000..96fe7934 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-html-button-response.md @@ -0,0 +1,44 @@ +# jspsych-html-button-response + +This plugin displays HTML content and records responses generated with a button click.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended +automatically if the subject has failed to respond within a fixed length of time. The button itself can be customized using +HTML formatting. + +## Parameters + +This table lists the parameters associated with this plugin. Parameters with a default value of *undefined* must be specified. +Other parameters can be left unspecified if the default value is acceptable. + +Parameter | Type | Default Value | Description +----------|------|---------------|------------ +stimulus | HTML string | undefined | The string to be displayed. +choices | Array of strings | [] | The button labels. +button_html | HTML string | `''` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on. +prompt | string | "" | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g. which key to press). +trial_duration | numeric | -1 | 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 -1 for the trial and the trial will end. If the value of this parameter is -1, the trial will wait for a response indefinitely. +margin_vertical | String | '0px' | Vertical margin of the button. +margin_horizontal | String | '8px' | Horizontal margin of button. +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 `timing_response` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. +trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), this plugin collects the following data for each trial. + +Name | Type | Value +-----|------|------ +rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. +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. + +## Examples + +#### Displaying question until subject gives a response + +```javascript +var trial = { + type: 'html-button-response', + stimulus: 'Running
', + choices: ['Healthy', 'Unhealthy'], + prompt: "Is this activity healthy or unhealthy?
" +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-html-keyboard-response.md b/docs/markdown_docs/plugins/jspsych-html-keyboard-response.md new file mode 100644 index 00000000..d3bf14a7 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-html-keyboard-response.md @@ -0,0 +1,40 @@ +# jspsych-html-keyboard-response + +This plugin displays HTML content and records responses generated with the keyboard.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + + +## Parameters + +This table lists the parameters associated with this plugin. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable. + +Parameter | Type | Default Value | Description +----------|------|---------------|------------ +stimulus | HTML string | *undefined* | The string to be displayed. +choices | array of keycodes | `jsPsych.ALL_KEYS` | This array contains the keys that the subject is allowed to press in order to respond to the stimulus. Keys can be specified as their [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) or as characters (e.g. `'a'`, `'q'`). The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. +prompt | string | "" | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g. which key to press). +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. +trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'html-keyboard-response', + stimulus: 'Running
', + choices: ['e', 'i'], + prompt: "Is this activity healthy or unhealthy? Press 'e' for healthy and 'i' for unhealthy.
", + response_ends_trial: false +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-html-slider-response.md b/docs/markdown_docs/plugins/jspsych-html-slider-response.md new file mode 100644 index 00000000..fe47f8d4 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-html-slider-response.md @@ -0,0 +1,44 @@ +# jspsych-html-slider-response + +This plugin displays HTML content.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + +## Parameters + +This table lists the parameters associated with this plugin. Parameters with a default value of *undefined* must be specified. Other parameters can be left unspecified if the default value is acceptable. + +Parameter | Type | Default Value | Description +----------|------|---------------|------------ +stimulus | HTML string | *undefined* | The string to be displayed +labels | array of keycodes/strings | Labels of the slider +button_label | String | *undefined* | 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 +step | integer | 1 | Sets the step of the slider +prompt | String | '' | 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 | integer | -1 | How long to show the stimulus for in milliseconds. If the value is -1, then the stimulus will be shown until the subject makes a response. +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'html-slider-response', + stimulus: 'Running
', + labels: ['healthy', 'unhealthy'], + button_label: 'Submit', + prompt: "How healthy/unhealthy is this activity?
", + response_ends_trial: false +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-image-button-response.md b/docs/markdown_docs/plugins/jspsych-image-button-response.md new file mode 100644 index 00000000..18a02d56 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-image-button-response.md @@ -0,0 +1,44 @@ +# jspsych-html-button-response + +This plugin displays an image and records responses generated with a button click.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended +automatically if the subject has failed to respond within a fixed length of time. The button itself can be customized using +HTML formatting. + +## Parameters + +This table lists the parameters associated with this plugin. Parameters with a default value of *undefined* must be specified. +Other parameters can be left unspecified if the default value is acceptable. + +Parameter | Type | Default Value | Description +----------|------|---------------|------------ +stimulus | string | undefined | The path of the image file to be displayed. +choices | Array of strings | [] | The button labels. +button_html | HTML string | `''` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on. +prompt | string | "" | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g. which key to press). +trial_duration | numeric | -1 | 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 -1 for the trial and the trial will end. If the value of this parameter is -1, the trial will wait for a response indefinitely. +margin_vertical | String | '0px' | Vertical margin of the button. +margin_horizontal | String | '8px' | Horizontal margin of button. +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 `timing_response` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. +trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), this plugin collects the following data for each trial. + +Name | Type | Value +-----|------|------ +rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. +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. + +## Examples + +#### Displaying question until subject gives a response + +```javascript +var trial = { + type: 'image-button-response', + stimulus: 'img/happy_face_1.png', + choices: ['Happy', 'Sad'], + prompt: "Is this person happy or sad?
" +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-image-keyboard-response.md b/docs/markdown_docs/plugins/jspsych-image-keyboard-response.md new file mode 100644 index 00000000..f9996535 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-image-keyboard-response.md @@ -0,0 +1,40 @@ +# jspsych-image-keyboard-response + +This plugin displays and image and records responses generated with the keyboard.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + + +## Parameters + +This table lists the parameters associated with this plugin. Parameters with a default value of undefined must be specified. Other parameters can be left unspecified if the default value is acceptable. + +Parameter | Type | Default Value | Description +----------|------|---------------|------------ +stimulus | string | *undefined* | The path of the image file to be displayed. +choices | array of keycodes | `jsPsych.ALL_KEYS` | This array contains the keys that the subject is allowed to press in order to respond to the stimulus. Keys can be specified as their [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) or as characters (e.g. `'a'`, `'q'`). The default value of `jsPsych.ALL_KEYS` means that all keys will be accepted as valid responses. Specifying `jsPsych.NO_KEYS` will mean that no responses are allowed. +prompt | string | "" | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g. which key to press). +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. +trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'image-keyboard-response', + stimulus: 'img/happy_face_1.png', + choices: ['e', 'i'], + prompt: "Is this person happy or sad? Press 'e' for happy and 'i' for sad.
", + response_ends_trial: false +}; +``` diff --git a/docs/markdown_docs/plugins/jspsych-image-slider-response.md b/docs/markdown_docs/plugins/jspsych-image-slider-response.md new file mode 100644 index 00000000..c9778d99 --- /dev/null +++ b/docs/markdown_docs/plugins/jspsych-image-slider-response.md @@ -0,0 +1,44 @@ +# jspsych-image-slider-response + +This plugin displays an image.The stimulus can be displayed until a response is given, or for a pre-determined amount of time. The trial can be ended automatically if the subject has failed to respond within a fixed length of time. + +## Parameters + +This table lists the parameters associated with this plugin. 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. +labels | array of keycodes/strings | Labels of the slider +button_label | String | *undefined* | 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 +step | integer | 1 | Sets the step of the slider +prompt | String | '' | 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 | integer | -1 | How long to show the stimulus for in milliseconds. If the value is -1, then the stimulus will be shown until the subject makes a response. +trial duration | numeric | -1 | 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 the subject's response will be recorded as -1 for the trial and the trial will end. If the value of this parameter is -1, 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 `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. + +## Data Generated + +In addition to the [default data collected by all plugins](overview#datacollectedbyplugins), 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. + +## Examples + +#### Displaying trial until subject gives a response + +```javascript +var trial = { + type: 'image-slider-response', + stimulus: 'img/happy_face_1.png', + labels: ['happy', 'sad'], + button_label: 'Submit', + prompt: "How happy/sad is this person?
", + response_ends_trial: false +}; +```