Param profiles test (#244)

* tests and documentation for *paramProfile functions; repos created when none exist

* CHANGELOG

Author: k1o0

+dat/loadParamProfiles.m

@@ -1,6 +1,24 @@
 function p = loadParamProfiles(expType)
 %DAT.LOADPARAMPROFILES Loads the parameter sets for given experiment type
-%   TODO
+%   Loads a struct of parameter structures from a MAT file called
+%   'parameterProfiles'. Each field of this struct is a parameter set name
+%   for a given expType.  Parameters of a given expType can be saved using
+%   the DAT.SAVEPARAMPROFILE function.
+%
+%   Input:
+%     expType (char): The name of the experiment type, e.g. ChoiceWorld.
+%
+%   Output:
+%     p (struct): a scalar struct of parameter sets for the given
+%       experiment type.  Each fieldname holds a different parameter
+%       structure.  The fields are sorted in ASCII dictionary order.
+%
+%   Example:
+%     dat.saveParamProfile('ChoiceWorld', 'defSet', exp.choiceWorldParams)
+%     profiles = dat.loadParamProfiles('ChoiceWorld');
+%     p = exp.Parameters(profiles.defSet);
+%   
+% See also DAT.SAVEPARAMPROFILE, DAT.PATHS
 %
 % Part of Rigbox
 

+dat/saveParamProfile.m

@@ -1,38 +1,49 @@
 function saveParamProfile(expType, profileName, params)
 %DAT.SAVEPARAMPROFILE Stores the named parameters for experiment type
-%   TODO
-%     - Figure out how to save struct without for-loop in 2016b!
+%   Saves a parameter structure in a MAT file called 'parameterProfiles'.
+%   Each field of this struct is an expType, and each nested field
+%   is the set name.  Parameters of a given expType can be loaded using the
+%   DAT.LOADPARAMPROFILES function.
+%
+%   Inputs:
+%     expType (char): The name of the experiment type, e.g. ChoiceWorld.
+%     profileName (char): The name of the parameter set being saved.  If
+%       the name already exists in the file for a given expType, it is
+%       overwritten.
+%     params (struct): A parameter structure to be saved.
+%
+%   Example:
+%     dat.saveParamProfile('ChoiceWorld', 'defSet', exp.choiceWorldParams)
+%     profiles = dat.loadParamProfiles('ChoiceWorld');
+%     p = exp.Parameters(profiles.defSet);
+%   
+% See also DAT.LOADPARAMPROFILES, DAT.PATHS
+%
 % Part of Rigbox
 
 % 2013-07 CB created
 % 2017-02 MW adapted to work in 2016b
 
-%path to repositories
+% If main repo folders don't exist yet, create them
+repos = dat.reposPath('main');
+cellfun(@mkdir, repos(~file.exists(repos)))
+
+% Path to repository files
 fn = 'parameterProfiles.mat';
-repos = fullfile(dat.reposPath('main'), fn);
+repos = fullfile(repos, fn);
 
-%load existing profiles for specified expType
+% Load existing profiles for specified expType
 profiles = dat.loadParamProfiles(expType);
-%add (or replace) the params with a field named by profile
+% Add (or replace) the params with a field named by profile
 profiles.(profileName) = params;
-%wrap in a struct for saving
+% Wrap in a struct for saving
 set = struct;
 set.(expType) = profiles;
 
-%save the updated set of profiles to each repos
-%where files exist already, append
-% cellfun(@(p) save(p, '-struct', 'set', '-append'),
-% file.filterExists(repos, true)); % Had to change her to a for loop, sorry
-% Chris!
-p = file.filterExists(repos, true);
-for i = 1:length(p)
-    save(p{i}, '-struct', 'set', '-append')
-end
-%and any that don't we should create from scratch
-p = file.filterExists(repos, false);
-for i = 1:length(p)
-    save(p{i}, '-struct', 'set')
-end
-% cellfun(@(p) save(p, '-struct', 'set'), file.filterExists(repos, false));
+% Save the updated set of profiles to each repos where files exist already,
+% append
+saveFn = @(p,name,varargin) save(p, '-struct', 'name', varargin{:});
+cellfun(@(p) saveFn(p, set, '-append') , file.filterExists(repos, true));
 
-end
+% Any that don't we should create from scratch
+cellfun(@(p) saveFn(p, set), file.filterExists(repos, false));

CHANGELOG.md

@@ -24,6 +24,7 @@ Starting after Rigbox 2.2.0, this file contains a curated, chronologically order
 - correct behaviour when listening to already running experiments `32a2a17` 2019-12-18
 - added support for remote error ids in srv.StimulusControl `9d31eea` 2019-11-27
 - added tests for eui.ExpPanel `572463c` 2020-01-28
+- added tests for *paramProfile functions + no error when saving into new repo `72b04fa` 2010-01-30
 
 ## [2.4.1]
 

tests/dat_test.m

@@ -322,6 +322,60 @@ function test_expExists(testCase)
       testCase.verifyTrue(dat.expExists(refs{1}))
     end
 
+    function test_saveParamProfile(testCase)
+      % Test saving files when repo folder doesn't yet exist
+      repos = dat.reposPath('main');
+      rmdir(repos{1}) % Delete local repo
+      
+      % Full path to expected files
+      fn = 'parameterProfiles.mat';
+      repos = fullfile(repos, fn);
+
+      % Test saving some defaults with a given name:
+      name = 'testName';
+      expType = 'ChoiceWorld';
+      dat.saveParamProfile(expType, name, exp.choiceWorldParams)
+      actual = cellfun(@load, repos); % Load from both locations
+      for i = 1:length(actual) % Check saved
+        testCase.verifyEqual(fieldnames(actual(i)), {expType}, 'Failed to append to current file')
+        testCase.verifyEqual(fieldnames(actual(i).(expType)), {name}, 'Failed to save under given name')
+        testCase.verifyEqual(actual(i).(expType).(name).type, expType)
+      end
+      
+      % Test saving another param profile.  Nothing should be overwritten.
+      name = 'another';
+      types = {expType; 'BarMapping'};
+      dat.saveParamProfile(types{end}, name, exp.barMappingParams)
+      actual = cellfun(@load, repos); % Load from both locations
+      for i = 1:length(actual) % Check saved
+        testCase.verifyEqual(fieldnames(actual(i)), types, 'Failed to append to current file')
+        testCase.verifyEqual(fieldnames(actual(i).(types{end})), {name}, 'Failed to save under given name')
+        testCase.verifyEqual(actual(i).(types{end}).(name).type, types{end})
+      end
+    end
+    
+    function test_loadParamProfiles(testCase)
+      % Test loading a specific parameter profile from file
+      fn = 'parameterProfiles.mat';
+      repo = fullfile(dat.reposPath('main', 'master'), fn);
+      
+      name = 'testSet';
+      expType = 'ChoiceWorld';
+      set.(expType).testSet = exp.choiceWorldParams;
+      set.BarMapping.anotherSet = exp.barMappingParams;
+      save(repo, '-struct', 'set')
+      
+      % Test loading existing
+      profiles = dat.loadParamProfiles(expType);
+      testCase.verifyEqual(fieldnames(profiles), {name}, 'Failed to load profile')
+      testCase.verifyEqual(profiles.(name).type, expType)
+      
+      % Test loading non-existing exp type
+      profiles = testCase.verifyWarningFree(@()dat.loadParamProfiles('fake'));
+      expected = isstruct(profiles) && isempty(fieldnames(profiles));
+      testCase.verifyTrue(expected)
+    end
+    
   end
 
   methods (Access = private)