add comments

Author: Remi-Gau

.gitignore

@@ -8,3 +8,4 @@
 *.tsv
 *.mat
 
+check_my_code_report.txt

tests/test_createFilename.m

@@ -1,9 +1,10 @@
 function test_createFilename()
-
 % test for filename creation and their directories
 
 %% check directory and filename creation (PC)
 
+%%% set up part
+
 expParameters.subjectGrp = '';
 expParameters.subjectNb = 1;
 expParameters.sessionNb = 1;
@@ -14,32 +15,40 @@ function test_createFilename()
 cfg.eyeTracker = false;
 cfg.device = 'PC';
 
+% set up the output directories
 outputDir = fullfile(fileparts(mfilename('fullpath')), '..', 'output');
+expParameters.outputDir = outputDir;
 
 behDir = fullfile(outputDir, 'source', 'sub-001', 'ses-001', 'beh');
 eyetrackerDir = fullfile(outputDir, 'source', 'sub-001', 'ses-001', 'eyetracker');
 
-expParameters.outputDir = outputDir;
 expParameters = checkCFG(cfg,expParameters);
-
 expParameters = createFilename(cfg,expParameters);
 
+%%% test part
+
+% make sure the beh dir is created
 assert(exist(behDir, 'dir')==7)
 
 % make sure the eyetracker dir is not created
-assert(exist(eyetrackerDir, 'dir')==0) 
+assert(exist(eyetrackerDir, 'dir')==0)
 
+% make sure the events filename is created
 assert(strcmp(...
-              expParameters.fileName.events, ...
-              ['sub-001_ses-001_task-testtask_run-001_events_date-' expParameters.date '.tsv']));
+    expParameters.fileName.events, ...
+    ['sub-001_ses-001_task-testtask_run-001_events_date-' expParameters.date '.tsv']));
+
+% make sure the stim filename is created
 assert(strcmp(...
-              expParameters.fileName.stim, ...
-              ['sub-001_ses-001_task-testtask_run-001_stim_date-' expParameters.date '.tsv']));
-          
+    expParameters.fileName.stim, ...
+    ['sub-001_ses-001_task-testtask_run-001_stim_date-' expParameters.date '.tsv']));
+
 %% check directory and filename creation (fMRI and eye tracker)
 
 clear
 
+%%% set up part
+
 expParameters.subjectGrp = 'ctrl';
 expParameters.subjectNb = 2;
 expParameters.sessionNb = 2;
@@ -58,13 +67,21 @@ function test_createFilename()
 expParameters = checkCFG(cfg,expParameters);
 expParameters = createFilename(cfg,expParameters);
 
+%%% test part
+
+% make sure the func dir is created
 assert(exist(funcDir, 'dir')==7)
+
+% make sure the eyetracker dir is created
 assert(exist(eyetrackerDir, 'dir')==7)
+
+% make sure the events filename is created
 assert(strcmp(expParameters.fileName.base, 'sub-ctrl002_ses-002_task-testtask'))
 assert(strcmp(...
-              expParameters.fileName.events, ...
-              ['sub-ctrl002_ses-002_task-testtask_run-002_events_date-' expParameters.date '.tsv']));
-          
+    expParameters.fileName.events, ...
+    ['sub-ctrl002_ses-002_task-testtask_run-002_events_date-' expParameters.date '.tsv']));
+
+% make sure the eyetracker filename is created
 assert(strcmp(...
-              expParameters.fileName.eyetracker, ...
-              ['sub-ctrl002_ses-002_task-testtask_run-002_eyetrack_date-' expParameters.date '.edf']));
+    expParameters.fileName.eyetracker, ...
+    ['sub-ctrl002_ses-002_task-testtask_run-002_eyetrack_date-' expParameters.date '.edf']));

tests/test_saveEventsFile.m

@@ -19,15 +19,13 @@ function test_saveEventsFile()
 expParameters = checkCFG(cfg,expParameters);
 expParameters = createFilename(cfg,expParameters);
 
-
-
 %% create the events and stim files
 
 logFile = saveEventsFile('open', expParameters, [], 'Speed', 'is_Fixation');
 
 stimFile = saveEventsFile('open_stim', expParameters, []);
 
-% ---- test section
+%%% test section
 
 fileName = fullfile(expParameters.outputDir, expParameters.modality, expParameters.fileName.events);
 stimFileName = fullfile(expParameters.outputDir, expParameters.modality, expParameters.fileName.stim);
@@ -60,23 +58,27 @@ function test_saveEventsFile()
 
 saveEventsFile('save', expParameters, logFile, 'speed', 'is_fixation');
 
-
 % close the file
 saveEventsFile('close', expParameters, logFile);
 
-
-% ---- test section
+%%% test section
 
 % check the extra columns of the header and some of the content
 
 FID = fopen(fileName, 'r');
 C = textscan(FID,'%s%s%s%s%s','Delimiter', '\t', 'EndOfLine', '\n');
 
-assert(isequal(C{4}{1}, 'speed')); % check header
+% check header
+assert(isequal(C{4}{1}, 'speed')); 
+
+% check that empty values are entered as NaN
+assert(isequal(C{4}{2}, 'NaN')); 
 
-assert(isequal(C{4}{2}, 'NaN')); % check that empty values are entered as NaN
-assert(isequal(C{4}{4}, 'NaN')); % check that missing fields are entered as NaN
+% check that missing fields are entered as NaN
+assert(isequal(C{4}{4}, 'NaN')); 
 
-assert(isequal(str2double(C{4}{3}), 2)); % check values entered properly
+% check values entered properly
+assert(isequal(str2double(C{4}{3}), 2)); 
 
-assert(isequal(str2double(C{5}{4}), 3)); % check values entered properly
+% check values entered properly
+assert(isequal(str2double(C{5}{4}), 3));