HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-11 16:18:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
Josh de Leeuw 2018-01-01 22:35:51 -05:00
parent ca3328ec82
commit 9ef744a51d
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/markdown_docs/plugins/jspsych-audio-button-response.md
View File

@ -17,8 +17,8 @@ choices | array of strings | [] | Labels for the buttons. Each different string
button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on.
prompt | string | "" | 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.
margin_vertical | String | '0px' | Vertical margin of the button(s).
margin_horizontal | String | '8px' | Horizontal margin of the button(s).
response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `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.

4
docs/markdown_docs/plugins/jspsych-html-button-response.md
View File

@ -17,8 +17,8 @@ button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` |
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.
stimulus_duration | numeric | -1 | How long to display the stimulus in milliseconds. The visibility CSS property of the stimulus will be set to `hidden` after this time has elapsed. If this is -1, then the stimulus will remain visible until the trial ends.
margin_vertical | String | '0px' | Vertical margin of the button.
margin_horizontal | String | '8px' | Horizontal margin of button.
margin_vertical | String | '0px' | Vertical margin of the button(s).
margin_horizontal | String | '8px' | Horizontal margin of the button(s).
response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `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

12
docs/markdown_docs/plugins/jspsych-image-button-response.md
View File

@ -1,23 +1,23 @@
# 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
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
Parameters with a default value of *undefined* must be specified.
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.
choices | array of strings | [] | Labels for the buttons. Each different string in the array will generate a different button.
button_html | HTML string | `'<button class="jspsych-btn">%choice%</button>'` | A template of HTML for generating the button elements. You can override this to create customized buttons of various kinds. The string `%choice%` will be changed to the corresponding element of the `choices` array. You may also specify an array of strings, if you need different HTML to render for each button. If you do specify an array, the `choices` array and this array must have the same length. The HTML from position 0 in the `button_html` array will be used to create the button for element 0 in the `choices` array, and so on.
prompt | string | "" | 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.
margin_vertical | String | '0px' | Vertical margin of the button(s).
margin_horizontal | String | '8px' | Horizontal margin of the button(s).
response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `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.