jspsych 6.3.0 → 7.1.1

package/license.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014-2018 Joshua R. de Leeuw
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/mkdocs.yml

@@ -1,118 +0,0 @@
-site_name: jsPsych
-theme:
-  name: 'material'
-  language: 'en'
-  palette:
-    primary: 'green'
-    accent: 'orange'
-  logo: 'img/jspsych-logo-no-text-mono.svg'
-  favicon: 'img/jspsych-favicon.png'
-extra:
-  social:
-    - icon: 'fontawesome/brands/github'
-      link: 'https://github.com/jspsych'
-    - icon: 'fontawesome/brands/twitter'
-      link: 'https://twitter.com/joshdeleeuw'
-copyright: 'Copyright © 2012-2021 Josh de Leeuw'
-google_analytics:
-  - 'UA-50563838-1'
-  - 'auto'
-markdown_extensions:
-  - admonition
-  - codehilite:
-      guess_lang: false
-  - toc:
-      permalink: true
-  - pymdownx.superfences
-  - pymdownx.details
-repo_url: 'https://github.com/jspsych/jsPsych'
-repo_name: 'jspsych/jspsych'
-docs_dir: docs
-nav:
-- Introduction: 'index.md'
-- Tutorials:
-  - 'The Basics: Hello World': 'tutorials/hello-world.md'
-  - 'Demo Experiment: Simple Reaction Time Task': 'tutorials/rt-task.md'
-  - 'Video Tutorials': 'tutorials/video-tutorials.md'
-- Overview:
-  - 'Creating an Experiment: The Timeline': 'overview/timeline.md'
-  - 'Plugins': 'overview/plugins.md'
-  - 'Dynamic Parameters': 'overview/dynamic-parameters.md'
-  - 'Controlling Visual Appearance': 'overview/style.md'
-  - 'Data Storage, Aggregation, and Manipulation': 'overview/data.md'
-  - 'Running Experiments': 'overview/running-experiments.md'
-  - 'Experiment Settings': 'overview/experiment-options.md'
-  - 'Event-related Callback Functions': 'overview/callbacks.md'
-  - 'Record Browser Interactions': 'overview/record-browser-interactions.md'
-  - 'Media Preloading': 'overview/media-preloading.md'
-  - 'Fullscreen Experiments': 'overview/fullscreen.md'
-  - 'Eye Tracking': 'overview/eye-tracking.md'
-  - 'Exclude Participants Based on Browser Features': 'overview/exclude-browser.md'
-  - 'Automatic Progress Bar': 'overview/progress-bar.md'
-  - 'Integrating with Prolific': 'overview/prolific.md'
-  - 'Integrating with Mechanical Turk': 'overview/mturk.md'
-  - 'Browser and Device Support': 'overview/browser-device-support.md'
-- Reference:
-  - 'jsPsych': 'core_library/jspsych-core.md'
-  - 'jsPsych.data': 'core_library/jspsych-data.md'
-  - 'jsPsych.randomization': 'core_library/jspsych-randomization.md'
-  - 'jsPsych.turk': 'core_library/jspsych-turk.md'
-  - 'jsPsych.pluginAPI': 'core_library/jspsych-pluginAPI.md'
-- Plugins:
-  - 'List of Plugins': 'plugins/list-of-plugins.md'
-  - 'jspsych-animation': 'plugins/jspsych-animation.md'
-  - 'jspsych-audio-button-response': 'plugins/jspsych-audio-button-response.md'
-  - 'jspsych-audio-keyboard-response': 'plugins/jspsych-audio-keyboard-response.md'
-  - 'jspsych-audio-slider-response': 'plugins/jspsych-audio-slider-response.md'
-  - 'jspsych-canvas-button-response': 'plugins/jspsych-canvas-button-response.md'
-  - 'jspsych-canvas-keyboard-response': 'plugins/jspsych-canvas-keyboard-response.md'
-  - 'jspsych-canvas-slider-response': 'plugins/jspsych-canvas-slider-response.md'
-  - 'jspsych-call-function': 'plugins/jspsych-call-function.md'
-  - 'jspsych-categorize-animation': 'plugins/jspsych-categorize-animation.md'
-  - 'jspsych-categorize-html': 'plugins/jspsych-categorize-html.md'
-  - 'jspsych-categorize-image': 'plugins/jspsych-categorize-image.md'
-  - 'jspsych-cloze' : 'plugins/jspsych-cloze.md'
-  - 'jspsych-external-html': 'plugins/jspsych-external-html.md'
-  - 'jspsych-free-sort': 'plugins/jspsych-free-sort.md'
-  - 'jspsych-fullscreen': 'plugins/jspsych-fullscreen.md'
-  - 'jspsych-html-button-response': 'plugins/jspsych-html-button-response.md'
-  - 'jspsych-html-keyboard-response': 'plugins/jspsych-html-keyboard-response.md'
-  - 'jspsych-html-slider-response': 'plugins/jspsych-html-slider-response.md'
-  - 'jspsych-iat-html': 'plugins/jspsych-iat-html.md'
-  - 'jspsych-iat-image': 'plugins/jspsych-iat-image.md'
-  - 'jspsych-image-button-response': 'plugins/jspsych-image-button-response.md'
-  - 'jspsych-image-keyboard-response': 'plugins/jspsych-image-keyboard-response.md'
-  - 'jspsych-image-slider-response': 'plugins/jspsych-image-slider-response.md'
-  - 'jspsych-instructions': 'plugins/jspsych-instructions.md'
-  - 'jspsych-maxdiff': 'plugins/jspsych-maxdiff.md'
-  - 'jspsych-preload': 'plugins/jspsych-preload.md'
-  - 'jspsych-rdk': 'plugins/jspsych-rdk.md'
-  - 'jspsych-reconstruction': 'plugins/jspsych-reconstruction.md'
-  - 'jspsych-resize': 'plugins/jspsych-resize.md'
-  - 'jspsych-same-different-html': 'plugins/jspsych-same-different-html.md'
-  - 'jspsych-same-different-image': 'plugins/jspsych-same-different-image.md'
-  - 'jspsych-serial-reaction-time': 'plugins/jspsych-serial-reaction-time.md'
-  - 'jspsych-serial-reaction-time-mouse': 'plugins/jspsych-serial-reaction-time-mouse.md'
-  - 'jspsych-survey-html-form' : 'plugins/jspsych-survey-html-form.md'
-  - 'jspsych-survey-likert': 'plugins/jspsych-survey-likert.md'
-  - 'jspsych-survey-multi-choice': 'plugins/jspsych-survey-multi-choice.md'
-  - 'jspsych-survey-multi-select': 'plugins/jspsych-survey-multi-select.md'
-  - 'jspsych-survey-text': 'plugins/jspsych-survey-text.md'
-  - 'jspsych-video-button-response': 'plugins/jspsych-video-button-response.md'
-  - 'jspsych-video-keyboard-response': 'plugins/jspsych-video-keyboard-response.md'
-  - 'jspsych-video-slider-response': 'plugins/jspsych-video-slider-response.md'
-  - 'jspsych-virtual-chinrest' : 'plugins/jspsych-virtual-chinrest.md'
-  - 'jspsych-visual-search-circle': 'plugins/jspsych-visual-search-circle.md'
-  - 'jspsych-vsl-animate-occlusion': 'plugins/jspsych-vsl-animate-occlusion.md'
-  - 'jspsych-vsl-grid-scene': 'plugins/jspsych-vsl-grid-scene.md'
-  - 'jspsych-webgazer-calibrate': 'plugins/jspsych-webgazer-calibrate.md'
-  - 'jspsych-webgazer-init-camera': 'plugins/jspsych-webgazer-init-camera.md'
-  - 'jspsych-webgazer-validate': 'plugins/jspsych-webgazer-validate.md'
-- Extensions:
-  - 'Extensions': 'extensions/extensions.md'
-  - 'jspsych-ext-webgazer.js': 'extensions/jspsych-ext-webgazer.md'
-- About:
-  - 'About jsPsych': 'about/about.md'
-  - 'Getting Help': 'about/support.md'
-  - 'Contributing to jsPsych': 'about/contributing.md'
-  - 'License': 'about/license.md'

package/plugins/jspsych-animation.js

@@ -1,189 +0,0 @@
-/**
- * jsPsych plugin for showing animations and recording keyboard responses
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- */
-
-jsPsych.plugins.animation = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('animation', 'stimuli', 'image');
-
-  plugin.info = {
-    name: 'animation',
-    description: '',
-    parameters: {
-      stimuli: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Stimuli',
-        default: undefined,
-        array: true,
-        description: 'The images to be displayed.'
-      },
-      frame_time: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Frame time',
-        default: 250,
-        description: 'Duration to display each image.'
-      },
-      frame_isi: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Frame gap',
-        default: 0,
-        description: 'Length of gap to be shown between each image.'
-      },
-      sequence_reps: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Sequence repetitions',
-        default: 1,
-        description: 'Number of times to show entire sequence.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEY,
-        pretty_name: 'Choices',
-        default: jsPsych.ALL_KEYS,
-        array: true,
-        description: 'Keys subject uses to respond to stimuli.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below 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 interval_time = trial.frame_time + trial.frame_isi;
-    var animate_frame = -1;
-    var reps = 0;
-    var startTime = performance.now();
-    var animation_sequence = [];
-    var responses = [];
-    var current_stim = "";
-
-    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-animation-image";
-      canvas.style.margin = 0;
-      canvas.style.padding = 0;
-      display_element.insertBefore(canvas, null);
-      var ctx = canvas.getContext("2d");
-    }
-
-    var animate_interval = setInterval(function() {
-      var showImage = true;
-      if (!trial.render_on_canvas) {
-        display_element.innerHTML = ''; // clear everything
-      } 
-      animate_frame++;
-      if (animate_frame == trial.stimuli.length) {
-        animate_frame = 0;
-        reps++;
-        if (reps >= trial.sequence_reps) {
-          endTrial();
-          clearInterval(animate_interval);
-          showImage = false;
-        }
-      }
-      if (showImage) {
-        show_next_frame();
-      }
-    }, interval_time);
-
-    function show_next_frame() {
-      if (trial.render_on_canvas) {
-        display_element.querySelector('#jspsych-animation-image').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);
-        if (trial.prompt !== null & animate_frame == 0 & reps == 0) {
-          display_element.insertAdjacentHTML('beforeend', trial.prompt);
-        }
-      } else {
-        // show image
-        display_element.innerHTML = '<img src="'+trial.stimuli[animate_frame]+'" id="jspsych-animation-image"></img>';
-        if (trial.prompt !== null) {
-          display_element.innerHTML += trial.prompt;
-        }
-      }
-      current_stim = trial.stimuli[animate_frame];
-
-      // record when image was shown
-      animation_sequence.push({
-        "stimulus": trial.stimuli[animate_frame],
-        "time": performance.now() - startTime
-      });
-
-      if (trial.frame_isi > 0) {
-        jsPsych.pluginAPI.setTimeout(function() {
-          display_element.querySelector('#jspsych-animation-image').style.visibility = 'hidden';
-          current_stim = 'blank';
-          // record when blank image was shown
-          animation_sequence.push({
-            "stimulus": 'blank',
-            "time": performance.now() - startTime
-          });
-        }, trial.frame_time);
-      }
-    }
-
-    var after_response = function(info) {
-
-      responses.push({
-        key_press: info.key,
-        rt: info.rt,
-        stimulus: current_stim
-      });
-
-      // after a valid response, the stimulus will have the CSS class 'responded'
-      // which can be used to provide visual feedback that a response was recorded
-      display_element.querySelector('#jspsych-animation-image').className += ' responded';
-    }
-
-    // hold the jspsych response listener object in memory
-    // so that we can turn off the response collection when
-    // the trial ends
-    var response_listener = jsPsych.pluginAPI.getKeyboardResponse({
-      callback_function: after_response,
-      valid_responses: trial.choices,
-      rt_method: 'performance',
-      persist: true,
-      allow_held_key: false
-    });
-
-    function endTrial() {
-
-      jsPsych.pluginAPI.cancelKeyboardResponse(response_listener);
-
-      var trial_data = {
-        animation_sequence: animation_sequence,
-        response: responses
-      };
-
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-audio-button-response.js

@@ -1,269 +0,0 @@
-/**
- * jspsych-audio-button-response
- * Kristin Diep
- *
- * plugin for playing an audio file and getting a keyboard response
- *
- * documentation: docs.jspsych.org
- *
- **/
-
-jsPsych.plugins["audio-button-response"] = (function () {
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('audio-button-response', 'stimulus', 'audio');
-
-  plugin.info = {
-    name: 'audio-button-response',
-    description: '',
-    parameters: {
-      stimulus: {
-        type: jsPsych.plugins.parameterType.AUDIO,
-        pretty_name: 'Stimulus',
-        default: undefined,
-        description: 'The audio to be played.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Choices',
-        default: undefined,
-        array: true,
-        description: 'The button labels.'
-      },
-      button_html: {
-        type: jsPsych.plugins.parameterType.HTML_STRING,
-        pretty_name: 'Button HTML',
-        default: '<button class="jspsych-btn">%choice%</button>',
-        array: true,
-        description: 'Custom button. Can make your own style.'
-      },
-      prompt: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Prompt',
-        default: null,
-        description: 'Any content here will be displayed below the stimulus.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'The maximum duration to wait for a response.'
-      },
-      margin_vertical: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Margin vertical',
-        default: '0px',
-        description: 'Vertical margin of button.'
-      },
-      margin_horizontal: {
-        type: jsPsych.plugins.parameterType.STRING,
-        pretty_name: 'Margin horizontal',
-        default: '8px',
-        description: 'Horizontal margin of button.'
-      },
-      response_ends_trial: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response ends trial',
-        default: true,
-        description: 'If true, the trial will end when user makes a response.'
-      },
-      trial_ends_after_audio: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Trial ends after audio',
-        default: false,
-        description: 'If true, then the trial will end as soon as the audio file finishes playing.'
-      },
-      response_allowed_while_playing: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Response allowed while playing',
-        default: true,
-        description: 'If true, then responses are allowed while the audio is playing. ' +
-          'If false, then the audio must finish playing before a response is accepted.'
-      }
-    }
-  }
-
-  plugin.trial = function (display_element, trial) {
-
-    // setup stimulus
-    var context = jsPsych.pluginAPI.audioContext();
-    var audio;
-
-    // store response
-    var response = {
-      rt: null,
-      button: null
-    };
-
-    // record webaudio context start time
-    var startTime;
-
-    // load audio file
-    jsPsych.pluginAPI.getAudioBuffer(trial.stimulus)
-      .then(function (buffer) {
-        if (context !== null) {
-          audio = context.createBufferSource();
-          audio.buffer = buffer;
-          audio.connect(context.destination);
-        } else {
-          audio = buffer;
-          audio.currentTime = 0;
-        }
-        setupTrial();
-      })
-      .catch(function (err) {
-        console.error(`Failed to load audio file "${trial.stimulus}". Try checking the file path. We recommend using the preload plugin to load audio files.`)
-        console.error(err)
-      });
-
-    function setupTrial() {
-      // set up end event if trial needs it
-      if (trial.trial_ends_after_audio) {
-        audio.addEventListener('ended', end_trial);
-      }
-
-      // enable buttons after audio ends if necessary
-      if ((!trial.response_allowed_while_playing) & (!trial.trial_ends_after_audio)) {
-        audio.addEventListener('ended', enable_buttons);
-      }
-
-      //display buttons
-      var buttons = [];
-      if (Array.isArray(trial.button_html)) {
-        if (trial.button_html.length == trial.choices.length) {
-          buttons = trial.button_html;
-        } else {
-          console.error('Error in audio-button-response plugin. The length of the button_html array does not equal the length of the choices array');
-        }
-      } else {
-        for (var i = 0; i < trial.choices.length; i++) {
-          buttons.push(trial.button_html);
-        }
-      }
-
-      var html = '<div id="jspsych-audio-button-response-btngroup">';
-      for (var i = 0; i < trial.choices.length; i++) {
-        var str = buttons[i].replace(/%choice%/g, trial.choices[i]);
-        html += '<div class="jspsych-audio-button-response-button" style="cursor: pointer; display: inline-block; margin:' + trial.margin_vertical + ' ' + trial.margin_horizontal + '" id="jspsych-audio-button-response-button-' + i + '" data-choice="' + i + '">' + str + '</div>';
-      }
-      html += '</div>';
-
-      //show prompt if there is one
-      if (trial.prompt !== null) {
-        html += trial.prompt;
-      }
-
-      display_element.innerHTML = html;
-
-      if (trial.response_allowed_while_playing) {
-        enable_buttons();
-      } else {
-        disable_buttons();
-      }
-
-      // start time
-      startTime = performance.now();
-
-      // start audio
-      if (context !== null) {
-        startTime = context.currentTime;
-        audio.start(startTime);
-      } else {
-        audio.play();
-      }
-
-      // end trial if time limit is set
-      if (trial.trial_duration !== null) {
-        jsPsych.pluginAPI.setTimeout(function () {
-          end_trial();
-        }, trial.trial_duration);
-      }
-    }
-
-
-
-    // function to handle responses by the subject
-    function after_response(choice) {
-
-      // measure rt
-      var endTime = performance.now();
-      var rt = endTime - startTime;
-      if (context !== null) {
-        endTime = context.currentTime;
-        rt = Math.round((endTime - startTime) * 1000);
-      }
-      response.button = parseInt(choice);
-      response.rt = rt;
-
-      // disable all the buttons after a response
-      disable_buttons();
-
-      if (trial.response_ends_trial) {
-        end_trial();
-      }
-    }
-
-    // function to end trial when it is time
-    function end_trial() {
-
-      // kill any remaining setTimeout handlers
-      jsPsych.pluginAPI.clearAllTimeouts();
-
-      // stop the audio file if it is playing
-      // remove end event listeners if they exist
-      if (context !== null) {
-        audio.stop();
-      } else {
-        audio.pause();
-      }
-
-      audio.removeEventListener('ended', end_trial);
-      audio.removeEventListener('ended', enable_buttons);
-
-      // gather the data to store for the trial
-      var trial_data = {
-        rt: response.rt,
-        stimulus: trial.stimulus,
-        response: response.button
-      };
-
-      // clear the display
-      display_element.innerHTML = '';
-
-      // move on to the next trial
-      jsPsych.finishTrial(trial_data);
-    }
-
-    function button_response(e) {
-      var choice = e.currentTarget.getAttribute('data-choice'); // don't use dataset for jsdom compatibility
-      after_response(choice);
-    }
-
-    function disable_buttons() {
-      var btns = document.querySelectorAll('.jspsych-audio-button-response-button');
-      for (var i = 0; i < btns.length; i++) {
-        var btn_el = btns[i].querySelector('button');
-        if (btn_el) {
-          btn_el.disabled = true;
-        }
-        btns[i].removeEventListener('click', button_response);
-      }
-    }
-
-    function enable_buttons() {
-      var btns = document.querySelectorAll('.jspsych-audio-button-response-button');
-      for (var i = 0; i < btns.length; i++) {
-        var btn_el = btns[i].querySelector('button');
-        if (btn_el) {
-          btn_el.disabled = false;
-        }
-        btns[i].addEventListener('click', button_response);
-      }
-    }
-
-
-
-  };
-
-  return plugin;
-})();