EEGLAB

https://eeglab.org/
Admin
EEGLAB is an open-source MATLAB environment for processing, analyzing, and visualizing human EEG and...
Tokens:182,916
Snippets:2,356
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start EEGLAB

Source: https://eeglab.org/plugins/SIFT/Chapter-5.2.-Loading-and-preparing-the-data.html

Initializes the EEGLAB environment from the MATLAB command prompt.

```matlab
 eeglab
```

--------------------------------

### Install and Clean EEGLAB Plugins

Source: https://eeglab.org/others/Compiled_EEGLAB.html

Script to install required plugins and remove unnecessary folders to optimize the compiled build size.

```matlab
eeglab  % restart the fleshly installed eeglab

% Installing plugins
plugin_askinstall('ANTeepimport', 'eegplugin_eepimport', true);
plugin_askinstall(' Fieldtrip-lite', 'ft_defaults', true);
plugin_askinstall('Fileio', 'ft_read_data', true);
plugin_askinstall('IClabel', 'eegplugin_iclabel', true);
plugin_askinstall('PICARD', 'picard', true);
plugin_askinstall('vised', 'vised', true);
plugin_askinstall('bids-matlab-tools', 'bids_export', true);
plugin_askinstall('bids-validator', 'pop_validatebids', true);
plugin_askinstall('bva-io', 'eegplugin_bva_io', true);
plugin_askinstall('clean_rawdata', 'eegplugin_clean_rawdata', true);
plugin_askinstall('dipfit', 'eegplugin_dipfit', true);
plugin_askinstall('egilegacy', 'eegplugin_egilegacy', true);
plugin_askinstall('firfilt', 'eegplugin_firfilt', true);
plugin_askinstall('iirfilt', 'eegplugin_iirfilt', true);
plugin_askinstall('musedirect', 'eegplugin_musedirect', true);
plugin_askinstall('musemonitor', 'eegplugin_musemonitor', true);
plugin_askinstall('neuroscanio', 'eegplugin_neuroscanio', true);
plugin_askinstall('xdfimport', 'eegplugin_xdfimport', true);
plugin_askinstall('mffmatlabio', 'pop_mffimport', true);
plugin_askinstall('scd', 'eegplugin_scd', true);
plugin_askinstall('snapmaster', 'eegplugin_snapmaster', true);
plugin_askinstall('biosig', 'sread', true);

% Removing clean_rawdata files
% For clean_rawdata, remove folder manopt/reference/m2html.
CleanRawData_folder = fileparts(which('clean_rawdata.m'));
rmdir(fullfile(CleanRawData_folder,'manopt','reference','m2html'), 's');
rmdir(fullfile(CleanRawData_folder,'manopt','tests'), 's');

% Removing ICLabel files
iclabel_folder = fileparts(which('iclabel.m'));
% rmdir(fullfile(iclabel_folder,'matconvnet','examples'), 's'); % not there any more?

% Removing FieldTrip files
% For FieldTrip remove folders compat, external/afni, external/spm8, external/spm12, external/gifti, external/eeglab, external/bemcp and external/npmk
FieldTrip_folder = fileparts(which('ft_defaults.m'));
rmdir(fullfile(FieldTrip_folder,'compat'), 's');
rmdir(fullfile(FieldTrip_folder,'external','afni'), 's');
rmdir(fullfile(FieldTrip_folder,'external','spm8'), 's');
rmdir(fullfile(FieldTrip_folder,'external','spm12'), 's');
rmdir(fullfile(FieldTrip_folder,'external','gifti'), 's');
rmdir(fullfile(FieldTrip_folder,'external','eeglab'), 's');
rmdir(fullfile(FieldTrip_folder,'external','bemcp'), 's');
rmdir(fullfile(FieldTrip_folder,'external','npmk'), 's');
rmdir(fullfile(FieldTrip_folder,'external','signal'), 's');
rmdir(fullfile(FieldTrip_folder,'external','mffmatlabio'), 's');
rmdir(fullfile(FieldTrip_folder,'external','egi_mff_v2'), 's');
```

--------------------------------

### Install and load Octave packages

Source: https://eeglab.org/others/Running_EEGLAB_on_Octave

Commands to install and load necessary toolboxes for EEGLAB functionality on Linux or macOS. Note that signal and statistics packages must be reloaded upon each Octave startup.

```bash
pkg install -forge control
pkg install -forge signal
pkg load signal
pkg install -forge io
pkg install -forge statistics
pkg load statistics
```

--------------------------------

### Install clean_rawdata plugin

Source: https://eeglab.org/tutorials/misc/EEGLAB_and_EMG_data.html

Install the clean_rawdata extension via the EEGLAB GUI or command line.

```matlab
% From EEGLAB menu: File > Manage EEGLAB extensions
% Search for 'clean_rawdata' and install

% Or from command line:
plugin_askinstall('clean_rawdata');
```

--------------------------------

### Install Python dependencies

Source: https://eeglab.org/plugins/MFF-matlab-io/6.-Use-with-Python-%26-MNE.html

Install the required oct2py and mne packages via pip.

```bash
pip install oct2py
pip install mne
```

--------------------------------

### Verify plugin installation in MATLAB

Source: https://eeglab.org/others/EEGLAB_Extensions.html

Displays the expected output in the MATLAB command line when a plugin is successfully loaded during EEGLAB startup.

```matlab
> eeglab: adding plugin "eegplugin_myplugin" % (see >> help eegplugin_myplugin)
```

--------------------------------

### Basic EEGLAB Scripting Example

Source: https://eeglab.org/tutorials/11_Scripting/Using_EEGLAB_history.html

A comprehensive script demonstrating standard data loading, filtering, re-referencing, and epoching steps as captured from the EEGLAB history.

```matlab
%% Getting started with EEGLAB history
% The line below was added by us to locate data files
eeglab_path = fileparts(which('eeglab.m'));

% Start eeglab
[ALLEEG EEG CURRENTSET ALLCOM] = eeglab;

% Change option to process multiple datasets
pop_editoptions( 'option_storedisk', 0);

% Load the dataset (We modified the path manually here)
EEG = pop_loadset( 'eeglab_data.set', fullfile(eeglab_path, 'sample_data'));

% Load the channel location file, enabling automatic detection of channel file format'; We modified the path manually here
EEG.chanlocs=pop_chanedit(EEG.chanlocs, 'load',{ fullfile(eeglab_path, 'sample_data', 'eeglab_chan32.locs'), 'filetype', 'autodetect'});

% Store the dataset into EEGLAB
[ALLEEG EEG CURRENTSET ] = eeg_store(ALLEEG, EEG);

% High pass filter the data with cutoff frequency of 1 Hz.
EEG = pop_eegfilt( EEG, 1, 0, [], [0]); 

% Below, create a new dataset with the name filtered Continuous EEG Data
[ALLEEG EEG CURRENTSET] = pop_newset(ALLEEG, EEG, CURRENTSET, 'setname', 'filtered Continuous EEG Data');% Now CURRENTSET= 2
EEG = pop_reref( EEG, [], 'refstate',0); % Re-refrence the new dataset

% This might be a good time to add a comment to the dataset.
EEG.comments = pop_comments(EEG.comments,'','Dataset was highpass filtered at 1 Hz and rereferenced.',1);

% You can see the comments stored with the dataset either by typing >> EEG.comments or selecting the menu option Edit->About this dataset.
EEG = pop_epoch( EEG, { 'square' }, [-1 2], 'newname', 'Continuous EEG Data epochs', 'epochinfo', 'yes');

% Extract epochs time-locked to the event - 'square', from 1 second before to 2 seconds after those time-locking events.
% Now, either overwrite the parent dataset, if you don't need the continuous version any longer, or create a new dataset
%(by removing the 'overwrite', 'on' option in the function call below).
[ALLEEG EEG CURRENTSET] = pop_newset(ALLEEG, EEG, CURRENTSET, 'setname', 'Continuous EEG Data epochs', 'overwrite', 'on');
EEG = pop_rmbase( EEG, [-1000 0]); % Remove baseline

% Add a description of the epoch extraction to EEG.comments.
EEG.comments = pop_comments(EEG.comments,'','Extracted ''square'' epochs [-1 2] sec, and removed baseline.',1);
[ALLEEG EEG] = eeg_store(ALLEEG, EEG, CURRENTSET);  %Modify the dataset in the EEGLAB main window
eeglab redraw % Update the EEGLAB window to view changes
```

--------------------------------

### Define a complex GUI with inputgui

Source: https://eeglab.org/tutorials/contribute/design_plugin.html

This example demonstrates how to define a multi-row GUI layout using geometry and uilist structures, then invoke it with inputgui.

```matlab
    g = [1 0.3 0.6 0.34];
    geometry = { g g g g g g g g [1.025 1.27] [1] [1.2 1 1.2]};
    uilist = { ...
      { 'Style', 'text', 'string', 'Channel number', 'fontweight', 'bold'  } ...
      { 'Style', 'edit', 'string', '1' 'tag' 'chan'} {} {} ...
      ...
      { 'Style', 'text', 'string', 'Time limits [min max] (msec)', 'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'tlimits' } ...
      { 'Style', 'popupmenu', 'string', 'Use 50 time points|Use 100 time points' ...
        'tag' 'ntimesout' 'value' 4} { } ...
      { 'Style', 'text', 'string', 'Frequency limits (Hz)', 'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'freqs'  } ...
      { 'Style', 'popupmenu', 'string', 'Use limits, padding 1|Use limits, padding 2' ...
        'tag' 'nfreqs' }  ...
      { 'Style', 'checkbox', 'string' 'Log spaced' 'value' 0 'tag' 'freqscale' } ...
      ...
      { 'Style', 'text', 'string', 'Baseline limits [min max] (msec) (0->pre-stim.)', ...
        'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', '0' 'tag' 'baseline' } ...
      { 'Style', 'popupmenu',  'string', 'Use divisive baseline|Use standard deviation' ...
        'tag' 'basenorm' } ...
      { 'Style', 'checkbox', 'string' 'No baseline' 'tag' 'nobase' } ...
      { 'Style', 'text', 'string', 'Wavelet cycles [min max/fact] or sequence', ...
        'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', '3 0.5' 'tag' 'cycle' } ...
      { 'Style', 'popupmenu', 'string', 'Use limits|Use actual seq.' 'tag' 'ncycles' } ...
      { 'Style', 'checkbox', 'string' 'Use FFT' 'value' 0 'tag' 'fft' } ...
      { 'Style', 'text', 'string', 'ERSP color limits [max] (min=-max)', ...
        'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'erspmax'} ...
      { 'Style', 'checkbox', 'string' 'see log power (set)' 'tag' 'scale' 'value' 1} ...
      {} ...
      { 'Style', 'text', 'string', 'ITC color limits [max]', 'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'itcmax'} ...
      { 'Style', 'checkbox', 'string' 'plot ITC phase (set)' 'tag' 'plotphase' } {} ...
      { 'Style', 'text', 'string', 'Bootstrap significance level (Ex: 0.01 -> 1%)', ...
        'fontweight', 'bold' } ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'alpha'} ...
      { 'Style', 'checkbox', 'string' 'FDR correct (set)' 'tag' 'fdr' } {} ...
      { 'Style', 'text', 'string', 'Optional newtimef() arguments (see Help)', ...
        'fontweight', 'bold'} ...
      { 'Style', 'edit', 'string', ' ' 'tag' 'options' } ...
      {} ...
      { 'Style', 'checkbox', 'value', 1, 'string', ...
        'Plot Event Related Spectral Power', 'tooltipstring', ...
        'Plot log spectral perturbation image in the upper panel' 'tag' 'plotersp' } ...
      { 'Style', 'checkbox', 'value', 1, 'string', ...
        'Plot Inter Trial Coherence', 'tooltipstring', ...
        'Plot the inter-trial coherence image in the lower panel' 'tag' 'plotitc' } ...
      { 'Style', 'checkbox', 'value', 0, 'string', ...
        'Plot curve at each frequency' 'tag' 'plotcurve' } ...
      };

      [ tmp1 tmp2 strhalt structout ] = inputgui( geometry, uilist, ...
           'pophelp(''pop_newtimef'');', 'Plot channel time frequency -- pop_newtimef()');
```

--------------------------------

### Implement advanced GUI layouts with supergui

Source: https://eeglab.org/tutorials/contribute/design_plugin.html

This example shows how to use the advanced calling format of supergui to define custom geometries for UI elements.

```matlab
  supergui('geom', { {2 2 [0 0] [1 2] } { 2 2 [1 0] [2 1] } { 2 2 [1 1] [2 2] } }, ...
           'uilist', { { 'style' 'listbox' 'string' 'cell 1|cell 2' } ...
                       { 'style' 'checkbox' 'string' 'cell 3' } ...
                       { 'style' 'text' 'string' 'cell 4' } });
```

--------------------------------

### View EEGLAB directory structure

Source: https://eeglab.org/plugins/roiconnect

Displays the expected directory layout for an EEGLAB installation.

```text
eeglab/	 				
├── functions/ 						
├── plugins/ 							
├── sample_data/ 					
├── sample_locs/		
├── tutorial_scripts/						
└── /.../ 					
```

--------------------------------

### Example runlocal.m failure output

Source: https://eeglab.org/others/EEGLAB_test_cases.html

Sample console output showing how the runlocal.m script reports errors encountered during test execution.

```text
function /Users/arno/eeglab-testcases/trunk/unittesting_binary/pop_read_erpss/test_pop_read_erpss.m
    msg Error using ==> read_erpss at 245
 decompresserpss function error (see message above)
 *********************************************
 function /Users/arno/eeglab-testcases/trunk/unittesting_general/unittesting_popfunc/pop_epoch/test_pop_epoch.m
    msg Error using ==> pop_epoch at 123
 ??? Index exceeds matrix dimensions.
 *********************************************
```

--------------------------------

### Displaying job download output in MATLAB

Source: https://eeglab.org/plugins/nsgportal/Creating-and-managing-a-job-from-pop_nsg-GUI.html

Example output displayed in the MATLAB command window after successfully downloading and decompressing job results from NSG.

```text
1  >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-87B63F47681545A482D010776408F82D/output/33777" on NSG..../TestingEEGLABNSG/
2  >> ./TestingEEGLABNSG/IC_scalp_maps.jpg
3  >> ./TestingEEGLABNSG/eeglab_data_epochs_ica.set
4  >> ./TestingEEGLABNSG/run_ica_nsg.m
5  >> ./TestingEEGLABNSG/eeglab_data_ICA_output.set
6  >> ./TestingEEGLABNSG/run_ica_jader_nsg.m
7  >> ./TestingEEGLABNSG/eeglab_data_ICA_output.fdt
8  >> ./TestingEEGLABNSG/eeglab_data_epochs_ica.fdt
9  >> ./scheduler_stderr.txt
10  >> ./scheduler_stdout.txt
11  >> ./stderr.txt
12  >> ./stdout.txt
13  >> Done.
14  >> File downloaded and decompressed in the
15  >> output folder specified in the settings
16  >> 1  >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-87B63F47681545A482D010776408F82D" on NSG...Done.
17  >> Accessing jobs on NSG...Done
```

--------------------------------

### Compact EEGLAB Scripting Example

Source: https://eeglab.org/tutorials/11_Scripting/Using_EEGLAB_history.html

A streamlined version of the EEGLAB script, removing comments and dataset management commands for simpler processing of the current dataset.

```matlab
eeglab_path = fileparts(which('eeglab.m'));
[ALLEEG EEG CURRENTSET ALLCOM] = eeglab;
pop_editoptions( 'option_storedisk', 0);
EEG = pop_loadset( 'eeglab_data.set', fullfile(eeglab_path, 'sample_data')); % We modified the path manually here
EEG.chanlocs=pop_chanedit(EEG.chanlocs, 'load',{ fullfile(eeglab_path, 'sample_data', 'eeglab_chan32.locs'), 'filetype', 'autodetect'});
EEG = pop_eegfilt( EEG, 1, 0, [], [0]); 
EEG = pop_reref( EEG, [], 'refstate',0);
EEG.comments = pop_comments(EEG.comments,'','Dataset was highpass filtered at 1 Hz and rereferenced.',1);
EEG = pop_epoch( EEG, { 'square' }, [-1 2], 'newname', 'Continuous EEG Data epochs', 'epochinfo', 'yes');
EEG = pop_rmbase( EEG, [-1000 0]);
EEG.comments = pop_comments(EEG.comments,'','Extracted ''square'' epochs [-1 2] sec, and removed baseline.',1);
[ALLEEG EEG CURRENTSET] = eeg_store(ALLEEG, EEG, 1);
eeglab redraw 
```

--------------------------------

### Initialize EEGLAB and Load Dataset

Source: https://eeglab.org/tutorials/11_Scripting/Event_Processing_command_line.html

Sets up the EEGLAB environment and loads a sample dataset for processing.

```MATLAB
%% Working with events
eeglab_path = fileparts(which('eeglab.m')); % get EEGLAB path
[ALLEEG EEG CURRENTSET ALLCOM] = eeglab; % start EEGLAB
pop_editoptions( 'option_storedisk', 0); % Change option to process multiple datasets
EEG = pop_loadset( 'eeglab_data.set', fullfile(eeglab_path, 'sample_data')); % load data
```

--------------------------------

### Launch the NFT Toolbox

Source: https://eeglab.org/plugins/NFT/Chapter-01-Getting-Started-with-NFT.html

Enter these commands in the MATLAB command window to initialize the Neuroelectromagnetic Forward Modeling Toolbox.

```matlab
Neuroelectromagnetic_Forward_Modeling_Toolbox
```

```matlab
NFT
```

--------------------------------

### Install Octave on EC2

Source: https://eeglab.org/others/EEGLAB_and_high_performance_computing.html

Command to automatically install Octave on Amazon EC2 nodes using the yum package manager.

```bash
sudo yum –y install octave –enablerepo=epel
```

--------------------------------

### Launch Coregistration GUI

Source: https://eeglab.org/plugins/NFT/NFT-Appendix-B.html

Opens the interface for aligning electrode locations to the scalp mesh.

```matlab
Coregistration() - Produces the GUI for co-registration of electrode locations  
 to the scalp mesh.  

Usage:  
  >> Coregistration(varargin);  

Optional Arguments:  
  ’subjectdir’ - (string) Output folder. The results will be saved  
   in this folder.  
  ’subject’ - (string) Subject name. The subject-specific output files will start  
   with this name.  
  ’session’ - (string) Session name. The file name for registered electrodes will  
   start with this name.
```

--------------------------------

### Segmentation Structure Output

Source: https://eeglab.org/plugins/NFT/Chapter-02-Head-Modeling-from-MR-Images.html

Example of the Matlab structure format for saved segmentation masks.

```matlab
Segm =

         scalpmask: [256x258x257 logical]
         brainmask: [256x258x257 logical]
    outerskullmask: [256x258x257 logical]
    innerskullmask: [256x258x257 logical]
```

--------------------------------

### Clone the course repository

Source: https://eeglab.org/workshops/eeglab_course.html

Use this command to download the course scripts and folder structure from GitHub.

```bash
git clone https://github.com/sccn/EEGLAB_course.git
```

--------------------------------

### Accessing STUDY.cluster data

Source: https://eeglab.org/tutorials/ConceptsGuide/Data_Structures.html

Example of inspecting the contents of a specific cluster within the STUDY structure.

```MATLAB
>> STUDY.cluster(2)

    ans =
        name:       'artifacts'
        parent:     {'ParentCluster 1'}
        child:      {'muscle 4' 'eye 5' 'heart 6'}
        comps:      [6 10 15 23 1 5 20 4 8 11 17 25 3 4 12]
        sets:       [1 1 1 1 2 2 2 3 3 3 3 3 4 4 4]
        algorithm:  {'Kmeans' [2]}
        preclust:   [1x1 struct]
```

--------------------------------

### Launch Time-Frequency Grid GUI

Source: https://eeglab.org/plugins/SIFT/Chapter-6.-Visualization.html

Opens the Interactive Time-Frequency Grid options GUI from the command line.

```matlab
 pop_vis_TimeFreqGrid(EEG);
```

--------------------------------

### Example IMA.precluster Structure

Source: https://eeglab.org/plugins/imat

The structure of the collected spectral templates saved in the subject-specific IMA file.

```text
 templates: [15×229 double]
 IMICindex: [15×2 double]
dipsources: [1×15 struct]
 scalpmaps: [15×67×67 double]
```

--------------------------------

### IMA structure field definition

Source: https://eeglab.org/plugins/imat

Example representation of the fields contained within the IMA structure.

```matlab
             wts: [21×21 double]
             sph: [21×21 double]
         meanpwr: [14×229 double]
         timevec: [1260×1 double]
         freqvec: [1×229 double]
       freqscale: 'log'
         freqlim: [6 120]
            npcs: 21
        complist: [1 2 3 4 5 6 8 9 10 11 17 21 27 38]
           srate: 500
         ntrials: 42
      ntw_trials: 30
         winsize: 0.5000
          eigvec: [1260×21 double]
              pc: [21×3206 double]
        timefreq: [1260×3206 double]
     meanpwrCond: []
     timepntCond: [1×1260 double]
       condition: []
    subjfilename: {'RestEC_S03_ContAMICAdip.set'}
    subjfilepath: {'/Volumes/ExtremeSSD/IMAT_project/IM/PreSTUDY/S03'}
```

--------------------------------

### Initialize MVAR Model Fitting GUI

Source: https://eeglab.org/plugins/SIFT/Chapter-5.4.-Model-Fitting-and-Validation.html

Launches the SIFT MVAR model fitting graphical user interface from the MATLAB command line.

```matlab
EEG = pop_est_fitMVAR(EEG);
```

--------------------------------

### Launch Forward Problem Solution GUI

Source: https://eeglab.org/plugins/NFT/NFT-Appendix-B.html

Opens the interface for generating forward models.

```matlab
Forward_Problem_Solution() - Produces the forward model generation GUI.  

Usage:  
  >> Forward_Problem_Solution(varargin);  

Optional Arguments:  
  ’subjectdir’ - (string) Output folder. The results will be saved in this folder.  
  ’subject’ - (string) Subject name. Subject-specific output files will be saved  
   starting with this name.  
  ’session’ - (string) Session name. Session-specific output files will be saved  
   starting with this name.
```

--------------------------------

### Example STUDY.etc.IMA Structure

Source: https://eeglab.org/plugins/imat

The structure containing cluster indices and distances saved after running the clustering process.

```text
 clustidx: [15×4 double]
 distance: [15×3 double]
```

--------------------------------

### IMA structure fields

Source: https://eeglab.org/plugins/imat

Example of the fields and data types present within a loaded IMA structure.

```matlab
          wts: [21×21 double]
          sph: [21×21 double]
      meanpwr: [14×229 double]
      freqvec: [1×229 double]
      timevec: [2430×1 double]
 timevec_cond: {[30×42 double]  [30×39 double]}
    freqscale: 'log'
      freqlim: [6 120]
         npcs: 21
     complist: [1 2 3 4 5 6 8 9 10 11 17 21 27 38]
        srate: 500
      ntrials: [42 39]
   ntw_trials: 30
      winsize: 0.5000
  epochlength: 6
       eigvec: [2430×21 double]
           pc: [21×3206 double]
     timefreq: [2430×3206 double]
  meanpwrCond: [2×14×229 double]
  timepntCond: {[1×1260 double]  [1×1170 double]}
    condition: {'EC'  'EO'}
    STUDYname: 'RestECEO.study'
STUDYfilepath: '/Volumes/IM/PreSTUDY/S03'
         subj: {'S3'}
 subjfilename: {'RestEC_S03_ContAMICAdip.set'  'RestEO_S03_ContAMICAdip.set'}
 subjfilepath: {'/Volumes/IM/PreSTUDY/S03'  '/Volumes/IM/PreSTUDY/S03'}
     filename: 'S3_RestECEO.ima'
   precluster: [1×1 struct]
```

--------------------------------

### Define STUDY datasetinfo properties

Source: https://eeglab.org/tutorials/ConceptsGuide/Data_Structures.html

Example of assigning condition, group, and trial-specific presentation information to the STUDY.datasetinfo structure.

```matlab
  STUDY.datasetinfo(1).condition = 'a';
  STUDY.datasetinfo(1).group = 'g1';
  STUDY.datasetinfo(1).trialinfo(1).presentation = 'evoked';
  STUDY.datasetinfo(1).trialinfo(2).presentation = 'evoked';
  STUDY.datasetinfo(1).trialinfo(3).presentation = 'evoked';
  STUDY.datasetinfo(1).trialinfo(4).presentation = 'spontaneous1';
  STUDY.datasetinfo(1).trialinfo(5).presentation = 'spontaneous1';
  STUDY.datasetinfo(1).trialinfo(6).presentation = 'spontaneous1';
  STUDY.datasetinfo(1).trialinfo(7).presentation = 'spontaneous2';
  STUDY.datasetinfo(1).trialinfo(8).presentation = 'spontaneous2';
  STUDY.datasetinfo(1).trialinfo(9).presentation = 'spontaneous2';
```

--------------------------------

### NSG job status output log

Source: https://eeglab.org/plugins/nsgportal/Using-pop_nsg-command-line-tools-in-your-EEGLAB-plug-in.html

Example of the console output generated while waiting for an NSG job to complete.

```text
1  >> Scaling components to RMS microvolt
2  >> Saving dataset...
3  >> Job has been submitted!
4  >> Accessing jobs on NSG...Done.
5  >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-1 >> EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
6  >> Accessing jobs on NSG...Done.
7  >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
8  >> Job status on 6-10-2019 15:10:3 : QUEUE
9  >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
10 >> Job status on 6-10-2019 15:11:3 : SUBMITTED
11 >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
12 >> Job status on 6-10-2019 15:12:3 : LOAD_RESULTS
13 >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
14 >> Job status on 6-10-2019 15:13:3 : COMPLETED
15 >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
16 >> ./icansgtmp/
17 >> ./icansgtmp/eeglab_data_epochs_ica.set
18 >> ./icansgtmp/tempdatafile.fdt
19 >> ./icansgtmp/icansg_job.m
20 >> ./icansgtmp/tempdatafile.set
21 >> ./icansgtmp/eeglab_data_epochs_ica.fdt
22 >> ./scheduler_stderr.txt
23 >> ./scheduler_stdout.txt
24 >> ./stderr.txt
25 >> ./stdout.txt
26 >> Done.
27 >> File downloaded and decompressed in the
28 >> output folder specified in the settings
29 >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
30 >> Accessing jobs on NSG...Done.
31 >> Accessing job: "https://nsgr.sdsc.edu:8443/cipresrest/v1/job/ramonmc/NGBW-JOB-EEGLAB_TG-291E9AF9FAB64B918C07259E310A3A78" on NSG...Done.
32 >> Accessing jobs on NSG...Done.
33 >> pop_loadset(): loading file /Users/amon-ra/Downloads/nsgtmp/nsgresults_icansg_tmpjob/icansgtmp/eeglab_data_epochs_ica.set ...
34 >> Reading float file '/Users/amon-ra/Downloads/nsgtmp/nsgresults_icansg_tmpjob/icansgtmp/eeglab_data_epochs_ica.fdt'...
35 >> Scaling components to RMS microvolt
```

--------------------------------

### Accessing Function Help

Source: https://eeglab.org/tutorials/11_Scripting/Using_EEGLAB_history.html

Use the MATLAB command line to view documentation for specific EEGLAB functions.

```matlab
help pop_loadset
help eeg_store
```

--------------------------------

### Interaction Model Covariate File Format

Source: https://eeglab.org/tutorials/10_Group_analysis/advanced_statistics.html

Example of a text file structure for modeling interactions between categorical and continuous variables.

```text
1  0  1  -1
1  0  2  -2
0  1  3  3
0  1  4  4
```

```text
1  -1
2  -2
3  3
4  4
```

--------------------------------

### Launch Mesh Generation GUI

Source: https://eeglab.org/plugins/NFT/NFT-Appendix-B.html

Opens the interface for generating meshes.

```matlab
Mesh_generation() - Produces the mesh generation GUI.  

Usage:  
  >> Mesh_generation(varargin);  

Optional Arguments:  
  ’subjectdir’ - (string) Output folder. The results will be saved  
   in this folder.  
  ’subject’ - (string) Subject name. Output files will start with this name.
```

--------------------------------

### Create a basic GUI with supergui

Source: https://eeglab.org/tutorials/contribute/design_plugin.html

Defines a simple interface with text and a button using horizontal geometry.

```matlab
  supergui( 'geomhoriz', { 1 1 1 }, 'uilist', { ...
         { 'style', 'text', 'string', 'Hello!' }, { }, ...
         { 'style', 'pushbutton' , 'string', 'OK' } } );
```

--------------------------------

### Example output of EEGSTATS

Source: https://eeglab.org/plugins/eegstats

This table displays the output format for frequency band power and alpha metrics generated by the plugin.

```text
All_channels	FPz	EOG1	F3	Fz	F4	EOG2	FC5	FC1	FC2	FC6	T7	C3	C4	Cz	T8	CP5	CP1	CP2	CP6	P7	P3	Pz	P4	P8	PO7	PO3	POz	PO4	PO8	O1	Oz	O2
4.0-6.0 Hz	10.32874	14.22889	9.67149	12.15102	12.52194	11.41491	8.32056	10.92951	12.55692	12.12547	8.74618	9.27780	11.43005	10.23406	11.97217	5.81186	10.17836	11.12828	10.86633	8.35843	8.59615	10.46200	11.01924	9.80405	5.81822	8.94987	10.24260	9.81776	9.67905	7.94379	7.86885	7.36514	7.68011
8.0-12.0 Hz	14.34564	12.88388	8.29599	14.23616	14.09646	13.61207	9.33680	12.95503	14.09473	13.81112	11.21125	11.13318	14.51065	14.45228	14.24638	7.63537	13.54019	15.94191	16.27163	12.39869	12.74183	16.26172	17.82588	15.80787	10.10653	14.83628	17.25089	17.70982	16.13902	13.31741	14.39267	14.11222	14.18022
18.0-22.0 Hz	1.53140	1.74260	0.55711	3.41521	3.20146	2.81724	0.85928	1.97687	3.33149	3.07455	-0.56236	-0.14296	2.92429	1.89127	2.88576	-3.66506	0.96043	2.88402	2.55589	-0.95219	0.18848	2.11160	2.82488	1.41511	-3.05001	1.16790	2.55386	1.59623	1.61312	-0.32435	0.27099	-0.79813	-0.42993
30.0-45.0 Hz	-4.74193	-3.59272	-2.38355	-3.85762	-4.05003	-4.10457	-2.61030	-4.35485	-3.92142	-4.00219	-6.27543	-4.97281	-4.64989	-5.83781	-4.21922	-6.76074	-5.47909	-5.13860	-5.41030	-6.93733	-4.21273	-5.34485	-5.09403	-5.76578	-6.73008	-3.97376	-4.63646	-5.62076	-5.15805	-5.44294	-4.68207	-5.68633	-5.11051
Peak alpha frequency	9.68	8.50	NaN	9.00	8.50	9.00	NaN	9.00	9.00	9.00	9.00	9.50	9.50	9.50	9.50	9.50	9.50	10.00	10.00	10.00	9.50	10.00	10.00	10.00	9.50	9.50	10.00	10.00	10.00	10.00	10.00	10.00	10.00
Alpha center of gravity	9.36	8.65	8.88	8.94	8.87	8.99	8.97	9.12	8.99	9.05	9.14	9.16	9.45	9.46	9.27	9.13	9.44	9.58	9.56	9.44	9.32	9.64	9.72	9.61	9.39	9.58	9.75	9.83	9.70	9.61	9.71	9.74	9.73
Alpha Asymmetry	0.62408
```

--------------------------------

### Navigate to plugins directory

Source: https://eeglab.org/plugins/roiconnect

Command to change the current working directory to the EEGLAB plugins folder.

```bash
cd <eeglab_install_location>/eeglab/plugins
```

--------------------------------

### Set Default Figure Renderer for Ubuntu

Source: https://eeglab.org/others/EEGLAB_hardware_and_software_recommendations.html

Use this command at the start of a MATLAB session on Ubuntu to prevent OpenGL graphics issues.

```matlab
>> set(0,'DefaultFigureRenderer','painters');
```

--------------------------------

### Compute and Bootstrap Contrasts via Command Line

Source: https://eeglab.org/plugins/limo/03.1.-One-way-repeated-measures-ANOVA-Famous-Unfamiliar-Scrambled-faces-as-conditions.html

Use limo_contrast to calculate specific contrasts and perform bootstrapping on the results.

```matlab
% add contrast famous+unfamiliar>scrambled
limo_contrast(fullfile(pwd,'Yr.mat'),fullfile(pwd,'LIMO.mat'), 3 ,[0.5 -1 0.5]); % compute a new contrast
limo_contrast(fullfile(pwd,'Yr.mat'),fullfile(pwd,'LIMO.mat'), 4);               % do the bootstrap of the last contrast
```
Tokens:
Raw