jspsych 6.2.0 → 7.1.0

package/plugins/jspsych-categorize-animation.js

@@ -1,266 +0,0 @@
-/**
- * jspsych plugin for categorization trials with feedback and animated stimuli
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- **/
-
-
-jsPsych.plugins["categorize-animation"] = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('categorize-animation', 'stimuli', 'image');
-
-  plugin.info = {
-    name: 'categorize-animation',
-    description: '',
-    parameters: {
-      stimuli: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Stimuli',
-        default: undefined,
-        description: 'Array of paths to image files.'
-      },
-      key_answer: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Key answer',
-        default: undefined,
-        description: 'The key to indicate correct response'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Choices',
-        default: jsPsych.ALL_KEYS,
-        array: true,
-        description: 'The keys subject is allowed to press to respond to stimuli.'
-      },
-      text_answer: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Text answer',
-        default: null,
-        description: 'Text to describe correct answer.'
-      },
-      correct_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Correct text',
-        default: 'Correct.',
-        description: 'String to show when subject gives correct answer'
-      },
-      incorrect_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Incorrect text',
-        default: 'Wrong.',
-        description: 'String to show when subject gives incorrect answer.'
-      },
-      frame_time: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Frame time',
-        default: 500,
-        description: 'Duration to display each image.'
-      },
-      sequence_reps: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Sequence repetitions',
-        default: 1,
-        description: 'How many times to display entire sequence.'
-      },
-      allow_response_before_complete: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Allow response before complete',
-        default: false,
-        description: 'If true, subject can response before the animation sequence finishes'
-      },
-      feedback_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Feedback duration',
-        default: 2000,
-        description: 'How long to show feedback'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the stimulus.'
-      },
-      render_on_canvas: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Render on canvas',
-        default: true,
-        description: 'If true, the images will be drawn onto a canvas element (prevents blank screen between consecutive images in some browsers).'+
-          'If false, the image will be shown via an img element.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    var animate_frame = -1;
-    var reps = 0;
-
-    var showAnimation = true;
-
-    var responded = false;
-    var timeoutSet = false;
-    var correct;
-
-    if (trial.render_on_canvas) {
-      // first clear the display element (because the render_on_canvas method appends to display_element instead of overwriting it with .innerHTML)
-      if (display_element.hasChildNodes()) {
-        // can't loop through child list because the list will be modified by .removeChild()
-        while (display_element.firstChild) {
-          display_element.removeChild(display_element.firstChild);
-        }
-      }
-      var canvas = document.createElement("canvas");
-      canvas.id = "jspsych-categorize-animation-stimulus";
-      canvas.style.margin = 0;
-      canvas.style.padding = 0;
-      display_element.insertBefore(canvas, null);
-      var ctx = canvas.getContext("2d");
-      if (trial.prompt !== null) {
-        var prompt_div = document.createElement("div");
-        prompt_div.id = "jspsych-categorize-animation-prompt";
-        prompt_div.style.visibility = "hidden";
-        prompt_div.innerHTML = trial.prompt;
-        display_element.insertBefore(prompt_div, canvas.nextElementSibling);
-      }
-      var feedback_div = document.createElement("div");
-      display_element.insertBefore(feedback_div, display_element.nextElementSibling);
-    }
-
-    // show animation
-    var animate_interval = setInterval(function() {
-      if (!trial.render_on_canvas) {
-        display_element.innerHTML = ''; // clear everything
-      }
-      animate_frame++;
-      if (animate_frame == trial.stimuli.length) {
-        animate_frame = 0;
-        reps++;
-        // check if reps complete //
-        if (trial.sequence_reps != -1 && reps >= trial.sequence_reps) {
-          // done with animation
-          showAnimation = false;
-        }
-      }
-
-      if (showAnimation) {
-        if (trial.render_on_canvas) {
-          display_element.querySelector('#jspsych-categorize-animation-stimulus').style.visibility = 'visible';
-          var img = new Image();   
-          img.src = trial.stimuli[animate_frame];
-          canvas.height = img.naturalHeight;
-          canvas.width = img.naturalWidth;
-          ctx.drawImage(img,0,0);
-        } else {
-          display_element.innerHTML += '<img src="'+trial.stimuli[animate_frame]+'" class="jspsych-categorize-animation-stimulus"></img>';
-        }
-      }
-
-      if (!responded && trial.allow_response_before_complete) {
-        // in here if the user can respond before the animation is done
-        if (trial.prompt !== null) {
-          if (trial.render_on_canvas) {
-            prompt_div.style.visibility = "visible";
-          } else {
-            display_element.innerHTML += trial.prompt;
-          }
-        }
-        if (trial.render_on_canvas) {
-          if (!showAnimation) {
-            canvas.remove();
-          }
-        }
-      } else if (!responded) {
-        // in here if the user has to wait to respond until animation is done.
-        // if this is the case, don't show the prompt until the animation is over.
-        if (!showAnimation) {
-          if (trial.prompt !== null) {
-            if (trial.render_on_canvas) {
-              prompt_div.style.visibility = "visible";
-            } else {
-              display_element.innerHTML += trial.prompt;
-            }
-          }
-          if (trial.render_on_canvas) {
-            canvas.remove();
-          }
-        }
-      } else {
-        // user has responded if we get here.
-
-        // show feedback
-        var feedback_text = "";
-        if (correct) {
-          feedback_text = trial.correct_text.replace("%ANS%", trial.text_answer);
-        } else {
-          feedback_text = trial.incorrect_text.replace("%ANS%", trial.text_answer);
-        }
-        if (trial.render_on_canvas) {
-          if (trial.prompt !== null) {
-            prompt_div.remove();
-          }
-          feedback_div.innerHTML = feedback_text;
-        } else {
-          display_element.innerHTML += feedback_text;
-        }
-
-        // set timeout to clear feedback
-        if (!timeoutSet) {
-          timeoutSet = true;
-          jsPsych.pluginAPI.setTimeout(function() {
-            endTrial();
-          }, trial.feedback_duration);
-        }
-      }
-
-
-    }, trial.frame_time);
-
-
-    var keyboard_listener;
-    var trial_data = {};
-
-    var after_response = function(info) {
-      // ignore the response if animation is playing and subject
-      // not allowed to respond before it is complete
-      if (!trial.allow_response_before_complete && showAnimation) {
-        return false;
-      }
-
-      correct = false;
-      if (trial.key_answer == info.key) {
-        correct = true;
-      }
-
-      responded = true;
-
-      trial_data = {
-        "stimulus": JSON.stringify(trial.stimuli),
-        "rt": info.rt,
-        "correct": correct,
-        "key_press": info.key
-      };
-
-      jsPsych.pluginAPI.cancelKeyboardResponse(keyboard_listener);
-
-    }
-
-    keyboard_listener = jsPsych.pluginAPI.getKeyboardResponse({
-      callback_function: after_response,
-      valid_responses: trial.choices,
-      rt_method: 'performance',
-      persist: true,
-      allow_held_key: false
-    });
-
-    function endTrial() {
-      clearInterval(animate_interval); // stop animation!
-      display_element.innerHTML = ''; // clear everything
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-categorize-html.js

@@ -1,220 +0,0 @@
-/**
- * jspsych plugin for categorization trials with feedback
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- **/
-
-
-jsPsych.plugins['categorize-html'] = (function() {
-
-  var plugin = {};
-
-  plugin.info = {
-    name: 'categorize-html',
-    description: '',
-    parameters: {
-      stimulus: {
-        type: jsPsych.plugins.parameterType.HTML_STRING,
-        pretty_name: 'Stimulus',
-        default: undefined,
-        description: 'The HTML content to be displayed.'
-      },
-      key_answer: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Key answer',
-        default: undefined,
-        description: 'The key to indicate the correct response.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Choices',
-        default: jsPsych.ALL_KEYS,
-        array: true,
-        description: 'The keys the subject is allowed to press to respond to the stimulus.'
-      },
-      text_answer: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Text answer',
-        default: null,
-        description: 'Label that is associated with the correct answer.'
-      },
-      correct_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Correct text',
-        default: "<p class='feedback'>Correct</p>",
-        description: 'String to show when correct answer is given.'
-      },
-      incorrect_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Incorrect text',
-        default: "<p class='feedback'>Incorrect</p>",
-        description: 'String to show when incorrect answer is given.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the stimulus.'
-      },
-      force_correct_button_press: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Force correct button press',
-        default: false,
-        description: 'If set to true, then the subject must press the correct response key after feedback in order to advance to next trial.'
-      },
-      show_stim_with_feedback: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        default: true,
-        no_function: false,
-        description: ''
-      },
-      show_feedback_on_timeout: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Show feedback on timeout',
-        default: false,
-        description: 'If true, stimulus will be shown during feedback. If false, only the text feedback will be displayed during feedback.'
-      },
-      timeout_message: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Timeout message',
-        default: "<p>Please respond faster.</p>",
-        description: 'The message displayed on a timeout non-response.'
-      },
-      stimulus_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Stimulus duration',
-        default: null,
-        description: 'How long to hide stimulus.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'How long to show trial'
-      },
-      feedback_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Feedback duration',
-        default: 2000,
-        description: 'How long to show feedback.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    display_element.innerHTML = '<div id="jspsych-categorize-html-stimulus" class="jspsych-categorize-html-stimulus">'+trial.stimulus+'</div>';
-
-    // hide image after time if the timing parameter is set
-    if (trial.stimulus_duration !== null) {
-      jsPsych.pluginAPI.setTimeout(function() {
-        display_element.querySelector('#jspsych-categorize-html-stimulus').style.visibility = 'hidden';
-      }, trial.stimulus_duration);
-    }
-
-    // if prompt is set, show prompt
-    if (trial.prompt !== null) {
-      display_element.innerHTML += trial.prompt;
-    }
-
-    var trial_data = {};
-
-    // create response function
-    var after_response = function(info) {
-
-      // kill any remaining setTimeout handlers
-      jsPsych.pluginAPI.clearAllTimeouts();
-
-      // clear keyboard listener
-      jsPsych.pluginAPI.cancelAllKeyboardResponses();
-
-      var correct = false;
-      if (trial.key_answer == info.key) {
-        correct = true;
-      }
-
-      // save data
-      trial_data = {
-        "rt": info.rt,
-        "correct": correct,
-        "stimulus": trial.stimulus,
-        "key_press": info.key
-      };
-
-      display_element.innerHTML = '';
-
-      var timeout = info.rt == null;
-      doFeedback(correct, timeout);
-    }
-
-    jsPsych.pluginAPI.getKeyboardResponse({
-      callback_function: after_response,
-      valid_responses: trial.choices,
-      rt_method: 'performance',
-      persist: false,
-      allow_held_key: false
-    });
-
-    if (trial.trial_duration !== null) {
-      jsPsych.pluginAPI.setTimeout(function() {
-        after_response({
-          key: null,
-          rt: null
-        });
-      }, trial.trial_duration);
-    }
-
-    function doFeedback(correct, timeout) {
-
-      if (timeout && !trial.show_feedback_on_timeout) {
-        display_element.innerHTML += trial.timeout_message;
-      } else {
-        // show image during feedback if flag is set
-        if (trial.show_stim_with_feedback) {
-          display_element.innerHTML = '<div id="jspsych-categorize-html-stimulus" class="jspsych-categorize-html-stimulus">'+trial.stimulus+'</div>';
-        }
-
-        // substitute answer in feedback string.
-        var atext = "";
-        if (correct) {
-          atext = trial.correct_text.replace("%ANS%", trial.text_answer);
-        } else {
-          atext = trial.incorrect_text.replace("%ANS%", trial.text_answer);
-        }
-
-        // show the feedback
-        display_element.innerHTML += atext;
-      }
-      // check if force correct button press is set
-      if (trial.force_correct_button_press && correct === false && ((timeout && trial.show_feedback_on_timeout) || !timeout)) {
-
-        var after_forced_response = function(info) {
-          endTrial();
-        }
-
-        jsPsych.pluginAPI.getKeyboardResponse({
-          callback_function: after_forced_response,
-          valid_responses: [trial.key_answer],
-          rt_method: 'performance',
-          persist: false,
-          allow_held_key: false
-        });
-
-      } else {
-        jsPsych.pluginAPI.setTimeout(function() {
-          endTrial();
-        }, trial.feedback_duration);
-      }
-
-    }
-
-    function endTrial() {
-      display_element.innerHTML = '';
-      jsPsych.finishTrial(trial_data);
-    }
-
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-categorize-image.js

@@ -1,222 +0,0 @@
-/**
- * jspsych plugin for categorization trials with feedback
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- **/
-
-
-jsPsych.plugins['categorize-image'] = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('categorize-image', 'stimulus', 'image');
-
-  plugin.info = {
-    name: 'categorize-image',
-    description: '',
-    parameters: {
-      stimulus: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Stimulus',
-        default: undefined,
-        description: 'The image content to be displayed.'
-      },
-      key_answer: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Key answer',
-        default: undefined,
-        description: 'The key to indicate the correct response.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Choices',
-        default: jsPsych.ALL_KEYS,
-        array: true,
-        description: 'The keys the subject is allowed to press to respond to the stimulus.'
-      },
-      text_answer: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Text answer',
-        default: null,
-        description: 'Label that is associated with the correct answer.'
-      },
-      correct_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Correct text',
-        default: "<p class='feedback'>Correct</p>",
-        description: 'String to show when correct answer is given.'
-      },
-      incorrect_text: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Incorrect text',
-        default: "<p class='feedback'>Incorrect</p>",
-        description: 'String to show when incorrect answer is given.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the stimulus.'
-      },
-      force_correct_button_press: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Force correct button press',
-        default: false,
-        description: 'If set to true, then the subject must press the correct response key after feedback in order to advance to next trial.'
-      },
-      show_stim_with_feedback: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        default: true,
-        no_function: false,
-        description: ''
-      },
-      show_feedback_on_timeout: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Show feedback on timeout',
-        default: false,
-        description: 'If true, stimulus will be shown during feedback. If false, only the text feedback will be displayed during feedback.'
-      },
-      timeout_message: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Timeout message',
-        default: "<p>Please respond faster.</p>",
-        description: 'The message displayed on a timeout non-response.'
-      },
-      stimulus_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Stimulus duration',
-        default: null,
-        description: 'How long to hide stimulus.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'How long to show trial'
-      },
-      feedback_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Feedback duration',
-        default: 2000,
-        description: 'How long to show feedback.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    display_element.innerHTML = '<img id="jspsych-categorize-image-stimulus" class="jspsych-categorize-image-stimulus" src="'+trial.stimulus+'"></img>';
-
-    // hide image after time if the timing parameter is set
-    if (trial.stimulus_duration !== null) {
-      jsPsych.pluginAPI.setTimeout(function() {
-        display_element.querySelector('#jspsych-categorize-image-stimulus').style.visibility = 'hidden';
-      }, trial.stimulus_duration);
-    }
-
-    // if prompt is set, show prompt
-    if (trial.prompt !== null) {
-      display_element.innerHTML += trial.prompt;
-    }
-
-    var trial_data = {};
-
-    // create response function
-    var after_response = function(info) {
-
-      // kill any remaining setTimeout handlers
-      jsPsych.pluginAPI.clearAllTimeouts();
-
-      // clear keyboard listener
-      jsPsych.pluginAPI.cancelAllKeyboardResponses();
-
-      var correct = false;
-      if (trial.key_answer == info.key) {
-        correct = true;
-      }
-
-      // save data
-      trial_data = {
-        "rt": info.rt,
-        "correct": correct,
-        "stimulus": trial.stimulus,
-        "key_press": info.key
-      };
-
-      display_element.innerHTML = '';
-
-      var timeout = info.rt == null;
-      doFeedback(correct, timeout);
-    }
-
-    jsPsych.pluginAPI.getKeyboardResponse({
-      callback_function: after_response,
-      valid_responses: trial.choices,
-      rt_method: 'performance',
-      persist: false,
-      allow_held_key: false
-    });
-
-    if (trial.trial_duration !== null) {
-      jsPsych.pluginAPI.setTimeout(function() {
-        after_response({
-          key: null,
-          rt: null
-        });
-      }, trial.trial_duration);
-    }
-
-    function doFeedback(correct, timeout) {
-
-      if (timeout && !trial.show_feedback_on_timeout) {
-        display_element.innerHTML += trial.timeout_message;
-      } else {
-        // show image during feedback if flag is set
-        if (trial.show_stim_with_feedback) {
-          display_element.innerHTML = '<img id="jspsych-categorize-image-stimulus" class="jspsych-categorize-image-stimulus" src="'+trial.stimulus+'"></img>';
-        }
-
-        // substitute answer in feedback string.
-        var atext = "";
-        if (correct) {
-          atext = trial.correct_text.replace("%ANS%", trial.text_answer);
-        } else {
-          atext = trial.incorrect_text.replace("%ANS%", trial.text_answer);
-        }
-
-        // show the feedback
-        display_element.innerHTML += atext;
-      }
-      // check if force correct button press is set
-      if (trial.force_correct_button_press && correct === false && ((timeout && trial.show_feedback_on_timeout) || !timeout)) {
-
-        var after_forced_response = function(info) {
-          endTrial();
-        }
-
-        jsPsych.pluginAPI.getKeyboardResponse({
-          callback_function: after_forced_response,
-          valid_responses: [trial.key_answer],
-          rt_method: 'performance',
-          persist: false,
-          allow_held_key: false
-        });
-
-      } else {
-        jsPsych.pluginAPI.setTimeout(function() {
-          endTrial();
-        }, trial.feedback_duration);
-      }
-
-    }
-
-    function endTrial() {
-      display_element.innerHTML = '';
-      jsPsych.finishTrial(trial_data);
-    }
-
-  };
-
-  return plugin;
-})();