diff --git a/README.md b/README.md index db8b8969..dc4cf117 100644 --- a/README.md +++ b/README.md @@ -5,168 +5,7 @@ jsPsych is a JavaScript library for creating behavioral experiments that run in Examples ---------- -These examples are intended to illustrate what jsPsych code and experiments look like. There is a larger set of example code in the [examples folder](/examples). - -#### #1: Displaying instructions [(code)](https://github.com/jspsych/jsPsych/tree/master/examples/demos/demo_1.html) -
- -
- - -```javascript - - - - - - - - - - - - - -var trial = { - type: 'instructions', - pages: [ - 'Welcome to the experiment. Click next to begin.', - - '

In this experiment, you will view a ' + - 'series of images and answer questions.

' + - '

Answer with the keys "y" or "n".

', - - '

Here is an example:

' + - '' + - '

Is this person OLD or YOUNG?

' - ], - show_clickable_nav: true -} - -jsPsych.init({ - timeline: [trial], -}); - - - - - - - - - - - -``` - -
-
- - -#### #2: Displaying images and recording a response [(code)](https://github.com/jspsych/jsPsych/tree/master/examples/demos/demo_2.html) -
- - -
- - -```javascript - - - - - - - -var trial_1 = { - type: "image-keyboard-response", - stimulus: 'img/happy_face_1.jpg', - choices: ['y', 'n'], - prompt: '

Is this face happy? Y or N.

' -} - -var trial_2 = { - type: 'image-keyboard-response', - stimulus: 'img/sad_face_2.jpg', - choices: ['y', 'n'], - prompt: '

Is this face happy? Y or N.

' -} - -var trial_3 = { - type: 'image-keyboard-response', - stimulus: 'img/happy_face_2.jpg', - choices: ['y', 'n'], - prompt: '

Is this face happy? Y or N.

' -} - - -jsPsych.init({ - timeline: [trial_1, trial_2, trial_3], - default_iti: 250 -}); - - - - - - - -``` - -
-
- -#### #3: A flanker task showing a few advanced features of the library [(code)](https://github.com/jspsych/jsPsych/tree/master/examples/demos/demo_3.html) - -
- -
- - -```javascript -var test_stimuli = [ - { stimulus: "<<<<<", data: {stim_type: 'congruent'} }, - { stimulus: ">>>>>", data: {stim_type: 'congruent'} }, - { stimulus: "<<><<", data: {stim_type: 'incongruent'} }, - { stimulus: ">><>>", data: {stim_type: 'incongruent'} } -]; - -var test = { - timeline: [{ - type: 'html-keyboard-response', - choices: [37, 39], - stimulus: jsPsych.timelineVariable('stimulus'), - data: jsPsych.timelineVariable('data'), - post_trial_gap: 1500, - response_ends_trial: true - }], - timeline_variables: test_stimuli, - sample: {type: 'fixed-repetitions', size: 2} -}; - -var debrief = { - type: "html-keyboard-response", - stimulus: function() { - var congruent_rt = Math.round(jsPsych.data.get() - .filter({stim_type: 'congruent'}).select('rt').mean()); - var incongruent_rt = Math.round(jsPsych.data.get() - .filter({stim_type: 'incongruent'}).select('rt').mean()); - return "

Your average response"+ - "time for congruent trials was "+congruent_rt+ - "ms.

"+ - "

Your average response time for"+ - "incongruent trials was "+incongruent_rt+ - "ms.

"; - } -}; - -jsPsych.init({ - timeline: [test, debrief], -}); -``` - -
-
+Several example experiments and plugin demonstrations are available in the `/examples` folder. Documentation ------------- @@ -197,7 +36,7 @@ Wondering if jsPsych can be used for research that depends on accurate response * [de Leeuw, J. R., & Motz, B. A. (2016). Psychophysics in a Web browser? Comparing response times collected with JavaScript and Psychophysics Toolbox in a visual search task. *Behavior Research Methods*, *48*(1), 1-12.](http://link.springer.com/article/10.3758%2Fs13428-015-0567-2) * [Hilbig, B. E. (2016). Reaction time effects in lab- versus web-based research: Experimental evidence. *Behavior Research Methods*, *48*(4), 1718-1724.](http://dx.doi.org/10.3758/s13428-015-0678-9) -* [Pinet, S., Zielinski, C., Mathôt, S. et al. (in press). Measuring sequences of keystrokes with jsPsych: Reliability of response times and interkeystroke intervals. *Behavior Research Methods*.](http://link.springer.com/article/10.3758/s13428-016-0776-3) +* [Pinet, S., Zielinski, C., Mathôt, S. et al. (2017). Measuring sequences of keystrokes with jsPsych: Reliability of response times and interkeystroke intervals. *Behavior Research Methods*, *49*(3), 1163-1176.](http://link.springer.com/article/10.3758/s13428-016-0776-3) * [Reimers, S., & Stewart, N. (2015). Presentation and response time accuracy in Adobe Flash and HTML5/JavaScript Web experiments. *Behavior Research Methods*, *47*(2), 309-327.](http://link.springer.com/article/10.3758%2Fs13428-014-0471-1) diff --git a/docs/tutorials/hello-world.md b/docs/tutorials/hello-world.md index 4088917e..fc040be0 100644 --- a/docs/tutorials/hello-world.md +++ b/docs/tutorials/hello-world.md @@ -21,8 +21,7 @@ Create a folder on your computer to put the experiment files in. Once you've cre To edit jsPsych code you'll need a programming-friendly text editor. Some free options are: * [Atom](https://atom.io) (Windows, OSX, Linux) -* [Notepad++](http://notepad-plus-plus.org/) (Windows) -* [TextMate](http://macromates.com/) (OSX) +* [VSCode](https://code.visualstudio.com/) (Windows, OSX, Linux) Once you've got a text editor that you like, create a new file in the experiment folder called `experiment.html`