update dependency check and doc

- fxing remi's drunk coding

Author: Remi-Gau

CPP_getResponseDemo.m

@@ -1,20 +1,20 @@
-  jk%% Demo showing how to use the getResponse function
+%% Demo showing how to use the getResponse function
 
-% This small script shows how to use the getReponse function 
+% This small script shows how to use the getReponse function
 %  (a wrapper around the KbQueue function from PTB)
 
 % start with a clean slate
-clear; clc; 
+clear; clc;
 if IsOctave
     more off % for a better display experience
 end
 
 %% set parameters
 
-% cfg.responseBox would be the device number of the device used by the participant to give his/her 
+% cfg.responseBox would be the device number of the device used by the participant to give his/her
 % response: like the button box in the scanner or a separate keyboard for a behavioral experiment
 %
-% cfg.keyboard would be the device number of the keyboard on which the experimenter will type or 
+% cfg.keyboard would be the device number of the keyboard on which the experimenter will type or
 % press the keys necessary to start or abort the experiment.
 
 %  cfg.responseBox and cfg.keyboard can be different or the same.
@@ -57,10 +57,10 @@
 
 fprintf('\nDuring the next 5 seconds we will collect responses on the following keys: \n\n');
 if isempty(expParameters.responseKey)
-    fprintf('\nALL KEYS\n\n');    
+    fprintf('\nALL KEYS\n\n');
 else
     for iKey=1:numel(expParameters.responseKey)
-        fprintf('\n%s', expParameters.responseKey{iKey});  
+        fprintf('\n%s', expParameters.responseKey{iKey});
     end
     fprintf('\n\n');
 end

README.md

@@ -1,6 +1,9 @@
 # CPP_PTB
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 This is List of Crossmodal Perpeption and Plasticity lab (CPP) PsychToolBox (PTB) toolbox.
@@ -16,7 +19,7 @@ For instructions see the following links:
 
 | Requirements                                             | Used version |
 |----------------------------------------------------------|--------------|
-| [PsychToolBox](http://psychtoolbox.org/)  Duuuuhh        | >3.0.13      |
+| [PsychToolBox](http://psychtoolbox.org/)  Duuuuhh        | >=3.0.14      |
 | [Matlab](https://www.mathworks.com/products/matlab.html) | 201??        |
 | or [octave](https://www.gnu.org/software/octave/)        | 4.?          |
 
@@ -36,40 +39,37 @@ We keep the McCabe complexity as reported by the [check_my_code function](https:
 This repository can be added as a dependencies by listing it in a [mpm-requirements.txt file](.mpm-requirements.txt)
 as follows:
 
-```
-CPP_PTB -u https://github.com/cpp-lln-lab/CPP_PTB.git
-```
+    CPP_PTB -u https://github.com/cpp-lln-lab/CPP_PTB.git
 
 You can then use the [matlab package manager](https://github.com/mobeets/mpm), to simply download the appropriate version of those dependencies and add them to your path by running a `getDependencies` function like the one below where you just need to replace `YOUR_EXPERIMENT_NAME` by the name of your experiment.
 
-
 ```matlab
-function getDependencies(action)
-% Will install on your computer the matlab dependencies specified in the mpm-requirements.txt
-%  and add them to the matlab path. The path is never saved so you need to run getDependencies() when
-%  you start matlab.
-%
-% getDependencies('update') will force the update and overwrite previous version of the dependencies.
-%
-% getDependencies() If you only already have the appropriate version but just want to add them to the matlab path.
-
-experimentName = YOUR_EXPERIMENT_NAME;
-
-if nargin<1
-    action = '';
-end
-
-switch action
-    case 'update'
-        % install dependencies
-        mpm install -i mpm-requirements.txt -f -c YOUR_EXPERIMENT_NAME
-end
-
-% adds them to the path
-mpm_folder = fileparts(which('mpm'));
-addpath(genpath(fullfile(mpm_folder, 'mpm-packages', 'mpm-collections', experimentName)));
-
-end
+  function getDependencies(action)
+  % Will install on your computer the matlab dependencies specified in the mpm-requirements.txt
+  %  and add them to the matlab path. The path is never saved so you need to run getDependencies() when
+  %  you start matlab.
+  %
+  % getDependencies('update') will force the update and overwrite previous version of the dependencies.
+  %
+  % getDependencies() If you only already have the appropriate version but just want to add them to the matlab path.
+
+  experimentName = YOUR_EXPERIMENT_NAME;
+
+  if nargin<1
+      action = '';
+  end
+
+  switch action
+      case 'update'
+          % install dependencies
+          mpm install -i mpm-requirements.txt -f -c YOUR_EXPERIMENT_NAME
+  end
+
+  % adds them to the path
+  mpm_folder = fileparts(which('mpm'));
+  addpath(genpath(fullfile(mpm_folder, 'mpm-packages', 'mpm-collections', experimentName)));
+
+  end
 ```
 
 
@@ -80,22 +80,25 @@ end
 ### initPTB
 
 This will initialize PsychToolBox
+
 -   screen
-  - the windon opened takes the whole screen by default
-  - set in debug mode with window transparency if necessary
-  - can skip synch test if you ask for it (nicely)
-  - gets the flip interval
-  - computes the pixel per degree of visual angle
-  - set font details
+-   the windon opened takes the whole screen by default
+-   set in debug mode with window transparency if necessary
+-   can skip synch test if you ask for it (nicely)
+-   gets the flip interval
+-   computes the pixel per degree of visual angle
+-   set font details
 -   keyboard
 -   sound
 
 ### testKeyboards
+
 Checks that the keyboards asked for properly connected.
 
 If no key is pressed on the correct keyboard after the timeOut time this exits with an error.
 
 ### cleanUp
+
 A wrapper function to close all windows, ports, show mouse cursor, close keyboard queues
 and give access back to the keyboards.
 
@@ -118,12 +121,10 @@ the value assigned by PTB to each keyboard device.
 
 To know this copy-paste this on the command window:
 
-```
-[keyboardNumbers, keyboardNames] = GetKeyboardIndices;
+    [keyboardNumbers, keyboardNames] = GetKeyboardIndices;
 
-keyboardNumbers
-keyboardNames
-```
+    keyboardNumbers
+    keyboardNames
 
 ### deg2Pix
 
@@ -139,22 +140,16 @@ Define the parameters of the fixation cross in `cfg` and `expParameters` and thi
 
 Use that to stop your script and only restart when the space bar is pressed.
 
-
-
-
-
-
-
-
-
-
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
 <!-- prettier-ignore-start -->
+
 <!-- markdownlint-disable -->
+
 <table>
   <tr>
     <td align="center"><a href="https://remi-gau.github.io/"><img src="https://avatars3.githubusercontent.com/u/6961185?v=4" width="100px;" alt=""/><br /><sub><b>Remi Gau</b></sub></a><br /><a href="https://github.com/cpp-lln-lab/CPP_PTB/commits?author=Remi-Gau" title="Code">💻</a> <a href="#design-Remi-Gau" title="Design">🎨</a> <a href="https://github.com/cpp-lln-lab/CPP_PTB/commits?author=Remi-Gau" title="Documentation">📖</a></td>
@@ -163,7 +158,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 </table>
 
 <!-- markdownlint-enable -->
+
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

checkDependencies.m

@@ -3,26 +3,41 @@ function checkDependencies()
 
 printCredits()
 
-
-PTB = '3.0.16';
+PTB.major =  3;
+PTB.minor = 0;
+PTB.point =  14;
 
 fprintf('Checking dependencies\n')
 
 % check ptb version
 try
-a = PsychtoolboxVersion
-fprintf(' Using %s %s\n', a, b)
-if any(~strcmp(a, PTB))
-    str = sprintf('%s %s %s.\n%s', ...
-        'The current version PTB version is not', PTB,...
-        'In case of problems (e.g json file related) consider updating.');
-    warning(str); %#ok<*SPWRN>
-end
+    
+    [~, versionStruc] = PsychtoolboxVersion;
+    
+    fprintf(' Using PTB %i.%i.%i\n', ...
+        versionStruc.major, ...
+        versionStruc.minor, ...
+        versionStruc.point)
+    
+    if any( [...
+            versionStruc.major < PTB.major, ...
+            versionStruc.minor < PTB.minor, ...
+            versionStruc.point < PTB.point, ...
+            ])
+        
+        str = sprintf('%s %i.%i.%i %s.\n%s', ...
+            'The current version PTB version is not', ...
+            PTB.major, ...
+            PTB.minor, ...
+            PTB.point, ...
+            'In case of problems (e.g json file related) consider updating.');
+        warning(str); %#ok<*SPWRN>
+    end
 catch
     error('Failed to check the PTB version: Are you sure that PTB is in the matlab path?')
 end
 
 
-fprintf(' We got all we need. Let''s get to work.\n')
+fprintf(' We got all we need. Let us get to work.\n')
 
 end