brainstorm3 icon indicating copy to clipboard operation
brainstorm3 copied to clipboard

Inverse: Unfinished documentation

Open ftadel opened this issue 7 years ago • 6 comments

The tutorial "Source estimation" lacks some details and links. Please review all the sections tagged as TODO. https://neuroimage.usc.edu/brainstorm/Tutorials/SourceEstimation

Some additional things are listed in here: https://neuroimage.usc.edu/brainstorm/Tutorials/Review (when they are addressed, please remove them from this page - we'll delete it when it's empty)

ftadel avatar Nov 28 '18 15:11 ftadel

Questions on the forum indicating a lack of documentation:

  • https://neuroimage.usc.edu/forums/t/basic-understanding-of-noise-covariance-matrix-loreta-and-overlapping-spheres/10459
  • https://neuroimage.usc.edu/forums/t/choice-of-regularization-parameter-in-sloreta/10429/7
  • https://neuroimage.usc.edu/forums/t/best-source-localisation-method-tutorial-vs-literature/10399/3
  • https://neuroimage.usc.edu/forums/t/understanding-source-localization-of-bst-inverse-linear-2018/7529
  • https://neuroimage.usc.edu/forums/t/zeros-in-imaging-kernel-matrix-after-dipole-modeling/8081/5
  • https://neuroimage.usc.edu/forums/t/timewarping-source-results/8006/2
  • https://neuroimage.usc.edu/forums/t/question-about-the-workflow-of-functional-connectivity-between-rois/7845/2
  • https://neuroimage.usc.edu/forums/t/compute-sources-2018-update/5924/2

ftadel avatar Mar 20 '19 18:03 ftadel

Ping

ftadel avatar Jan 30 '21 09:01 ftadel

Some parts of the tutorials still require @jcmosher edits... (pending since 2018)

ftadel avatar Sep 19 '21 07:09 ftadel

@sbaillet Are you done with the review of the tutorials? We'll close this issue when you think the result is satisfying.

ftadel avatar Apr 18 '22 14:04 ftadel

@sbaillet I discovered this morning that you had changed all the titles of the source estimation tutorial. As explained before, this breaks links in the forum, in the website, and in the application. I reverted the modifications for some of the H2 and H3 titles which were only cosmetic.

  • https://neuroimage.usc.edu/brainstorm/Tutorials/SourceEstimation?action=diff&rev1=385&rev2=382

I kept only the changes that implied some semantic modification and did not have any link in the Brainstorm code. For example, I kept the renaming of "Source map normalization" into "Standardization of source maps". For this, I had to search and edit 13 forum posts and 2 wiki pages:

  • https://neuroimage.usc.edu/forums/search?q=https%3A%2F%2Fneuroimage.usc.edu%2Fbrainstorm%2FTutorials%2FSourceEstimation%23Standardization_of_source_maps
  • https://neuroimage.usc.edu/brainstorm/Tutorials/SourceEstimation?action=fullsearch&context=180&titlesearch=0&value=%22Standardization_of_source_maps%22

ftadel avatar Jun 08 '22 10:06 ftadel

@sbaillet @jcmosher There are still some TODO blocks in the documentation, so I will keep this issue open.

ftadel avatar Jun 08 '22 10:06 ftadel