Signals exp test (#231)

* Tiny changes to appease MATLAB

* Started installation section

* Added matlabdomain extension

* Added infomation for remote location in reposPath

* Started a setup page

* Added parameters walkthrough

* HOTFIX changed Alyx Panel login timer to 90 mins

* 2.3 <- 2.2.1 (#198)

* updated signals submodule

* updated signals submodule (eb71b1f)

* Added test for ensureCell

* Fix'd typo in ensureCell_test

* Future-proofing runall to ignore tests with specific hardware requirements

* Added tests for nop, iff and emptyElems

* Added tests for cellsprintf and num2cellstr; bug fix in num2cellstr

* Submodule update

* mapToCell test

* Removed complete todos

* Added test for dat.expExists

* Restore changes made in commit
247060a

* Expanded test for dispWaterReq

* assert -> verifyMatches

* Added catStructs test

* Added tabulateArgs test

* superSave test added

* added an informative error message in the case that dat.paths is missing

* Attempting to construct a branch that doesn't differ from dev in its submodules

* Revert "Attempting to construct a branch that doesn't differ from dev in its submodules"
Reverting a commit that should have been to dev_kevin, not to dev

* Revert "added an informative error message in the case that dat.paths is missing"
Reverting a commit that should have been to dev_kevin, not to dev
This reverts commit a492bd2.

* Added file package test

* Added test for pick

* Added test for namedArg

* Added varName test

* Added back tolerance change

* Dev kevin (#192)

* added an informative error message when dat.paths is not present

* added an identifier to the error message

* Added warnings and errors to deal with the case that hardware.mat is not found

* fixed identifier

* Changed error identifiers following Miles' suggestion of module:package:function:error

* added more info to error for empty rig

* added more info to no dat.paths error

* Bug fix in namedArg test

* Removed old function -> now a method of Alyx

* Started +fun package test; added fileFunction test

* No longer using 'which' to assert function existence

* Bug fixes for tests

* Bug fix for wiringInfo method

* Added KeyedSeq test

* Added docs for apply and applyForce

* Added loadVar test

* Issue #168

* Added mergeStructs test

* Added performance tests; reorganized tests; updated changelog

* Added parameters walkthrough

* Added timeline walkthrough; bug fix for wiringInfo in Timeline

* added informative error messages to calibration code

* Added documentation for setting up Window; documentation for Window class; Minor bug fixes

* Added a few examples to hardware docs

* Added Viewing model walkthrough and expanded FAQ

* Updated changelog

* Updates to docs

* Added test for +hw/calibrate.m

* deleted exp.construct

* Added documentation for calibration test

* Updated docs; added services guide

* Updates docs

* Fix for Communicator WTF mode; increased test coverage for iff

* Update to changelog and signals

* HOTFIX changed Alyx Panel login timer to 90 mins

* Removed readthedocs, updated submodules

* Update Shields

* HOTFIX: Correct location of docs in README; Stronger wording in install instructions

* Added issue templates (#179)

* Added troubleshooting docs and error id list

* Using signals error handling branch; added troubleshooting doc

* Re-factoring SignalsExp for test subclassing

* Started expServer tests

* Added more tests; bug fix for older versions

* Removed validation functions for old MATLAB versions; added documentation

* More coverage, documentation

* Draws text to screen during calibration #128

* Fix for #4

* Added structAssign test; rewardId tests

* Typo fix in structAssign_test

* Finished tests for expServer

* #156

* Returned listener delete to cleanup

* Stricter tolerance in AlyxPanel_test; bug fix for rounding negative numbers

* Update alyx-matlab submodule

* Minor changes to documentation

* Update CHANGELOG.md

* Added tests for tl.bindMpepServer and pnet spy

* Fixture path fix

* Moved audioDevices default to devices mock

* WIP

* #100 #202

* Updated tests with share fixtures; added pause/resume to SignalsExp; added further tests for SignalsExp; updated tests README; SessionURL fetched from database when necessary

* Added better update of keyboard input signal

* Potential fix for #213

* Updates to submodules

* Update to alyx-matlab

* Context menu for hiding event updates in ExpPenel

* trialCondition index can be reset with signal

* Improvements to test UI

* Documentation

* README for +eui package (#156)

* WIP

* Removed warning from updateLogEntry when Alyx deactivated #202

* Added hide option for ExpPanel; ExpPanel guide in docs

* Added utils; started docs

* #218

* Support for ids in errOnFail

* Removed old commented-out code

* Scale port closed on errors

* Added brief PTB install instructions (#228)

* cleanup

* Documentation; #229

* More flags for addRigboxPaths

* started updating README after Anwar's comments

* updated some instructions in README

* Revert "started updating README after Anwar's comments"

This reverts commit 9f5a456.

* Updated documentation

* Removed PTBDebug call and added example to docstring

* Update to CHANGELOG and signals

* #205 - refactored

* Update to tests

* Warning supression in tests

* CHANGELOG

Co-authored-by: Jai Bhagat <j.bhagat@ucl.ac.uk>

Author: k1o0

+dat/expFilePath.m

@@ -20,25 +20,36 @@
 
 % 2013-03 CB created
 
-assert(length(varargin) > 1, 'Error: Not enough arguments supplied.')
+assert(length(varargin) > 1, 'Rigbox:dat:expFilePath:NotEnoughInputs',...
+  'Not enough input arguments.')
 
 parsed = catStructs(regexp(varargin{1}, dat.expRefRegExp, 'names'));
 if isempty(parsed) % Subject, not ref
-  if nargin > 4
+  if nargin < 3
+    error('Rigbox:dat:expFilePath:NotEnoughInputs', ...
+      ['Not enough input arguments; check expRef formatted correcly ' ...
+      'or enter subject, date and sequence as separate arguments'])
+  elseif nargin == 3
+    error('Rigbox:dat:expFilePath:NotEnoughInputs', ...
+      'Not enough input arguments; missing file type')
+  elseif nargin > 4
     location = varargin{5};
     varargin(5) = [];
   else
     location = {};
   end
   typeIdx = 4;
 else % Ref, not subject
-  typeIdx = 2;
-  if nargin > 2
+  if nargin < 2
+    error('Rigbox:dat:expFilePath:NotEnoughInputs', ...
+      'Not enough input arguments; missing file type')
+  elseif nargin > 2
     location = varargin{3};
     varargin(3) = [];
   else
     location = {};
   end
+  typeIdx = 2;
 end
 
 % tabulate the args to get complete rows

+dat/expPath.m

@@ -23,6 +23,9 @@
   reposArgs = varargin(end);
   varargin = varargin(1:end - 1);
 else
+  % Check for minimum inputs
+  assert(nargin > 2, ...
+    'Rigbox:dat:expPath:NotEnoughInputs', 'Must provide repo location')
   reposArgs = varargin((end - 1):end);
   varargin = varargin(1:end - 2);
 end

+dat/reposPath.m

@@ -4,21 +4,26 @@
 %   repository specified by 'name'.
 %
 %   Each repository can have multiple locations with one location being the
-%   "master" copy and others considered backups (e.g. copies on local
-%   machines). Users of this function wanting to *save* data should do so
-%   in all locations. To *load* data, the master may be the only location
-%   containing all data (i.e. because local copies will only be on specific
-%   machines). The optional 'location' parameter specifies one or more
-%   locations, with "all" being the default that returns all locations for
-%   that repository, and "master" will return the path to the master
-%   location.
+%   'master' copy and others considered backups or archives (e.g. copies on
+%   local machines). Users of this function wanting to *save* data should
+%   do so in all locations (i.e. master and local). To *load* data, the
+%   remote locations (i.e. master and archives) should be used (i.e.
+%   because local copies will only be on specific machines). The optional
+%   'location' parameter specifies one or more locations, with 'all' being
+%   the default that returns the master and local locations for that
+%   repository, 'master' will return the path to the master location, and
+%   'remote' will return the master and archive/alternate paths (in that
+%   order).
 %
-%   e.g. to get all paths you should save to for the "main" repository:
-%   savePaths = DAT.REPOSPATH('main') % savePaths is a string cell array
+%   e.g. to get all paths you should save to for the 'main' repository:
+%   savePaths = DAT.REPOSPATH('main') % savePaths is a cell string
 %
-%   To get the master location for the "main" repository:
+%   To get the master location for the 'main' repository:
 %   loadPath = DAT.REPOSPATH('main', 'master') % loadPath is a string
 %
+%   When data are spread across multiple remote locations such as archives:
+%   loadPath = DAT.REPOSPATH('main', 'remote') % loadPath is a cell string
+%
 % Part of Rigbox
 
 % 2013-03 CB created

+dat/updateLogEntry.m

@@ -10,7 +10,7 @@ function updateLogEntry(subject, id, newEntry)
 
 % 2013-03 CB created
 
-if isfield(newEntry, 'AlyxInstance')
+if isfield(newEntry, 'AlyxInstance') && ~isempty(getOr(dat.paths, 'databaseURL'))
   % Update session narrative on Alyx
   if ~isempty(newEntry.comments) && ~strcmp(subject, 'default')
     try

+eui/Contents.m

@@ -0,0 +1,32 @@
+% +EUI Experiment UI package
+%
+% This +eui package contains all code pertaining to graphical user
+% interfaces in Rigbox. There are five base classes in this folder:
+% 
+% 1. MControl - The class behind the Master Control (MC) GUI.  
+% 2. ExpPanel - The superclass for UI panels that process and plot remote
+%    experiment event updates (i.e. the panels under the Current
+%    Experiments tab of MC).
+% 3. Log - UI control for viewing experiment log entries (the table under
+%    the Log tab of MC).
+% 4. AlyxPanel - UI for interacting with the Alyx database (the Alyx panel
+%    in the New Experiments tab of MC).  Can be run as a stand-alone GUI.
+% 5. ParamEditor - UI for viewing and editing parameters (the Parameter
+%    panel in the New Experiments table of MC).  Can be run as a
+%    stand-alone GUI.
+%
+% Files
+%   AlyxPanel       - A GUI for interating with the Alyx database
+%   ChoiceExpPanel  - UI control for monitoring a 2AFC experiment
+%   ConditionPanel  - Deals with formatting trial conditions UI table
+%   ExpPanel        - Basic UI control for monitoring an experiment
+%   FieldPanel      - Deals with formatting global parameter UI elements
+%   Log             - UI control for viewing experiment log entries
+%   MappingExpPanel - Preliminary UI for monitoring a mapping experiment
+%   MControl        - GUI for the control of experiments
+%   ParamEditor     - GUI for visualizing and editing experiment parameters
+%   SignalsTest     - A GUI for testing SignalsExp experiment definitions
+%   SqueakExpPanel  - Basic UI control for monitoring a Signals experiment
+%
+% See Also
+%   docs/html/using_mc.m, docs/html/using_ParamEditor.m

+eui/MControl.m

@@ -201,20 +201,16 @@ function delParamProfile(obj) % Called when 'Delete...' button is pressed next t
         profiles = obj.NewExpParamProfile.Option; % Get parameter profile
         obj.NewExpParamProfile.Option = profiles(~strcmp(profiles, profile)); % Set new list without deleted profile
         %log the parameters as being deleted
-        obj.log('Deleted parameters as ''%s''', profile);
+        obj.log('Deleted parameter set ''%s''', profile);
       end
     end
 
     function saveParamProfile(obj) % Called by 'Save...' button press, save a new parameter profile
       selProfile = obj.NewExpParamProfile.Selected; % Find which set is currently selected
-      if selProfile(1) ~= '<' % This statement is for autofilling the save as input dialog
-        %default value is currently selected profile name
-        def = selProfile;
-      else
-        %begins with left bracket: a special case profile is selected
-        %no default value
-        def = '';
-      end
+      % This statement is for autofilling the save as input dialog; default
+      % value is currently selected profile name, however if a special case
+      % profile is selected there is no default value
+      def = iff(selProfile(1) ~= '<', selProfile, '');
       ipt = inputdlg('Enter a name for the parameters profile', 'Name', 1, {def});
       if isempty(ipt)
         return
@@ -240,6 +236,7 @@ function saveParamProfile(obj) % Called by 'Save...' button press, save a new pa
         if ~any(strcmp(obj.NewExpParamProfile.Option, validName))
           obj.NewExpParamProfile.Option = [profiles; validName];
         end
+        obj.NewExpParamProfile.Selected = validName;
         %set label for loaded profile
         set(obj.ParamProfileLabel, 'String', validName, 'ForegroundColor', [0 0 0]);
         obj.log('Saved parameters as ''%s''', validName);

+eui/ParamEditor.m

@@ -392,7 +392,7 @@ function onResize(obj)
                 rethrow(ex);
               end
             end
-          elseif iscellstr(currParam)
+          elseif iscellstr(currParam) %#ok<ISCLSTR>
             C = textscan(data, '%s',...
                 'ReturnOnError', false,...
                 'delimiter', {' ', ','}, 'MultipleDelimsAsOne', 1);

+eui/README.md

@@ -0,0 +1,30 @@
+## Experiment UI Package (+eui):
+This `+eui` package contains all code pertaining to graphical user interfaces in Rigbox.
+There are five base classes in this folder:
+
+1. `eui.MControl` - The class behind the Master Control (MC) GUI.  
+2. `eui.ExpPanel` - The superclass for UI panels that process and plot remote experiment event updates (i.e. the panels under the Current Experiments tab of MC).
+3. `eui.Log` - UI control for viewing experiment log entries (the table under the Log tab of MC).
+4. `eui.AlyxPanel` - UI for interacting with the Alyx database (the Alyx panel in the New Experiments tab of MC).  Can be run as a stand-alone GUI.
+5. `eui.ParamEditor` - UI for viewing and editing parameters (the Parameter panel in the New Experiments table of MC).  Can be run as a stand-alone GUI.
+    
+## Contents:
+
+Below is a list of all files present:
+
+- `MControl.m` - Whatever it is, take control of your experiments from this GUI
+- `AlyxPanel.m` - A GUI for interating with the Alyx database.
+- `SignalsTest.m` - A GUI for testing a Signals Experiment.
+- `ExpPanel.m` - Basic UI control for monitoring an experiment.
+- `SqueakExpPanel.m` - Basic UI control for monitoring a Signals Experiment.
+- `ChoiceExpPanel.m` - An eui.ExpPanel subclass for monitoring ChoiceWorld experiments.
+- `MappingExpPanel.m` - Preliminary UI for monitoring a mapping experiment.
+- `ParamEditor.m` - GUI for visualizing and editing experiment parameters.
+- `ConditionPanel.m` - A class for displaying the trial condition parameters in eui.ParamEditor.
+- `FieldPanel.m` - A class for displaying global parameters in eui.ParamEditor.
+- `Log.m` - UI control for viewing experiment log entries.
+
+## See Also:
+
+- `docs/html/using_mc.m` - A guide to using MC.
+- `docs/html/using_ParamEditor.m` - A guide to using the eui.ParamEditor UI.