fix xab bug and formatting

Closes #74
This commit is contained in:
Josh de Leeuw 2014-09-29 08:17:19 -04:00
parent 6f10c190c5
commit 940c5580f8

View File

@ -9,182 +9,177 @@
*/
(function($) {
jsPsych.xab = (function() {
jsPsych.xab = (function() {
var plugin = {};
var plugin = {};
plugin.create = function(params) {
plugin.create = function(params) {
params = jsPsych.pluginAPI.enforceArray(params, ['data']);
params = jsPsych.pluginAPI.enforceArray(params, ['data']);
// the number of trials is determined by how many entries the params.stimuli array has
var trials = new Array(params.stimuli.length);
// the number of trials is determined by how many entries the params.stimuli array has
var trials = new Array(params.stimuli.length);
for (var i = 0; i < trials.length; i++) {
trials[i] = {};
trials[i].x_path = params.stimuli[i][0];
// if there is only a pair of stimuli, then the first is the target and is shown twice.
// if there is a triplet, then the first is X, the second is the target, and the third is foil (useful for non-exact-match XAB).
if (params.stimuli[i].length == 2) {
trials[i].a_path = params.stimuli[i][0];
trials[i].b_path = params.stimuli[i][1];
} else {
trials[i].a_path = params.stimuli[i][1];
trials[i].b_path = params.stimuli[i][2];
for (var i = 0; i < trials.length; i++) {
trials[i] = {};
trials[i].x_path = params.stimuli[i][0];
// if there is only a pair of stimuli, then the first is the target and is shown twice.
// if there is a triplet, then the first is X, the second is the target, and the third is foil (useful for non-exact-match XAB).
if (params.stimuli[i].length == 2) {
trials[i].a_path = params.stimuli[i][0];
trials[i].b_path = params.stimuli[i][1];
} else {
trials[i].a_path = params.stimuli[i][1];
trials[i].b_path = params.stimuli[i][2];
}
trials[i].left_key = params.left_key || 81; // defaults to 'q'
trials[i].right_key = params.right_key || 80; // defaults to 'p'
// timing parameters
trials[i].timing_x = params.timing_x || 1000; // defaults to 1000msec.
trials[i].timing_xab_gap = params.timing_xab_gap || 1000; // defaults to 1000msec.
trials[i].timing_ab = params.timing_ab || -1; // defaults to -1, meaning infinite time on AB. If a positive number is used, then AB will only be displayed for that length.
// optional parameters
trials[i].is_html = (typeof params.is_html === 'undefined') ? false : params.is_html;
trials[i].prompt = (typeof params.prompt === 'undefined') ? "" : params.prompt;
}
return trials;
};
var xab_trial_complete = false;
plugin.trial = function(display_element, trial) {
// if any trial variables are functions
// this evaluates the function and replaces
// it with the output of the function
trial = jsPsych.pluginAPI.normalizeTrialVariables(trial);
xab_trial_complete = false;
// how we display the content depends on whether the content is
// HTML code or an image path.
if (!trial.is_html) {
display_element.append($('<img>', {
src: trial.x_path,
"class": 'jspsych-xab-stimulus'
}));
} else {
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus',
html: trial.x_path
}));
}
// start a timer of length trial.timing_x to move to the next part of the trial
setTimeout(function() {
showBlankScreen();
}, trial.timing_x);
function showBlankScreen() {
// remove the x stimulus
$('.jspsych-xab-stimulus').remove();
// start timer
setTimeout(function() {
showSecondStimulus();
}, trial.timing_xab_gap);
}
function showSecondStimulus() {
// randomize whether the target is on the left or the right
var images = [trial.a_path, trial.b_path];
var target_left = (Math.floor(Math.random() * 2) === 0); // 50% chance target is on left.
if (!target_left) {
images = [trial.b_path, trial.a_path];
}
// show the options
if (!trial.is_html) {
display_element.append($('<img>', {
"src": images[0],
"class": 'jspsych-xab-stimulus left'
}));
display_element.append($('<img>', {
"src": images[1],
"class": 'jspsych-xab-stimulus right'
}));
} else {
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus left',
html: images[0]
}));
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus right',
html: images[1]
}));
}
if (trial.prompt !== "") {
display_element.append(trial.prompt);
}
// if timing_ab is > 0, then we hide the stimuli after timing_ab milliseconds
if (trial.timing_ab > 0) {
setTimeout(function() {
if (!xab_trial_complete) {
$('.jspsych-xab-stimulus').css('visibility', 'hidden');
}
trials[i].left_key = params.left_key || 81; // defaults to 'q'
trials[i].right_key = params.right_key || 80; // defaults to 'p'
// timing parameters
trials[i].timing_x = params.timing_x || 1000; // defaults to 1000msec.
trials[i].timing_xab_gap = params.timing_xab_gap || 1000; // defaults to 1000msec.
trials[i].timing_ab = params.timing_ab || -1; // defaults to -1, meaning infinite time on AB. If a positive number is used, then AB will only be displayed for that length.
// optional parameters
trials[i].is_html = (typeof params.is_html === 'undefined') ? false : params.is_html;
trials[i].prompt = (typeof params.prompt === 'undefined') ? "" : params.prompt;
}, trial.timing_ab);
}
// create the function that triggers when a key is pressed.
var after_response = function(info) {
var correct = false; // true when the correct response is chosen
if (info.key == trial.left_key) // 'q' key by default
{
if (target_left) {
correct = true;
}
} else if (info.key == trial.right_key) // 'p' key by default
{
if (!target_left) {
correct = true;
}
}
return trials;
// create object to store data from trial
var trial_data = {
"rt": info.rt,
"correct": correct,
"stimulus_x": trial.x_path,
"stimulus_a": trial.a_path,
"stimulus_b": trial.b_path,
"key_press": info.key
};
jsPsych.data.write($.extend({}, trial_data, trial.data));
display_element.html(''); // remove all
xab_trial_complete = true;
// move on to the next trial after timing_post_trial milliseconds
if (trial.timing_post_trial > 0) {
setTimeout(function() {
jsPsych.finishTrial();
}, trial.timing_post_trial);
} else {
jsPsych.finishTrial();
}
};
var xab_trial_complete = false;
jsPsych.pluginAPI.getKeyboardResponse(after_response, [trial.left_key, trial.right_key], 'date', false);
plugin.trial = function(display_element, trial) {
// if any trial variables are functions
// this evaluates the function and replaces
// it with the output of the function
trial = jsPsych.pluginAPI.normalizeTrialVariables(trial);
xab_trial_complete = false;
// how we display the content depends on whether the content is
// HTML code or an image path.
if (!trial.is_html) {
display_element.append($('<img>', {
src: trial.x_path,
"class": 'jspsych-xab-stimulus'
}));
} else {
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus',
html: trial.x_path
}));
}
// start a timer of length trial.timing_x to move to the next part of the trial
setTimeout(function() {
showBlankScreen();
}, trial.timing_x);
break;
// the second part of the trial is the gap between X and AB.
function showBlankScreen() {
// remove the x stimulus
$('.jspsych-xab-stimulus').remove();
// start timer
setTimeout(function() {
showSecondStimulus();
}, trial.timing_xab_gap);
}
// the third part of the trial is to display A and B, and get the subject's response
function showSecondStimulus() {
// randomize whether the target is on the left or the right
var images = [trial.a_path, trial.b_path];
var target_left = (Math.floor(Math.random() * 2) === 0); // 50% chance target is on left.
if (!target_left) {
images = [trial.b_path, trial.a_path];
}
// show the options
if (!trial.is_html) {
display_element.append($('<img>', {
"src": images[0],
"class": 'jspsych-xab-stimulus left'
}));
display_element.append($('<img>', {
"src": images[1],
"class": 'jspsych-xab-stimulus right'
}));
} else {
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus left',
html: images[0]
}));
display_element.append($('<div>', {
"class": 'jspsych-xab-stimulus right',
html: images[1]
}));
}
if (trial.prompt !== "") {
display_element.append(trial.prompt);
}
// if timing_ab is > 0, then we hide the stimuli after timing_ab milliseconds
if (trial.timing_ab > 0) {
setTimeout(function() {
if (!xab_trial_complete) {
$('.jspsych-xab-stimulus').css('visibility', 'hidden');
}
}, trial.timing_ab);
}
// create the function that triggers when a key is pressed.
var after_response = function(info) {
var correct = false; // true when the correct response is chosen
if (info.key == trial.left_key) // 'q' key by default
{
if (target_left) {
correct = true;
}
} else if (info.key == trial.right_key) // 'p' key by default
{
if (!target_left) {
correct = true;
}
}
// create object to store data from trial
var trial_data = {
"rt": info.rt,
"correct": correct,
"stimulus_x": trial.x_path,
"stimulus_a": trial.a_path,
"stimulus_b": trial.b_path,
"key_press": info.key
};
jsPsych.data.write($.extend({}, trial_data, trial.data));
display_element.html(''); // remove all
xab_trial_complete = true;
// move on to the next trial after timing_post_trial milliseconds
if (trial.timing_post_trial > 0) {
setTimeout(function() {
jsPsych.finishTrial();
}, trial.timing_post_trial);
} else {
jsPsych.finishTrial();
}
};
jsPsych.pluginAPI.getKeyboardResponse(after_response, [trial.left_key, trial.right_key], 'date', false);
}
}
};
return plugin;
})();
}
};
return plugin;
})();
})(jQuery);