Getting started / Making an experiment

Documentation

Documentation for PsychBench comes in parts:

Getting started / Making an experiment, Demos

There's this document you’re reading now.

In addition, various demos are in <><PsychBench folder><>/docs/demos. You can even copy these and modify them to play around.

Reference documentation

The main reference documentation is online. Read only as needed.

If you make your own element types or receive them from other people, their documentation is in text files in their folders in your local element types folder. The pb command below will still find it there.

Files and folders, Function help

You can type help PsychBench for an overview of all files and folders. Information for each function is in its usual MATLAB help: type help <><function><> at the MATLAB command line.

Quick Reference

Quick reference.pdf is online and in <><PsychBench folder><>/docs. It might be useful to print it.

Element Type Programming Manual

Element type programming manual.pdf is online and in <><PsychBench folder><>/docs. This is for if you want to make custom stimuli in the form of new element types. Read only as needed.

The pb command

You can always open documentation directly. However, the command pb is a quick way to access all PsychBench documentation from the MATLAB command line:

<cd>pb<cd>
→ Choose from a menu of all object types and documentation

<cd>pb <cd><cds><object type><cds>
e.g. <cd>pb <cd><cds>picture<cds>    (or shorter: <cd>pb <cd><cds>pic<cds>)
or input objects directly: <cd>pb(<objects>)<cd>
→ Quickly see names and default values for all properties for an object type, optionally open full documentation

<cd>pb <cd><cds><object type>.<property><cds>
e.g. <cd>pb <cd><cds>picture.height<cds>    (or shorter: <cd>pb <cd><cds>pic.he<cds>)
→ Quickly see name and default value for a property

<cd>pb <cd><cds><documentation><cds>
e.g. <cd>pb <cd><cds>d<cds>
→ Open documentation. Type help pb for all options.