jspsych 6.2.0 → 7.1.0

package/plugins/jspsych-visual-search-circle.js

@@ -1,259 +0,0 @@
-/**
- *
- * jspsych-visual-search-circle
- * Josh de Leeuw
- *
- * display a set of objects, with or without a target, equidistant from fixation
- * subject responds to whether or not the target is present
- *
- * based on code written for psychtoolbox by Ben Motz
- *
- * documentation: docs.jspsych.org
- *
- **/
-
-jsPsych.plugins["visual-search-circle"] = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('visual-search-circle', 'target', 'image');
-  jsPsych.pluginAPI.registerPreload('visual-search-circle', 'foil', 'image');
-  jsPsych.pluginAPI.registerPreload('visual-search-circle', 'fixation_image', 'image');
-
-  plugin.info = {
-    name: 'visual-search-circle',
-    description: '',
-    parameters: {
-      target: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Target',
-        default: undefined,
-        description: 'The image to be displayed.'
-      },
-      foil: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Foil',
-        default: undefined,
-        description: 'Path to image file that is the foil/distractor.'
-      },
-      fixation_image: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Fixation image',
-        default: undefined,
-        description: 'Path to image file that is a fixation target.'
-      },
-      set_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Set size',
-        default: undefined,
-        description: 'How many items should be displayed?'
-      },
-      target_present: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Target present',
-        default: true,
-        description: 'Is the target present?'
-      },
-      target_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Target size',
-        array: true,
-        default: [50, 50],
-        description: 'Two element array indicating the height and width of the search array element images.'
-      },
-      fixation_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Fixation size',
-        array: true,
-        default: [16, 16],
-        description: 'Two element array indicating the height and width of the fixation image.'
-      },
-      circle_diameter: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Circle diameter',
-        default: 250,
-        description: 'The diameter of the search array circle in pixels.'
-      },
-      target_present_key: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Target present key',
-        default: 'j',
-        description: 'The key to press if the target is present in the search array.'
-      },
-      target_absent_key: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Target absent key',
-        default: 'f',
-        description: 'The key to press if the target is not present in the search array.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: null,
-        description: 'The maximum duration to wait for a response.'
-      },
-      fixation_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Fixation duration',
-        default: 1000,
-        description: 'How long to show the fixation image for before the search array (in milliseconds).'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    // circle params
-    var diam = trial.circle_diameter; // pixels
-    var radi = diam / 2;
-    var paper_size = diam + trial.target_size[0];
-
-    // stimuli width, height
-    var stimh = trial.target_size[0];
-    var stimw = trial.target_size[1];
-    var hstimh = stimh / 2;
-    var hstimw = stimw / 2;
-
-    // fixation location
-    var fix_loc = [Math.floor(paper_size / 2 - trial.fixation_size[0] / 2), Math.floor(paper_size / 2 - trial.fixation_size[1] / 2)];
-
-    // possible stimulus locations on the circle
-    var display_locs = [];
-    var possible_display_locs = trial.set_size;
-    var random_offset = Math.floor(Math.random() * 360);
-    for (var i = 0; i < possible_display_locs; i++) {
-      display_locs.push([
-        Math.floor(paper_size / 2 + (cosd(random_offset + (i * (360 / possible_display_locs))) * radi) - hstimw),
-        Math.floor(paper_size / 2 - (sind(random_offset + (i * (360 / possible_display_locs))) * radi) - hstimh)
-      ]);
-    }
-
-    // get target to draw on
-    display_element.innerHTML += '<div id="jspsych-visual-search-circle-container" style="position: relative; width:' + paper_size + 'px; height:' + paper_size + 'px"></div>';
-    var paper = display_element.querySelector("#jspsych-visual-search-circle-container");
-
-    // check distractors - array?
-    if(!Array.isArray(trial.foil)){
-      fa = [];
-      for(var i=0; i<trial.set_size; i++){
-        fa.push(trial.foil);
-      }
-      trial.foil = fa;
-    }
-
-    show_fixation();
-
-    function show_fixation() {
-      // show fixation
-      //var fixation = paper.image(trial.fixation_image, fix_loc[0], fix_loc[1], trial.fixation_size[0], trial.fixation_size[1]);
-      paper.innerHTML += "<img src='"+trial.fixation_image+"' style='position: absolute; top:"+fix_loc[0]+"px; left:"+fix_loc[1]+"px; width:"+trial.fixation_size[0]+"px; height:"+trial.fixation_size[1]+"px;'></img>";
-
-      // wait
-      jsPsych.pluginAPI.setTimeout(function() {
-        // after wait is over
-        show_search_array();
-      }, trial.fixation_duration);
-    }
-
-    function show_search_array() {
-
-      var search_array_images = [];
-
-      var to_present = [];
-      if(trial.target_present){
-        to_present.push(trial.target);
-      }
-      to_present = to_present.concat(trial.foil);
-
-      for (var i = 0; i < display_locs.length; i++) {
-
-        paper.innerHTML += "<img src='"+to_present[i]+"' style='position: absolute; top:"+display_locs[i][0]+"px; left:"+display_locs[i][1]+"px; width:"+trial.target_size[0]+"px; height:"+trial.target_size[1]+"px;'></img>";
-
-      }
-
-      var trial_over = false;
-
-      var after_response = function(info) {
-
-        trial_over = true;
-
-        var correct = false;
-
-        if (jsPsych.pluginAPI.compareKeys(info.key,trial.target_present_key) && trial.target_present ||
-            jsPsych.pluginAPI.compareKeys(info.key,trial.target_absent_key) && !trial.target_present) {
-          correct = true;
-        }
-
-        clear_display();
-
-        end_trial(info.rt, correct, info.key);
-
-      }
-
-      var valid_keys = [trial.target_present_key, trial.target_absent_key];
-
-      key_listener = jsPsych.pluginAPI.getKeyboardResponse({
-        callback_function: after_response,
-        valid_responses: valid_keys,
-        rt_method: 'performance',
-        persist: false,
-        allow_held_key: false
-      });
-
-      if (trial.trial_duration !== null) {
-
-        jsPsych.pluginAPI.setTimeout(function() {
-
-          if (!trial_over) {
-
-            jsPsych.pluginAPI.cancelKeyboardResponse(key_listener);
-
-            trial_over = true;
-
-            var rt = null;
-            var correct = 0;
-            var key_press = null;
-
-            clear_display();
-
-            end_trial(rt, correct, key_press);
-          }
-        }, trial.trial_duration);
-
-      }
-
-      function clear_display() {
-        display_element.innerHTML = '';
-      }
-    }
-
-
-    function end_trial(rt, correct, key_press) {
-
-      // data saving
-      var trial_data = {
-        correct: correct,
-        rt: rt,
-        key_press: key_press,
-        locations: JSON.stringify(display_locs),
-        target_present: trial.target_present,
-        set_size: trial.set_size
-      };
-
-      // go to next trial
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  // helper function for determining stimulus locations
-
-  function cosd(num) {
-    return Math.cos(num / 180 * Math.PI);
-  }
-
-  function sind(num) {
-    return Math.sin(num / 180 * Math.PI);
-  }
-
-  return plugin;
-})();

package/plugins/jspsych-vsl-animate-occlusion.js

@@ -1,196 +0,0 @@
-/**
- * jsPsych plugin for showing animations that mimic the experiment described in
- *
- * Fiser, J., & Aslin, R. N. (2002). Statistical learning of higher-order
- * temporal structure from visual shape sequences. Journal of Experimental
- * Psychology: Learning, Memory, and Cognition, 28(3), 458.
- *
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- *
- */
-
-jsPsych.plugins['vsl-animate-occlusion'] = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('vsl-animate-occlusion', 'stimuli', 'image');
-
-  plugin.info = {
-    name: 'vsl-animate-occlusion',
-    description: '',
-    parameters: {
-      stimuli: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Stimuli',
-        default: undefined,
-        array: true,
-        description: 'A stimulus is a path to an image file.'
-      },
-      choices: {
-        type: jsPsych.plugins.parameterType.KEYCODE,
-        pretty_name: 'Choices',
-        array: true,
-        default: jsPsych.ALL_KEYS,
-        description: 'This array contains the keys that the subject is allowed to press in order to respond to the stimulus. '
-      },
-      canvas_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Canvas size',
-        array: true,
-        default: [400,400],
-        description: 'Array specifying the width and height of the area that the animation will display in.'
-      },
-      image_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Image size',
-        array: true,
-        default: [100,100],
-        description: 'Array specifying the width and height of the images to show.'
-      },
-      initial_direction: {
-        type: jsPsych.plugins.parameterType.SELECT,
-        pretty_name: 'Initial direction',
-        choices: ['left','right'],
-        default: 'left',
-        description: 'Which direction the stimulus should move first.'
-      },
-      occlude_center: {
-        type: jsPsych.plugins.parameterType.BOOL,
-        pretty_name: 'Occlude center',
-        default: true,
-        description: 'If true, display a rectangle in the center of the screen that is just wide enough to occlude the image completely as it passes behind.'
-      },
-      cycle_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Cycle duration',
-        default: 1000,
-        description: 'How long it takes for a stimulus in the sequence to make a complete cycle.'
-      },
-      pre_movement_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Pre movement duration',
-        default: 500,
-        description: 'How long to wait before the stimuli starts moving from behind the center rectangle.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-    
-    // variable to keep track of timing info and responses
-    var start_time = 0;
-    var responses = [];
-
-    var directions = [
-      [{
-        params: {
-          x: trial.canvas_size[0] - trial.image_size[0]
-        },
-        ms: trial.cycle_duration / 2
-      }, {
-        params: {
-          x: trial.canvas_size[0] / 2 - trial.image_size[0] / 2
-        },
-        ms: trial.cycle_duration / 2
-      }],
-      [{
-        params: {
-          x: 0
-        },
-        ms: trial.cycle_duration / 2
-      }, {
-        params: {
-          x: trial.canvas_size[0] / 2 - trial.image_size[0] / 2
-        },
-        ms: trial.cycle_duration / 2
-      }]
-    ];
-
-    var which_image = 0;
-    var next_direction = (trial.initial_direction == "right") ? 0 : 1;
-
-    function next_step() {
-      if (trial.stimuli.length == which_image) {
-        endTrial();
-      } else {
-
-        var d = directions[next_direction];
-        next_direction === 0 ? next_direction = 1 : next_direction = 0;
-        var i = trial.stimuli[which_image];
-        which_image++;
-
-        c.animate(d[0].params, d[0].ms, mina.linear, function() {
-          c.animate(d[1].params, d[1].ms, mina.linear, function() {
-            next_step();
-          });
-        });
-
-        c.attr({
-          href: i
-        });
-
-        // start timer for this trial
-        start_time = performance.now();
-      }
-    }
-
-    display_element.innerHTML = "<svg id='jspsych-vsl-animate-occlusion-canvas' width=" + trial.canvas_size[0] + " height=" + trial.canvas_size[1] + "></svg>";
-
-    var paper = Snap("#jspsych-vsl-animate-occlusion-canvas");
-
-    var c = paper.image(trial.stimuli[which_image], trial.canvas_size[0] / 2 - trial.image_size[0] / 2, trial.canvas_size[1] / 2 - trial.image_size[1] / 2, trial.image_size[0], trial.image_size[1]).attr({
-      "id": 'jspsych-vsl-animate-occlusion-moving-image'
-    });
-
-    display_element.querySelector('#jspsych-vsl-animate-occlusion-moving-image').removeAttribute('preserveAspectRatio');
-
-    if (trial.occlude_center) {
-      paper.rect((trial.canvas_size[0] / 2) - (trial.image_size[0] / 2), 0, trial.image_size[0], trial.canvas_size[1]).attr({
-        fill: "#000"
-      });
-    }
-
-    // add key listener
-    var after_response = function(info) {
-      responses.push({
-        key: info.key,
-        stimulus: which_image - 1,
-        rt: info.rt
-      });
-    }
-
-    key_listener = jsPsych.pluginAPI.getKeyboardResponse({
-      callback_function: after_response,
-      valid_responses: trial.choices,
-      rt_method: 'performance',
-      persist: true,
-      allow_held_key: false
-    });
-
-    if (trial.pre_movement_duration > 0) {
-      jsPsych.pluginAPI.setTimeout(function() {
-        next_step();
-      }, trial.pre_movement_duration);
-    } else {
-      next_step();
-    }
-
-    function endTrial() {
-
-      display_element.innerHTML = '';
-
-      jsPsych.pluginAPI.cancelKeyboardResponse(key_listener);
-
-      var trial_data = {
-        "stimuli": JSON.stringify(trial.stimuli),
-        "responses": JSON.stringify(responses)
-      };
-
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  return plugin;
-})();

package/plugins/jspsych-vsl-grid-scene.js

@@ -1,103 +0,0 @@
-/**
- * jsPsych plugin for showing scenes that mimic the experiments described in
- *
- * Fiser, J., & Aslin, R. N. (2001). Unsupervised statistical learning of
- * higher-order spatial structures from visual scenes. Psychological science,
- * 12(6), 499-504.
- *
- * Josh de Leeuw
- *
- * documentation: docs.jspsych.org
- *
- */
-
-jsPsych.plugins['vsl-grid-scene'] = (function() {
-
-  var plugin = {};
-
-  jsPsych.pluginAPI.registerPreload('vsl-grid-scene', 'stimuli', 'image');
-
-  plugin.info = {
-    name: 'vsl-grid-scene',
-    description: '',
-    parameters: {
-      stimuli: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        pretty_name: 'Stimuli',
-        array: true,
-        default: undefined,
-        description: 'An array that defines a grid.'
-      },
-      image_size: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Image size',
-        array: true,
-        default: [100,100],
-        description: 'Array specifying the width and height of the images to show.'
-      },
-      trial_duration: {
-        type: jsPsych.plugins.parameterType.INT,
-        pretty_name: 'Trial duration',
-        default: 2000,
-        description: 'How long to show the stimulus for in milliseconds.'
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    display_element.innerHTML = plugin.generate_stimulus(trial.stimuli, trial.image_size);
-
-    jsPsych.pluginAPI.setTimeout(function() {
-      endTrial();
-    }, trial.trial_duration);
-
-    function endTrial() {
-
-      display_element.innerHTML = '';
-
-      var trial_data = {
-        "stimulus": JSON.stringify(trial.stimuli)
-      };
-
-      jsPsych.finishTrial(trial_data);
-    }
-  };
-
-  plugin.generate_stimulus = function(pattern, image_size) {
-    var nrows = pattern.length;
-    var ncols = pattern[0].length;
-
-    // create blank element to hold code that we generate
-    var html = '<div id="jspsych-vsl-grid-scene-dummy" css="display: none;">';
-
-    // create table
-    html += '<table id="jspsych-vsl-grid-scene table" '+
-      'style="border-collapse: collapse; margin-left: auto; margin-right: auto;">';
-
-    for (var row = 0; row < nrows; row++) {
-      html += '<tr id="jspsych-vsl-grid-scene-table-row-'+row+'" css="height: '+image_size[1]+'px;">';
-
-      for (var col = 0; col < ncols; col++) {
-        html += '<td id="jspsych-vsl-grid-scene-table-' + row + '-' + col +'" '+
-          'style="padding: '+ (image_size[1] / 10) + 'px ' + (image_size[0] / 10) + 'px; border: 1px solid #555;">'+
-          '<div id="jspsych-vsl-grid-scene-table-cell-' + row + '-' + col + '" style="width: '+image_size[0]+'px; height: '+image_size[1]+'px;">';
-        if (pattern[row][col] !== 0) {
-          html += '<img '+
-            'src="'+pattern[row][col]+'" style="width: '+image_size[0]+'px; height: '+image_size[1]+'"></img>';
-        }
-        html += '</div>';
-        html += '</td>';
-      }
-      html += '</tr>';
-    }
-
-    html += '</table>';
-    html += '</div>';
-
-    return html;
-
-  };
-
-  return plugin;
-})();

package/plugins/template/jspsych-plugin-template.js

@@ -1,35 +0,0 @@
-/*
- * Example plugin template
- */
-
-jsPsych.plugins["PLUGIN-NAME"] = (function() {
-
-  var plugin = {};
-
-  plugin.info = {
-    name: "PLUGIN-NAME",
-    parameters: {
-      parameter_name: {
-        type: jsPsych.plugins.parameterType.INT, // BOOL, STRING, INT, FLOAT, FUNCTION, KEYCODE, SELECT, HTML_STRING, IMAGE, AUDIO, VIDEO, OBJECT, COMPLEX
-        default: undefined
-      },
-      parameter_name: {
-        type: jsPsych.plugins.parameterType.IMAGE,
-        default: undefined
-      }
-    }
-  }
-
-  plugin.trial = function(display_element, trial) {
-
-    // data saving
-    var trial_data = {
-      parameter_name: 'parameter value'
-    };
-
-    // end trial
-    jsPsych.finishTrial(trial_data);
-  };
-
-  return plugin;
-})();

package/tests/README.md

@@ -1,7 +0,0 @@
-# Testing jsPsych
-
-Tests are written with [Jest](https://facebook.github.io/jest/).
-
-To run the tests, install Node and npm. Run `npm install` in the root jsPsych directory. Then run `npm test`.
-
-To add tests, follow examples contained in this folder. 

package/tests/jsPsych/default-iti.test.js

@@ -1,51 +0,0 @@
-const root = '../../';
-const utils = require('../testing-utils.js');
-
-jest.useFakeTimers();
-
-beforeEach(function(){
-  require(root + 'jspsych.js');
-  require(root + 'plugins/jspsych-html-keyboard-response.js');
-});
-
-describe('default iti parameter', function(){
-  test('has a default value of 0', function(){
-    var t = {
-      type: 'html-keyboard-response',
-      stimulus: 'foo'
-    }
-
-    var t2 = {
-      type: 'html-keyboard-response',
-      stimulus: 'bar'
-    }
-
-    jsPsych.init({timeline: [t,t2]});
-
-    expect(jsPsych.getDisplayElement().innerHTML).toMatch('foo');
-    utils.pressKey(32);
-    expect(jsPsych.getDisplayElement().innerHTML).toMatch('bar');
-    utils.pressKey(32);
-  });
-
-  test('creates a correct delay when set', function(){
-    var t = {
-      type: 'html-keyboard-response',
-      stimulus: 'foo'
-    }
-
-    var t2 = {
-      type: 'html-keyboard-response',
-      stimulus: 'bar'
-    }
-
-    jsPsych.init({timeline: [t,t2], default_iti: 100});
-
-    expect(jsPsych.getDisplayElement().innerHTML).toMatch('foo');
-    utils.pressKey(32);
-    expect(jsPsych.getDisplayElement().innerHTML).not.toMatch('bar');
-    jest.advanceTimersByTime(100);
-    expect(jsPsych.getDisplayElement().innerHTML).toMatch('bar');
-    utils.pressKey(32);
-  });
-});