diff --git a/Documentation.md b/Documentation.md index 78e9733..dbcd72b 100644 --- a/Documentation.md +++ b/Documentation.md @@ -4,13 +4,13 @@ All-in-one starter app with behavioral task trials
countdown
-

Builds a countdown transition with the given text and number of seconds.

+

Builds a countdown transition with the given message and number of seconds.

fixation

Builds a trial with a fixation dot and optional photodiode box.

showImage
-

Builds a trial with a onscreen message, optional buttons and optional photodiode box

+

Builds a trial with a onscreen message and optional photodiode box

showMessage

Builds a trial with a onscreen message, optional buttons and optional photodiode box

@@ -23,16 +23,16 @@ All-in-one starter app with behavioral task trials ## countdown -Builds a countdown transition with the given text and number of seconds. +Builds a countdown transition with the given message and number of seconds. | Param | Type | Description | | --- | --- | --- | | options | Object | | -| options.duration | number | The trial duration. | -| options.text | string | Optional text for the countdown. (default: "") | -| options.time | number | The number of seconds for the countdown. (default: 10s) | -| options.responseEndsTrial | boolean | True if the trial ends on response, false if the trial waits for the duration. (default: false) | +| options.duration | number | trial duration in milliseconds. (default: 1000) | +| options.stimulus | string | Onscreen stimulus in HTML to be shown in the trial. If the stimulus is not provided, message should be provided as a string. (default: "") | +| options.message | string | (optional) message for the countdown. (default: "") | +| options.time | number | start number for the countdown. (default: 3) | @@ -48,16 +48,15 @@ Builds a trial with a fixation dot and optional photodiode box. | config.USE_ELECTRON | boolean | USE_ELECTRON flag | | config.USE_MTURK | boolean | USE_MTURK flag | | options | Object | | -| options.duration | number | The trial duration in milliseconds. | -| options.responseEndsTrial | boolean | True if the trial ends on response,false if the trial waits for the duration, by default false value. | -| options.taskCode | number | Task code to be saved into data log and for pdSpotEncode, which by default is null and is passed when config has USE_PHOTODIODE set true. | -| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. If not set, by default is 1. | -| options.buttons | any | 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 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. | +| options.duration | number | trial duration in milliseconds jittered with the jitter param. (default: 1000) | +| options.jitter | number | jitter range (0-jitter) to add from to the trial duration (default: 50) | +| options.taskCode | number | Task code to be saved into data log (default: 1) | +| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. (default: 1) | ## showImage -Builds a trial with a onscreen message, optional buttons and optional photodiode box +Builds a trial with a onscreen message and optional photodiode box | Param | Type | Description | @@ -67,15 +66,14 @@ Builds a trial with a onscreen message, optional buttons and optional photodiode | config.USE_EEG | boolean | USE_EEG flag | | config.USE_ELECTRON | boolean | USE_ELECTRON flag | | config.USE_MTURK | boolean | USE_MTURK flag | +| image | string | The path of the image file to be displayed. | | options | Object | | -| options.responseType | string | This tells jsPsych which plugin file to use to run the trial. | -| options.duration | number | The trial duration in milliseconds. | -| options.image | string | The path of the image file to be displayed. | -| options.imageHeight | number | Set the height of the image in pixels. If left null (no value specified), then the image will display at its natural height. | -| options.imageWidth | number | Set the width of the image in pixels. If left null (no value specified), then the image will display at its natural width. | -| options.responseEndsTrial | boolean | True if the trial ends on response,false if the trial waits for the duration, by default false value. | -| options.taskCode | number | Task code to be saved into data log and for pdSpotEncode, which by default is null and is passed when config has USE_PHOTODIODE set true. | -| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. If not set, by default is 1. | +| options.duration | number | trial duration in milliseconds jittered with the jitter param. (default: 1000) | +| options.jitter | number | jitter range (0-jitter) to add from to the trial duration (default: 50) | +| options.imageHeight | number | Set the height of the image in pixels. (default: 600) | +| options.imageWidth | number | Set the width of the image in pixels. (default: 600) | +| options.taskCode | number | Task code to be saved into data log (default: 1) | +| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. (default: 1) | @@ -91,15 +89,15 @@ Builds a trial with a onscreen message, optional buttons and optional photodiode | config.USE_ELECTRON | boolean | USE_ELECTRON flag | | config.USE_MTURK | boolean | USE_MTURK flag | | options | Object | | -| options.responseType | string | This tells jsPsych which plugin file to use to run the trial. | -| options.duration | number | The trial duration in milliseconds. | -| options.stimulus | string | Onscreen stimulus in HTML to be shown in the trial, if not set default text is empty. If the stimulus is not provided, message should be provided as a string. | -| options.message | string | Onscreen message to be shown in the trial, if not set default text is empty. | +| options.responseType | string | This tells jsPsych which plugin file to use to run the trial. (default: 'html_keyboard_response') | +| options.duration | number | trial duration in milliseconds. (default: 1000) | +| options.stimulus | string | Onscreen stimulus in HTML to be shown in the trial, if not set default text is empty. If the stimulus is not provided, message should be provided as a string. (default: "") | +| options.message | string | Onscreen message to be shown in the trial. (default: "") | | options.onstart | boolean | True if the message is to be display on start of the trial. False if the message needs to be in the stimulus.(default: false) | -| options.responseEndsTrial | boolean | True if the trial ends on response,false if the trial waits for the duration, by default false value. | -| options.taskCode | number | Task code to be saved into data log and for pdSpotEncode, which by default is null and is passed when config has USE_PHOTODIODE set true. | -| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. If not set, by default is 1. | -| options.buttons | Array | 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 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. | +| options.responseEndsTrial | boolean | True if the trial ends on response,false if the trial waits for the duration. (default: false) | +| options.taskCode | number | Task code to be saved into data log (default: 1) | +| options.numBlinks | number | Number of times the pulse needs to be repeated for photodiode box, when USE_PHOTODIODE is set true. (default: 1) | +| options.buttons | Array | 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 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. (default: ["OK"]) | @@ -116,9 +114,8 @@ Builds a trial with set Id message and user Id input. | config.USE_ELECTRON | boolean | USE_ELECTRON flag | | config.USE_MTURK | boolean | USE_MTURK flag | | options | Object | | -| options.duration | number | The trial duration in milliseconds. | -| options.stimulus | string | Onscreen stimulus in HTML to be shown in the trial, if not set default text is empty. If the stimulus is not provided, message should be provided as a string. | -| options.setIdMessage | string | Onscreen text for setting user id or for the input box to enter patient id. | -| options.responseEndsTrial | boolean | True if the trial ends on response,false if the trial waits for the duration, by default false value. | -| options.defaultPatientId | boolean | The patient id to show when requesting a patient ID, if not set default is empty. | +| options.duration | number | trial duration in milliseconds, when config.USE_MTURK is set to true. (default: 1000) | +| options.stimulus | string | Onscreen stimulus in HTML to be shown in the trial. If the stimulus is not provided, message should be provided as a string. (default: "") | +| options.setIdMessage | string | Onscreen text for setting user id or for the input box to enter user id. (default: "") | +| options.defaultId | string | The user id to show when requesting a user ID, when config.USE_MTURK is set to false.(default: "") |