jspsych-attention-check
v3.0.0
Published
A jsPsych plugin for adding multiple-choice attention check questions to an experiment timeline.
Downloads
36
Maintainers
Readme
jspsych-attention-check
A jsPsych plugin for creating attention-check questions.
🚨 As of version 3.0.0, this package is only compatible with jsPsych v7.0+. For use with earlier versions, version 2.1.1 of this package is compatible with jsPsych v6.3.
Install this package (jsPsych v7.0+):
npm install jspsych-attention-check@^3.0.0
yarn add jspsych-attention-check@^3.0.0
Install this package (recommended for jsPsych v6.3):
npm install [email protected]
yarn add [email protected]
Overview
This plugin allows two styles of attention-check questions to be displayed, while supporting keyboard input schemes for the radio button display style. Additional features include an input timeout, rich feedback capabilities, and the ability to ask the participant for confirmation before submitting their response.
The plugin makes use of React and the Grommet UI library, an accessibility-first library that provides a number of useful components. Given that jsPsych experiments may not use React, the plugin will clean up after itself to ensure there are no issues mixing a React-based component with a non-React experiment.
Parameters
| Name | Type | Required? | Description | Example |
| --------------- | ---------------------------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| prompt
| string
| Yes | The prompt to be presented to the participant. | |
| responses
| {value: string, key: string \| null, correct: boolean}[]
| Yes | A list of response objects that the participant can select as their answer to the attention-check prompt. Each response object requires three parameters: value
: The displayed text of the option; key
: If the attention-check questions use keyboard input only, specify the corresponding keycode here. If not, this value should always be null
; and correct
: Boolean to mark if this response is the correct response or not. There can only be one correct response in each collection of responses. | [{value: "Response A", key: "1", correct: true}, {value: "Response B", key: "2", correct: false}]
|
| continue
| {confirm: boolean, key: string \| null}
| Yes | Optionally display a confirmation message before submitting a selected response. | {confirm: true, key: " "}
|
| feedback
| {correct: string, incorrect: string}
| Yes | Specify feedback to be presented depending on a correct or incorrect answer. | {correct: "Correct feedback.", incorrect: "Incorrect feedback."}
|
| style
| radio
or default
| No (default: default
) | Change the display style of the responses. radio
displays the responses as a set of radio buttons, and is the only display format supporting keyboard input configuration. default
displays the options as a drop-down list. | |
| input_timeout
| number
| No (default: 0
) | Specify an input timeout that must expire before a participant is permitted to interact with the attention-check question. | 1000
|
Data
Three data points are collected: attentionRT
, attentionSelected
, attentionCorrect
:
attentionRT
(number): a float representing the time taken by the participant to select an option once input is permitted. Measured in milliseconds.attentionSelected
(string): a string containing the value of the response selected by the participant.attentionCorrect
(boolean): a boolean representing the correctness of the participant's response.
Example Usage
You can add an attention-check to your jsPsych v7.0+ timeline like any other timeline node. The following example displays responses as a radio button group, and uses keyboard input only.
timeline.push({
type: jsPsychAttentionCheck,
prompt: "Why is 6 afraid of 7?",
responses: [
{ value: "Because 7 is even and 6 is not.", key: "1", correct: false },
{ value: "Because 7 is a better number.", key: "2", correct: false },
{ value: "Because 7 8 9!", key: "3", correct: true },
],
style: "radio",
continue: {
confirm: true,
key: " ",
},
feedback: {
correct: "Correct!",
incorrect: "Incorrect.",
},
});
The following example displays responses as a drop-down, does not use keyboard input, and does not require confirmation.
timeline.push({
type: jsPsychAttentionCheck,
prompt: "Why is 6 afraid of 7?",
responses: [
{ value: "Because 7 is even and 6 is not.", key: null, correct: false },
{ value: "Because 7 is a better number.", key: null, correct: false },
{ value: "Because 7 8 9!", key: null, correct: true },
],
style: "default",
continue: {
confirm: false,
key: null,
},
feedback: {
correct: "Correct!",
incorrect: "Incorrect.",
},
});