Edit request for the source localization tutorial

Open
#90 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, matlab
Domain
documentation

Research direction

Start by locating the source localization tutorial and review the sections on equivalent dipole localization, source reconstruction, and script downloads. Verify the reported FieldTrip/source-plot warnings and broken links, then apply the requested wording, history, hyperlinks, extension and dataset instructions; done means the tutorial is clearer, its links work, and the documented example runs as described.

Written by the indexing model from the issue text.

Description

Hello,

Kindly see my comments below as was asked for the source localization tutorial:

Suggestions for implementation:

1.    Please consider adding somewhere that Fieldtrip-lite extension must be installed. If not, go to File-> manage EEGLAB extensions and install Fieldtrip-lite.
2.    Please note that while executing the code for figure “5:ft_sourceplot: sourceProj”, I get the following error message:

could not reshape "time" to the dimensions of the volume
Warning: functional data is complex, taking absolute value
Check for incorrect argument data type or missing argument in call to function 'abs'.

Error in ft_sourceplot (line 455)
 fun = abs(fun);

Error in dipfit_example_tutorialtest20230823 (line 89)
figure; ft_sourceplot(cfg, sourceProj);

3.    Please note that while executing the code for the section:
%% Prepare leadfield surface
In the section ‘Performing source reconstruction:’
I get the warning:

Warning: adding C:\Users\d2gupta\Documents\eeglab2022.1\plugins\Fieldtrip-lite20230613\external\gifti toolbox to your MATLAB path
Warning: use cfg.sourcemodel instead of cfg.grid

Cosmetic changes’ suggestions to descriptive for clarity to the reader:

1.    Please consider changing the heading from "Equivalent dipole source localization of EEG data" to "Equivalent dipole source localization of EEG or ERP data"
2.    Positive affirmation first: Please consider changing first line to "EEGLAB provides a command-line implementation of the DIPFIT plugin to fit dipoles to raw ERP or EEG scalp maps that has otherwise not been expressly designed anywhere else including the plugin itself" from "Though the implementation of the DIPFIT plugin has not been expressly designed to fit dipoles to raw ERP or EEG scalp maps, EEGLAB provides a command-line function allowing DIPFIT to do so. "
3.    For giving the beginner an idea about what is DIPFIT as a starter, please consider hyperlinking DIPFIT plugin in the first line to: https://github.com/sccn/dipfit AND https://sccn.ucsd.edu/eeglab/dipfittut/dipfit.htmlold AND https://eeglab.org/tutorials/09_source/DIPFIT.html
4.    Please correct this: The “here” in “Click here to download the script above” is leading to an error message “Notice: Undefined variable: baseurl2 in /var/local/www/html/eeglab/locatefile.php on line 80
File not found”.
5.    Please include the eeglab_data_epochs_ica.set file or the instructions for how to fetch this sample dataset.
6.    In the section “Advanced source reconstruction using DIPFIT/Fieldtrip”:
a.    please make a subsection “History” or “Background” and then in that include the first paragrpah “DIPFIT relies on Fieldtrip, though in fact, DIPFIT was also an ancestor of Fieldtrip: when Robert Oostenveld, the first Fieldtrip developer, decided to release source imaging functions he had developed during his dissertation work, he first packaged them in EEGLAB as DIPFIT. A few years later, when he and his collaborators released Fieldtrip (also running on MATLAB), we reworked DIPFIT so it would use the Fieldtrip functions that Robert and colleagues planned to and have since maintained for use in Fieldtrip. Below is a short tutorial on how to perform source modeling using Fieldtrip applied to data in an EEGLAB dataset.”
b.    Also, one may consider hyperlinking here DIPFIT to the earlier links as highlighted in the above point#3 in this first paragraph of history.
c.    Subsection “Implementation” or “Performing source reconstruction in a volume” could include text from “First, use DIPFIT to align the electrode locations with a head model of choice (menu item Tools → Locate dipoles using DIPFIT → Head model and settings). The resulting DIPFIT information … and so on”
7.    Please correct this: script download link in the section ‘Performing source reconstruction on a surface’ is giving the error: “Notice: Undefined variable: baseurl2 in /var/local/www/html/eeglab/locatefile.php on line 80
File not found”
8.    Please consider perhaps specifying the following tutorial additionally in the relevant section: https://eeglab.org/tutorials/09_source/Model_Settings.html and https://eeglab.org/tutorials/09_source/Custom_head_model.html

I hope the above is helpful
Thanking you
Sincerely
Deepa Gupta

Dominant language
HTML
Stars
7
Forks
20
Avg merge
15m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sccn/sccn.github.io

All issues in sccn/sccn.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.