Building better experiments

Using Builder

All the base knowledge we assume at the start of this workshop can be learned from this 15 minute video

In this demo we will work through making a Posner task in PsychoPy you can download the materials here (open builder > posnerTargets).

What makes a PsychoPy experiment?

A builder experiment has three main sections. To start making an experiment we add routines to our flow and add components to our routines.

../_images/builder_terms.png

Changing things trial-by-trial (the “conditions” file)

If you are going to change something on every repeat of a routine (e.g. stimulus location on each trial) you can use a Conditions file. This is fed into the loop surrounding the routine.

../_images/loops_and_conditions.png

Each header is a variable, each row corresponds to the value of that variable on each repeat/trial.

Then make sure to use that variable to set the parameter of a component on every repeat of your loop.

../_images/set_every_repeat.png

Let’s practice making minor edits

Creating a routine

Let’s add some instructions to our experiment. Imagine that we have several sets of instructions to present, but in every set, the instructions consist of the same components:

  • A text (or image) component to explain the task.

  • A way of allowing the participant to move on through the instructions (using a key press or an on-screen button)

We could add a basic routine, but we could also add a loop around our instructions routine to iterate over a set of instructions (with that loopType set to “sequential”).

../_images/routines_basics.png

Gather some additional info (e.g. age)

Every experiment starts with a dialog box to gather some info about the participant/experiment. By default “participant” and “session” are gathered - and these are used to set the filename of that participant.

../_images/exp_info.png

Note

In the current release (2021.2.3) check box options are not yet supported online.

Warm up exercises (10 mins)

  • Add a ‘neutral’ condition to our task:

    Use the double headed arrow in the images folder for the neutral stimulus. The neutral stimulus can cue a target on the left or the right.

  • Add a ‘thanks’ message to tell participants when they end the experiment.

  • Replace the series of instructions text with a series of images (see the images/instructions folder for pre-made slides).

When you are finished, come back to the main session and collect one run of your task so that we can talk through the data file.

Block designs and counterbalancing

Randomized block designs

A block design is where we have sets of similar trials organized into blocks rather than having trials interleaved.

e.g.
  • a block of faces to recognize or a block of houses

  • a block of Stroop task in English and a block in French

  • a block of valid trials versus a block of invalid trials

Note: these are all cases where the components would be identical between blocks.

The natural approach

When people have several “blocks” the natural move is to add separate routines for those blocks:

../_images/natural_error.png

However, if both blocks contain the same stimuli/elements (e.g. a Posner task with a fixation, cue and image, but where the position of the cue varies between blocks), this is not the most efficient approach.

Blocking: Case 1

Instead of a Routine for each block, create a Routine for all your trials and make it behave differently across the blocks:

../_images/case1_blocks.png

Then you can set the conditions files in your blocks loop to control the block-level changes. The outer “blocks” loop then takes a (meta) “conditions” file that specifies which of the conditions files will be loaded in each block.

Blocking: Case 2

If you do have 2 blocks that contain very different stimuli the approach to take is to control the number of times each block repeats using an outer-loop.

../_images/case2_blocks.png

Blocking: Our example

Imagine we want to extend our Posner task to include a block of invalid trials and a block of valid trials.

We need to create a total of 3 conditions files:

  • valid_conditions.xlsx

  • invalid_conditions.xlsx

  • blocks.xlsx (the conditions file used in the outer loop)

Introducing a block

Using what we know about blocks, we could add a routine to tell the participants what kind of block they are about to enter. If our blocks.xlsx file has a column to label the condition, we can add a routine to introduce the block type.

../_images/block_intro.png

You’ve sorted out block designs in a relatively neat fashion.

Just keep clear what differs from one block to the next (for a conditions file) and what stays the same (for the Routine definition).

Counterbalancing

Counterbalancing your blocks is really just an extension of the blocking scenario, except that you set the blocks to operate in a particular order rather than leaving PsychoPy to randomize them.

Setting the order

At the moment, PsychoPy doesn’t handle the ordering for you - you need to decide how to create the orders and how to assign participants.

So, you need a file per conditions order (e.g. A -> B and B-> A), then determine which file will be used for this group and use that file in the blocks loop

Remember to set the blocks loop to be `sequential` rather than `random` to preserve the order you set.

How to assign participants to a group

Easiest way is by hand at the start of the run for the participant. The steps are:

  • In Experiment Settings add a field for group (which will be A, B, C… for however many orders you need)

  • For the block loop use that value by calling expInfo[‘group’] using one of the alternatives below:

    $"block" + expInfo['group'] + ".xlsx"
    $"block{}.xlsx".format( expInfo['group'] )
    $f"block{expInfo['group']}.xlsx"
    

Note: This last kind of formatting is termed an ‘fstring’ in python - we will talk about that more later. If you are running experiments online, the first method will work best

../_images/counterbalancing_loop.png

Note

expInfo is a python “dictionary” that stores all information from the startup GUI. Fields of a python dictionary are accessed using the format dictName['fieldName']. It works the same locally and online and means you can set features of your experiment based on the input recieved at startup!

Exercises

Let’s practice counterbalancing in different ways using the exercises in the folder you downloaded (“builder > counterbalancingExercises”). In “exercise 1” you will find an inefficiently counterbalanced design. We want to improve this in two phases.

  1. Turn this inefficient design into a randomized block design. (the cat and dog images are presented in blocks, but in a random order)

  2. Then turn this into a counterbalanced design. So that group A see cats first and group B see dogs first. (You should be able to input group in the GUI at the start)

When you are finished, come back to the main session, if you run into any error messages please share them (on slack) and we can discuss them.

Counterbalancing subtasks

Sometimes we might have to counterbalance subtasks (i.e. routines that contain very different sets of components).

For this we would use the second blocking method we described earlier. You can wrap a loop around any set of routines and control if it presents using nReps.

In the below we could control create the order C->B->A by using a conditions file where the nReps of each sub-loop are set per iteration of the outer-loop.

../_images/counterbalancesubs.png

e.g. using a conditions file like this…

nRepsA

nRepsB

nRepsC

0

0

1

0

1

0

1

0

1

Where the nReps argument of each sub-loop is set using something like ‘$nRepsA’ etc.

Exercise

Open exercise 2 in the counterbalanceExercises folder. This is very similar to our last task, but this time our two routines present different kinds of components, so we need to use a different method of counterbalancing.

We want a design where groupA sees cat images first and group B sees cat words first. Counterbalance this flow using the nReps arguments in the loops.

All done

You can now create trials and blocks in any order, fixed or random and counterbalance subtasks!

You’re in complete control (but you need to understand what orders you want!)

Up next Running and sharing studies online

Extending Builder with code


Back to top