-
Notifications
You must be signed in to change notification settings - Fork 16
/
experimentr.js
203 lines (170 loc) · 5.73 KB
/
experimentr.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
var experimentr = (function() {
var experimentr = { version: "0.0.1" }
, sequence
, current
, mainDiv
, data = {};
// Add a random postId for each new participant
data.postId = (+new Date()).toString(36);
// Accessor for postId
experimentr.postId = function() {
return data.postId;
};
// Accessor for data
experimentr.data = function() {
return data;
};
// Starts the experiment by loading the first module
experimentr.start = function() {
init();
current = 0;
activate(current);
experimentr.startTimer('experiment');
};
// Add a function to be called when a person clicks next.
// (This can be cleared with clearNext()).
experimentr.onNext = function(cb) {
d3.select('#next-button').on('click', function() {
cb();
experimentr.next();
});
};
// Reset the callbacks on next click.
experimentr.clearNext = function() {
d3.select('#next-button').on('click', experimentr.next);
};
// Create the divs for the experiment content and controls.
function init() {
if(mainDiv) return;
mainDiv = d3.select('body').append('div')
.attr('id', 'experimentr');
mainDiv.append('div')
.attr('id', 'module');
mainDiv.append('div')
.attr('id', 'control')
.append('button')
.attr('type', 'button')
.attr('id', 'next-button')
.attr('disabled', true)
.text('Next')
.on('click', experimentr.next);
}
// Load the next module.
experimentr.next = function() {
experimentr.clearNext();
experimentr.showNext();
current = current + 1;
activate(current);
}
// This just ends the experiment timer right now, but it might be a good place to send final experiment data (if we are using CSV on the backend).
experimentr.end = function() {
experimentr.endTimer('experiment');
}
// Adds the data in `d` to the experiment data, and saves to server.
experimentr.addData = function(d) {
merge(data, d);
experimentr.save();
}
// The HTTP POST code for saving experiment data.
experimentr.save = function(d) {
d3.xhr('/')
.header("Content-Type", "application/json")
.post(JSON.stringify(data), function(err, res) {
if(err) console.log(err);
});
}
// Merges object o2 into o1.
function merge(o1, o2) {
for (var attr in o2) { o1[attr] = o2[attr]; }
}
// Enables the Next button so the user can proceed in the experiment.
experimentr.release = function() {
d3.select('#next-button').attr('disabled', null);
}
// On some multi-part modules, it is helpful to hide the next button until it is needed.
experimentr.hideNext = function() {
d3.select('#next-button').style('display', 'none');
}
// Make the Next button visible.
experimentr.showNext = function() {
d3.select('#next-button').style('display', 'inline');
}
// Disables the Next button until the module code decides the user is done with the current module (release by experimentr.release()).
experimentr.hold = function() {
d3.select('#next-button').attr('disabled', true);
}
// Remove experiment content from the main div.
function clearModule() {
d3.select('#module').html('');
}
// Activate (load) a given module.
function activate(x) {
clearModule();
experimentr.hold();
if(x === sequence.length-1){
removeNextButton();
experimentr.end();
}
d3.html(sequence[x], function(err, d) {
if(err) console.log(err);
d3.select('#module').node().appendChild(d);
});
}
// Remove the next button entirely (TODO ensure this is actually used).
function removeNextButton() {
d3.select('#next-button').remove();
}
// Define the experiment sequence via an array (see index.html for an example).
experimentr.sequence = function(x) {
if(!arguments.length) return sequence;
sequence = x;
return experimentr;
}
// Start a timer with a given String as key
experimentr.startTimer = function(x) {
console.log('starting timer: '+x);
data['time_start_'+x] = Date.now();
}
// End an existing timer (using a String key)
// TODO throw an error if a start wasn't called.
experimentr.endTimer = function(x) {
console.log('ending timer: '+x);
data['time_end_'+x] = Date.now();
data['time_diff_'+x] = parseFloat(data['time_end_'+x]) - parseFloat(data['time_start_'+x]);
experimentr.save();
}
// attachTimer lets you show participants a visual countdown before advancing the experiment.
// target should be a CSS id, so the d3.select works
// seconds is the number of seconds in the countdown
// cb is a function which executes at the end of the countdown (write a custom callback to suite your experiment needs)
// Note, for an invisible timer, set target to null (e.g. attachTimer(null, 10, <insert your callback here>))
experimentr.attachTimer = function(target, seconds, cb) {
d3.select(target).text(seconds);
var timesCalled = 0;
var update = function() {
d3.select(target).text(seconds - timesCalled);
if( timesCalled === seconds )
end();
else
timesCalled++;
}
var interval = setInterval(update, 1000);
var end = function() {
clearInterval(interval);
cb();
}
}
// Make sure that backspace doesn't trigger navigation
document.addEventListener('keydown', function(e) {
var target = e.target,
keyCode = e.keyCode;
var isInputField = target.tagName === "INPUT" || target.tagName === "TEXTAREA",
isEditable = target.contentEditable !== null && target.contentEditable === true,
isNotForm = !(isInputField || isEditable);
if(e.keyCode == 8 && isNotForm) {
e.preventDefault();
}
});
// Returns experimentr so we can use it in index.html
return experimentr;
})();