Skip to content

Commit

Permalink
plugin update
Browse files Browse the repository at this point in the history
  • Loading branch information
dungscout96 committed Jul 18, 2024
1 parent c5367ba commit ff916b4
Show file tree
Hide file tree
Showing 35 changed files with 102 additions and 24 deletions.
Empty file added code/plugins/update_plugins.sh
Empty file.
3 changes: 3 additions & 0 deletions plugins/ARfitStudio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: ARfitStudio
long_title: ARfitStudio
parent: Plugins
nav_order: 7
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/ARfitStudio).

What is ARfitStudio
-------------------

Expand Down
3 changes: 3 additions & 0 deletions plugins/EEG-BIDS/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: EEG-BIDS
long_title: EEG-BIDS
parent: Plugins
nav_order: 9
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/EEG-BIDS).

![EEG-BIDS](https://github.com/sccn/EEG-BIDS/assets/1872705/47675a55-6573-47d7-abec-48e364d5ad8a)

# EEG-BIDS
Expand Down
3 changes: 3 additions & 0 deletions plugins/ICLabel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: ICLabel
long_title: ICLabel
parent: Plugins
nav_order: 13
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/ICLabel).

# ICLabel
An automatic EEG independent component classifer plugin for EEGLAB.
For more information, see [the ICLabel website tutorial](https://labeling.ucsd.edu/tutorial/about).
Expand Down
3 changes: 3 additions & 0 deletions plugins/NFT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ long_title: NFT
parent: Plugins
categories: plugins
has_children: true
nav_order: 3
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/NFT).

### Open Source Matlab Toolbox for Neuroelectromagnetic Forward Head Modeling

![right](NFTsmall.jpg "wikilink")
Expand Down
3 changes: 3 additions & 0 deletions plugins/NIMA/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: NIMA
long_title: NIMA
parent: Plugins
nav_order: 26
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/NIMA).

NIMA stands for Nima's Images from Measure-projection Analysis. Measure
Projection Toolbox (MPT) is a published method (Bigdely-Shamlo et al.,
2013), and for his wiki page see [this
Expand Down
3 changes: 3 additions & 0 deletions plugins/PACT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ long_title: PACT
parent: Plugins
categories: plugins
has_children: true
nav_order: 4
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/PACT).

What is PACT?
-------------

Expand Down
3 changes: 3 additions & 0 deletions plugins/PACTools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: PACTools
long_title: PACTools
parent: Plugins
nav_order: 17
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/PACTools).

[![GitHub stars](https://img.shields.io/github/stars/sccn/PACTools?color=%235eeb34&logo=GithUb&logoColor=%23fafafa)](https://github.com/sccn/PACTools/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/sccn/PACTools?color=%23b3d9f5&logo=GitHub)](https://github.com/sccn/PACTools/network)
[![GitHub issues](https://img.shields.io/github/issues/sccn/PACTools?color=%23fa251e&logo=GitHub)](https://github.com/sccn/PACTools/issues)
Expand Down
3 changes: 3 additions & 0 deletions plugins/PowPowCAT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: PowPowCAT
long_title: PowPowCAT
parent: Plugins
nav_order: 16
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/PowPowCAT).

Presentation slides (Click the cat to download)
=================================================
<a href="images/PowPowCAT_31stEEGLABWorkshop.pdf" class="image fit"><img src="images/PowPowCAT_logo.png" alt=""></a>
Expand Down
2 changes: 1 addition & 1 deletion plugins/SIFT/Chapter-7.-Statistics-in-SIFT.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The **EEG.CAT.Stats** structure should store statistics computed by these functi

Another current method to compute statistics is to export the connectivity matrices stored in the CAT substructure of the EEG dataset. On the MATLAB command line type:

```matlab
```
>> EEG(1).CAT.Conn
ans =
Expand Down
3 changes: 3 additions & 0 deletions plugins/SIFT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ long_title: SIFT
parent: Plugins
categories: plugins
has_children: true
nav_order: 1
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/SIFT).


![700px\|link=](https://github.com/sccn/SIFT/assets/1872705/1abc1d2d-36bb-4cfb-9328-b57a96044f55)

Expand Down
3 changes: 3 additions & 0 deletions plugins/amica/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: amica
long_title: amica
parent: Plugins
nav_order: 19
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/amica).

# Amica
Code for AMICA: Adaptive Mixture ICA with shared component

Expand Down
3 changes: 3 additions & 0 deletions plugins/clean_rawdata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ long_title: clean_rawdata
parent: Plugins
categories: plugins
has_children: true
nav_order: 6
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/clean_rawdata).

Historical Background (01/07/2020 updated)
------------------------------------------

Expand Down
3 changes: 3 additions & 0 deletions plugins/dipfit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: dipfit
long_title: dipfit
parent: Plugins
nav_order: 14
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/dipfit).

Description
=====
DIPFIT is an [EEGLAB](http://eeglab.org) plugin to perform inverse source localization.
Expand Down
3 changes: 3 additions & 0 deletions plugins/eegstats/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: eegstats
long_title: eegstats
parent: Plugins
nav_order: 15
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/eegstats).

# EEGSTATS plugin for EEGLAB

This plugin computes frequency band power, alpha peak frequency, and alpha asymmetry. It uses the [restingIAF](https://github.com/corcorana/restingIAF) MATLAB code for some computation.
Expand Down
3 changes: 3 additions & 0 deletions plugins/fMRIb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: fMRIb
long_title: fMRIb
parent: Plugins
nav_order: 20
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/fMRIb).

THIS REPOSITORY IS LOOKING FOR A MAINTAINER. IF YOU USE THIS TOOL, CONSIDER MAINTAINING IT.

# Introduction
Expand Down
3 changes: 3 additions & 0 deletions plugins/firfilt/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: firfilt
long_title: firfilt
parent: Plugins
nav_order: 27
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/firfilt).

Documentation
-------------
See [this page](https://eeglab.org/others/Firfilt_FAQ.html) or the [paper](https://home.uni-leipzig.de/biocog/eprints/widmann_a2015jneuroscimeth250_34.pdf) for documentation.
Expand Down
3 changes: 3 additions & 0 deletions plugins/get_chanlocs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ long_title: get_chanlocs
parent: Plugins
categories: plugins
has_children: true
nav_order: 2
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/get_chanlocs).

<h3>

<b>*get_chanlocs*: Compute 3-D electrode positions from a 3-D head image
Expand Down
3 changes: 3 additions & 0 deletions plugins/groupSIFT/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: groupSIFT
long_title: groupSIFT
parent: Plugins
nav_order: 11
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/groupSIFT).

[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/jHngHEIsg7Q/0.jpg)](http://www.youtube.com/watch?v=jHngHEIsg7Q)

Click to play the movie on Youtube. This movie shows the first application of *groupSIFT* in Loo et al. (2019) *NeuroImage: Clinical*
Expand Down
3 changes: 3 additions & 0 deletions plugins/imat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ layout: default
title: imat
long_title: imat
parent: Plugins
nav_order: 23
---
To view the plugin source code, please visit the plugin's [GitHub repository](https://github.com/sccn/imat).

# IMAT
Independent Modulator Analysis Toolbox

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ To start the tutorial, launch the *pop_nsg* GUI by clicking **Tools > NSG Tools
<!-- EEGLAB GUI to launch pop_nsg-->

<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/eeglab_nsgtools_menus.jpg" alt="drawing" width="400"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/eeglab_nsgtools_menus.jpg?raw=true" alt="drawing" width="400"/>
</center>


The GUI depicted below will pop up. The GUI can also be invoked from the MATLAB command windows by typing *pop_nsg*.

<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsgguineu.jpg" alt="drawing" width="600"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsgguineu.jpg?raw=true" alt="drawing" width="600"/>
</center>

## Submitting a job to NSG
Expand All @@ -35,7 +35,7 @@ With the exception of the path to the job file, the GUI at this point of the tut

<!-- Defining JOB ID -->
<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsg_job2send.jpg" alt="drawing" width="600"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsg_job2send.jpg?raw=true" alt="drawing" width="600"/>
</center>

After this, you may click the button **Run job on NSG** to submit the job to NSG. But don't do this yet! You may want to test your job submission before that, right?
Expand All @@ -48,7 +48,7 @@ A job can be tested locally on your computer before being submitted to NSG. For

<!-- Job submited -->
<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsg_jobsubmitted.jpg" alt="drawing" width="600"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/pop_nsg_jobsubmitted.jpg?raw=true" alt="drawing" width="600"/>
</center>

## Checking job status periodically
Expand Down Expand Up @@ -84,15 +84,15 @@ EEG files and a wide range of image formats generated as a result of a NSG job c

<!-- Job submited -->
<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/result_explorer1.jpg" alt="drawing" width="700"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/result_explorer1.jpg?raw=true" alt="drawing" width="700"/>
</center>

From this file explorer, navigate (by clicking into) to the folder *TestingEEGLABNSG* to acces the result files.
Then, select e.g. the file *IC_scalp_maps.jpg* and then click the button **Load/plot**. The figure below will pop up. This figure was actually generated as part of our NSG job results (see script *run_ica_nsg.m*).

<!-- topos -->
<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/results_topos.jpg" alt="drawing" width="400"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/results_topos.jpg?raw=true" alt="drawing" width="400"/>
</center>

In a similar way, a *.set* file can be selected and loaded from this interface.
Expand Down
4 changes: 2 additions & 2 deletions plugins/nsgportal/Registering-at-NSG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ grand_parent: Plugins
The first step to using the Open EEGLAB Portal is to create an NSG account [HERE](https://www.nsgportal.org/gest/reg.php) (or by clicking on "Register account" on the NSG home page).

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG11.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG11.png?raw=true" alt="drawing" width="500"/>
</center>

After your account is approved by the NSG team (typically within 2 days), the second step is to enter your NSG user credentials [HERE](https://nsgdev.sdsc.edu:8443/portal2/login!input.action) (else select, "Access NSG portal" on the [NSG home page](http://www.nsgportal.org/)).


<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG2.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG2.png?raw=true" alt="drawing" width="500"/>
</center>
2 changes: 1 addition & 1 deletion plugins/nsgportal/Scheme-of-plug-in-functions-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ grand_parent: Plugins
The figure below shows a scheme of function calls in _nsgportal_. In the plug-in there are two main sets, or layers, of functions designated by the prefix _pop__ and _nsg__. The _pop__ functions open a parameter entry window when called with fewer than the required arguments, else run directly without opening a window. The second class of nsgportal functions with prefix _nsg__ can be called directly from MATLAB command line or from other MATLAB scripts or functions. These functions perform lower-level processing than the pop_ functions. A plug-in function (_eegplugin_nsgportal_) manages the inclusion and appearance of an nsgportal item in the main EEGLAB window menu.

<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/nsgportal_scheme_call.png" alt="drawing" width="1000"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/nsgportal_scheme_call.png?raw=true" alt="drawing" width="1000"/>
</center>
2 changes: 1 addition & 1 deletion plugins/nsgportal/Setting-up-the-plug-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ Generally, all plug-ins in EEGLAB, included *nsgportal*, can be installed follow
Use menu item **Tools > NSG Tools > NSG portal credentials and settings**. Simply enter your NSG user name and user password (see description above on this page). Inputs **NSG key** and **NSG Url** do not need to be modified. The entry **Output folder** is the folder where NSG data will be downloaded.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-Nsgcredentials.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-Nsgcredentials.png?raw=true" alt="drawing" width="500"/>
</center>
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In the plug-in folder you will find two files, [eegplugin_icansg.m](https://git
The second function will be the focus of this tutorial. The aim of the plug-in is to perform ICA decomposition via NSG using one of two implemented decomposition approaches, 'runica' or 'jader', that performs Infomax or JADE ICA decomposition, respectively. If called from the EEGLAB menu by manually selecting the EEGLAB GUI menu item specified in the *eegplugin_icansg* function (see figure below), the plug-in will use the current EEG dataset structure loaded into EEGLAB, and will pop up an option entry window asking which ICA method to use. The figure below shows the *eegplugin_icansg* menu item selected and the *pop_icansg* window popped up as a result.

<center>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/plugin_runicansg.jpg" alt="drawing" width="600"/>
<img src="https://github.com/sccn/nsgportal/blob/master/docs/img/plugin_runicansg.jpg?raw=true" alt="drawing" width="600"/>
</center>

The plug-in pop-function (*pop_icansp*)can also be called from the MATLAB command line; in this case, you may pass as input the EEG dataset structure you want to decompose as well as the decomposition method to apply to the data. The sample code below specifies both the EEG dataset structure to operate on and the ICA decomposition type to apply; it thus will perform ICA decomposition via NSG on the currently loaded (EEG structure) dataset (using *'runica'*) *without* popping up a parameter input window:
Expand Down
20 changes: 10 additions & 10 deletions plugins/nsgportal/Using-the-Open-EEGLAB-Portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,64 +10,64 @@ There will be two approaches to using the Open EEGLAB Portal: either, through it
Start by login into the NSG portal. Once logged in, you may upload a **zipped file** containing 1) an EEGLAB script calling 2) one or more data files by name (they should be in or under the same folder as the script). Then click on the "Data" tab and select "Upload data", then upload a file containing your script and data.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG3.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG3.png?raw=true" alt="drawing" width="500"/>
</center>

You may download a 3.5-MB sample zip file (containing EEG data and a sample script [HERE](https://sccn.ucsd.edu/mediawiki/images/7/7c/Testingeeglabonnsg.zip). Below is its list of contents:

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/200px-NSG32.png" alt="drawing" width="200"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/200px-NSG32.png?raw=true" alt="drawing" width="200"/>
</center>

The EEGLAB script (test.m) in this upload file is shown below ( try minor alterations for testing purposes)

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG33.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG33.png?raw=true" alt="drawing" width="500"/>
</center>

Now create a new NSG task. To do this, click on the "Task" tab and select, "Create new task." Click on, "Select input data" and select the zip file you have uploaded above. Click on "Select tool" and select "EEGLAB".

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG4.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG4.png?raw=true" alt="drawing" width="500"/>
</center>

Then click on "Select parameters". Enter the name of your script. This script must be at the root (top) folder of your zip archive. You may also (optionally) change other NSG settings on this page.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG5.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG5.png?raw=true" alt="drawing" width="500"/>
</center>

Finally, press "Save parameters". This will bring you back to the previous screen. You may now press, "Save and Run Task" which will enter the task into the Comet queue. A warning is shown as in the image below. Simply click OK.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/300px-NSG6_add.png" alt="drawing" width="350"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/300px-NSG6_add.png?raw=true" alt="drawing" width="350"/>
</center>

Once the task has been run, you will receive an email from NSG (see email for the test job below).


<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG6_3.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG6_3.png?raw=true" alt="drawing" width="500"/>
</center>

Upon receiving this message, go back to the NSG interface and select the task you ran from the list of tasks, as shown below.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG6.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG6.png?raw=true" alt="drawing" width="500"/>
</center>

Select "View" following the heading "Output" (see above): this will bring the output below.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG7.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG7.png?raw=true" alt="drawing" width="500"/>
</center>

You may now download the task output, a zip file containing the results of your task. Output files (see listing below) include the Matlab log and error log for your task. If your script saved data files, they will be there. For example, if you use the zip file and script provided above, below (left) is what the unzipped output archive will contain. The figure below (right) is the .jpg image created by the test.m script. Saving output images in Matlab .fig format (instead of .jpg) will allow you to read them into Matlab (for further editing, etc.). Note: The numeric data plotted in a figure can be read from the .fig file structure as well. Alternatively, saving figures in Postscript (e.g., as .epsc) will allow you to edit them in Illustrator.

Note: To save needless transfer time and effort, the uploaded data file itself will not be returned with the output unless your script explicitly saves it under a new name. In future this will also allow you to temporarily store and reuse the uploaded data.

<center>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG8.png" alt="drawing" width="500"/>
<img src="https://github.com/nucleuscub/pop_nsg_wiki/blob/master/docs/img/500px-NSG8.png?raw=true" alt="drawing" width="500"/>
</center>

### Interact with NSG through command line interface NSG-R and the creation of NSG EEGLAB Plugin
Expand Down
Loading

0 comments on commit ff916b4

Please sign in to comment.