Skip to content

Commit 3f9b1d3

Browse files
committed
update doc and add input checks for saveEventsFile
1 parent b1b4e28 commit 3f9b1d3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

saveEventsFile.m

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@
44
% INPUTS
55
%
66
% logFile:
7+
% When you want to save your data logFile contains the data you want to save.
8+
% The logFile variable that contains the n events you want to % save must be a nx1 structure.
9+
% Each field will be saved in a separate column.
10+
%
11+
% example:
12+
% logFile(1,1).onset = 2;
13+
% logFile(1,1).trial_type = 'motion_up';
14+
% logFile(1,1).duration = 1;
15+
% logFile(1,1).speed = 2;
16+
% logFile(1,1).is_fixation = true;
17+
%
18+
% logFile(2,1).onset = 3;
19+
% logFile(2,1).trial_type = 'static';
20+
% logFile(2,1).duration = 4;
21+
% logFile(2,1).is_fixation = 3;
22+
%
23+
%
24+
% logFile:
725
% When you want to save your data logFile contains the data you want to save.
826
% The logFile variable that contains the n events you want to % save must be a nx1 structure.
927
% Each field will be saved in a separate column.
@@ -27,6 +45,7 @@
2745
% into this file.
2846
% This creates the header with the obligatory 'onset', 'trial_type', 'duration' required bt BIDS and other
2947
% coluns can be specified in varargin.
48+
%
3049
% example : logFile = saveEventsFile('open', expParameters, [], 'direction', 'speed', 'target');
3150
%
3251
% - 'save': will save the data contained in logfile by using the file ID logFile.fileID;

0 commit comments

Comments
 (0)