bids_export_example2.m

% Matlab script to export to BIDS
% Exported dataset is available at https://openneuro.org/datasets/ds003061
%
% You may not use this script because you do not have the original data
% It is provided as an example to be adapted for your specific need
%
% Arnaud Delorme - Feb 2020

% export notes
% export event type problem
% export event value problem
return

clear

data = [];
data(end+1).file = {'../Ref1_12082011/Ref1_12082011_1_256Hz.bdf' '../Ref1_12082011/Ref1_12082011_2_256Hz.bdf' '../Ref1_12082011/Ref1_12082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'She changed push button hands during the experiment (in the middle of trials)' };

data(end+1).file = {'../Ref2_15082011/Ref2_15082011_1_256Hz.bdf' '../Ref2_15082011/Ref2_15082011_2_256Hz.bdf' '../Ref2_15082011/Ref2_15082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'First ~120 seconds did not have push button triggers because the USB cable was not connected' 'She moves around when she s starting to feel sleepy. She said that she was dozing and her head moved from side to side.' 'Had to interrupt the session because she stopped pressing the button during the oddball sounds. She fell asleep in the middle of the experiment.' };

data(end+1).file = {'../Ref3_17082011/Ref3_17082011_1_256Hz.bdf' '../Ref3_17082011/Ref3_17082011_2_256Hz.bdf' '../Ref3_17082011/Ref3_17082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];

data(end+1).file = {'../Ref4_19082011/Ref4_19082011_1_256Hz.bdf' '../Ref4_19082011/Ref4_19082011_2_256Hz.bdf' '../Ref4_19082011/Ref4_19082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'The whole recording was noisy w/ a lot of electrode fluctuations and FP1 and PO4 were noisy. Maybe too much gel' };

data(end+1).file = {'../Ref5_20082011/Ref5_20082011_1_256Hz.bdf' '../Ref5_20082011/Ref5_20082011_2_256Hz.bdf' '../Ref5_20082011/Ref5_20082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];

data(end+1).file = {'../Ref6_20082011/Ref6_20082011_1_256Hz.bdf' '../Ref6_20082011/Ref6_20082011_2_256Hz.bdf' '../Ref6_20082011/Ref6_20082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];

data(end+1).file = {'../Ref7_21082011/Ref7_21082011_1_256Hz.bdf' '../Ref7_21082011/Ref7_21082011_2_256Hz.bdf' '../Ref7_21082011/Ref7_21082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'Very messy recording, the cap was a bit loose on the back of his head, but fitted elsewhere. The electrodes were unstable and fluctuates randomly. He said that he s not moving, but we don t know.' };

data(end+1).file = {'../Ref8_26082011/Ref8_26082011_1_256Hz.bdf' '../Ref8_26082011/Ref8_26082011_2_256Hz.bdf' '../Ref8_26082011/Ref8_26082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];

data(end+1).file = {'../Ref9_28082011/Ref9_28082011_1_256Hz.bdf' '../Ref9_28082011/Ref9_28082011_2_256Hz.bdf' '../Ref9_28082011/Ref9_28082011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];

data(end+1).file = {'../Ref10_08092011/Ref10_08092011_1_256Hz.bdf' '../Ref10_08092011/Ref10_08092011_2_256Hz.bdf' '../Ref10_08092011/Ref10_08092011_4_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { '' '' 'We did a 4th trial because trial 3 recording was not good. This is the 4th, trial 3 is not included' };

data(end+1).file = {'../Ref11_10092011/Ref11_10092011_1_256Hz.bdf' '../Ref11_10092011/Ref11_10092011_2_256Hz.bdf' '../Ref11_10092011/Ref11_10092011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'She had a lot of curly hair and her hair felt oily (despite the fact that she said she didn t put oil today). She could have been moving also.' };
    
data(end+1).file = {'../Ref12_10092011/Ref12_10092011_1_256Hz.bdf' '../Ref12_10092011/Ref12_10092011_2_256Hz.bdf' '../Ref12_10092011/Ref12_10092011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { '' 'Fell asleep in the middle. We had to interrupt the session to wake him up.' '' };

data(end+1).file = {'../Ref13_11092011/Ref13_11092011_1_256Hz.bdf' '../Ref13_11092011/Ref13_11092011_2_256Hz.bdf' '../Ref13_11092011/Ref13_11092011_3_256Hz.bdf'};
data(end  ).session = [1 1 1];
data(end  ).run     = [1 2 3];
data(end  ).notes   = { 'His head is moving. He was sleepy so he yawned a lot. He kept on touching his nose to make sure the eletrode is okay.' };

%% participant information for participants.tsv file
% -------------------------------------------------
pInfo = { 'gender' 'age' 'Ethnicity' 'Air_conditioning';
 'F' 44 'Indian'        'on';
 'F' 32 'Indian'        'on';
 'F' 28 'Non_indian'    'off';
 'M' 35 'Indian'        'off';
 'F' 49 'Non_indian'    'off';
 'F' 27 'Non_indian'    'off';
 'M' 33 'Indian'        'on';
 'M' 35 'Indian'        'off';
 'F' 31 'Non_indian'    'on';
 'M' 24 'Indian'        'on';
 'F' 58 'Indian'        'on';
 'M' 27 'Non_indian'    'on'; 
 'M' 28 'Indian'        'on' };
          
% data(3:end) = [];
% pInfo(4:end,:) = [];

%% Code Files used to preprocess and import to BIDS
% -----------------------------------------------------|
codefiles = { fullfile(pwd, mfilename) fullfile(pwd, 'oddball_psychotoolbox.m') };

% general information for dataset_description.json file
% -----------------------------------------------------
generalInfo.Name = 'P300 sound task';
generalInfo.ReferencesAndLinks = { 'No bibliographic reference other than the DOI for this dataset' };
generalInfo.BIDSVersion = 'v1.2.1';
generalInfo.License = 'CC0';
generalInfo.Authors = {'Arnaud Delorme' };

% participant column description for participants.json file
% ---------------------------------------------------------
pInfoDesc.participant_id.LongName    = 'Participant identifier';
pInfoDesc.participant_id.Description = 'Unique participant identifier';

pInfoDesc.gender.Description = 'Sex of the participant';
pInfoDesc.gender.Levels.M    = 'male';
pInfoDesc.gender.Levels.F    = 'female';

pInfoDesc.age.Description = 'age of the participant';
pInfoDesc.age.Units       = 'years';

pInfoDesc.Air_conditioning.Description = 'Ethnicity of participants';
pInfoDesc.Ethnicity.Levels.Indian        = 'Participant of Indian origin';
pInfoDesc.Ethnicity.Levels.Non_indian    = 'Participant of non-Indian origin (Caucasian, etc...)';

pInfoDesc.Air_conditioning.Description = 'Air Conditioning - could create interference so noted here';
pInfoDesc.Air_conditioning.Levels.on   = 'Air Conditioning was on  - temperature at or below 25C';
pInfoDesc.Air_conditioning.Levels.off  = 'Air Conditioning was off - temperature at or above 25C';

% event column description for xxx-events.json file (only one such file)
% ----------------------------------------------------------------------
eInfo = {'onset'         'latency';
         'sample'        'latency';
         'value'         'type' }; % ADD HED HERE

eInfoDesc.onset.Description = 'Event onset';
eInfoDesc.onset.Units = 'second';

eInfoDesc.response_time.Description = 'Latency of button press after auditory stimulus';
eInfoDesc.response_time.Levels.Units = 'millisecond';

eInfoDesc.trial_type.Description = 'Type of event';
eInfoDesc.trial_type.Levels.stimulus = 'Auditory stimulus';
eInfoDesc.trial_type.Levels.responses = 'Behavioral response';

eInfoDesc.value.Description = 'Value of event';
eInfoDesc.value.Levels.response   = 'Response of the subject';
eInfoDesc.value.Levels.standard   = 'Standard at 500 hz for 60 ms';
eInfoDesc.value.Levels.ignore     = 'Ignore - not a real event';
eInfoDesc.value.Levels.oddball    = 'Oddball at 1000 hz for 60 ms';
eInfoDesc.value.Levels.noise      = 'White noise for 60 ms';

renameTypes = { 'condition 1' 'response';
                'condition 2' 'standard';
                'condition 3' 'ignore';
                'condition 4' 'oddball';
                'condition 8' 'noise' };

trialTypes = { 'condition 1' 'response';
               'condition 2' 'stimulus';
               'condition 3' 'n/a';
               'condition 4' 'stimulus';
               'condition 8' 'stimulus' };

% Content for README file
% -----------------------
README = [ 'Data collection took place at the Meditation Research Institute (MRI) in Rishikesh, India under the supervision of Arnaud Delorme, PhD. The project was approved by the local MRI Indian ethical committee and the ethical committee of the University of California San Diego (IRB project # 090731).' 10 10 ...
'Participants sat either on a blanket on the floor or on a chair for both experimental periods depending on their personal preference. They were asked to keep their eyes closed and all lighting in the room was turned off during data collection. An intercom allowed communication between the experimental and the recording room.' 10 10 ...
'Participants performed three identical sessions of 13 minutes each. 750 stimuli were presented with 70% of them being standard (500 Hz pure tone lasting 60 milliseconds), 15% being oddball (1000 Hz pure tone lasting 60 ms) and 15% being distractors (1000 Hz white noise lasting 60 ms). All sounds took 5 milliseconds to ramp up and 5 milliseconds to ramp down. Sounds were presented at a rate of 1 per second with a random gaussian jitter of standard deviation 25 ms. Participants were instructed to respond to oddball by pressing a key on a keypad that was resting on their lap.' 10 10 ... 
];

% Content for CHANGES file
% ------------------------
CHANGES = sprintf([ 'Version 1.0 - 4 Aug 2020\n' ...
                    ' - Initial release\n' ]);

% Task information for xxxx-eeg.json file
% ---------------------------------------
tInfo.InstitutionAddress = '';
tInfo.InstitutionName = '';
tInfo.InstitutionalDepartmentName = '';
tInfo.PowerLineFrequency = 50;
tInfo.ManufacturersModelName = 'Biosemi Active 2';

% call to the export function
% ---------------------------
targetFolder =  '../BIDS';
bids_export(data, ...
    'targetdir', targetFolder, ...
    'taskName', 'P300',...
    'gInfo', generalInfo, ...
    'pInfo', pInfo, ...
    'pInfoDesc', pInfoDesc, ...
    'eInfo', eInfo, ...
    'eInfoDesc', eInfoDesc, ...
    'README', README, ...
    'CHANGES', CHANGES, ...
    'codefiles', codefiles, ...
    'trialtype', trialTypes, ...
    'chanlookup', '/data/matlab/eeglab/plugins/dipfit/standard_BEM/elec/standard_1005.elc', ...
    'renametype', renameTypes, ...
    'checkresponse', 'condition 1', ...
    'tInfo', tInfo, ...
    'copydata', 1);
% 
% % copy stimuli folder
% % -------------------
copyfile('../stimuli', fullfile(targetFolder, 'stimuli'), 'f');
% copyfile(fullfile(tempFolder, 'sourcedata'), fullfile(targetFolder, 'sourcedata'), 'f');