[electrophysiology_browser] Add help directory and missing docs #6773

h-karim · 2020-06-26T19:55:41Z

Brief summary of changes

I added a help directory with two files, electrophysiology_browser.md and view_session.md for the main page and the individual scan sessions of the module, respectively:

Resolves [EEG Browser] #6676

christinerogers

Hi Karim, I did a first glance review.
Found 2 typos.
Please replace "scan" with "recording" everywhere because... EEG.
Please take a stab at describing briefly the relationships between the Downloads.
BIDS should be mentioned at least once.

modules/electrophysiology_browser/help/electrophysiology_browser.md

modules/electrophysiology_browser/help/view_session.md

Co-authored-by: christinerogers <[email protected]>

christinerogers

Hi Karim, thanks for these updates, could you take another pass to incorporate my points below -
Then, when ready (tomorrow) :
The last step for Help text is to paste a screenshot of how it actually renders. (Make sure both pages render well in the Help dropdown in your browser, and then paste a screenshot of each in this comment thread.)
Then ping me for re-review. thanks!

modules/electrophysiology_browser/help/electrophysiology_browser.md

christinerogers · 2020-06-29T21:19:40Z

modules/electrophysiology_browser/help/view_session.md

+
+Summary information about the candidate, the recording session and the hardware used is displayed.
+
+Recording files can be downloaded individually or as a compressed folder (*All Files* download):


Suggested change

Recording files can be downloaded individually or as a compressed folder (*All Files* download):

File packages can be downloaded containing just the recording signal, the events, or other metadata for this session - or all files compressed together (*All Files* download). These file packages are organized according to the EEG-BIDS standard, and available for download as follows:

This suggestion/change because: the Recordings can't be downloaded "individually", it's the different types of files that are downloadable as packages.

Karim could you take another pass to look closer at the following?

e.g I think "All Files" should be in the bulleted list (ordered according to the buttons you see)

I'm glad you added link for BIDS; instead, let's link the EEG BIDS paper here, the URL is: https://www.nature.com/articles/s41597-019-0104-8

I added "All Files" as part of the list. For the EEG-BIDS link, I created a footer to keep things neat in case more content was added to the file in the future.

modules/electrophysiology_browser/help/view_session.md

Co-authored-by: christinerogers <[email protected]>

h-karim · 2020-06-30T18:47:23Z

Here are the screenshots detailing the final changes:

cc @christinerogers

christinerogers

Hi Karim - good work on this, suggestions below, and I think it's ready to come out of draft stage.
I can review again when ready.

modules/electrophysiology_browser/help/electrophysiology_browser.md

modules/electrophysiology_browser/help/view_session.md

…logy_browser.md Co-authored-by: christinerogers <[email protected]>

Co-authored-by: christinerogers <[email protected]>

christinerogers

Thanks for your work on this Karim -- looks ready to go.

@driusan ready for final review.

Co-authored-by: christinerogers <[email protected]>

driusan · 2020-07-08T12:39:40Z

modules/electrophysiology_browser/help/electrophysiology_browser.md

+
+This module allows you to review and download EEG recordings and metadata.  Downloads are organized according the EEG-BIDS standard. 
+
+The selection filter allows you to narrow down candidate sessions. Clicking on any column headers in the data table to sort the table by that column. Individual sessions can be accessed by clicking on the *raw* (for raw datasets) or *all types* (for all data) links of one of the rows under the links column, which will redirect you to the *View Session* page.


The first 2 sentences violate the help style guide. (The second sentence is also grammatically incorrect.)

My bad, I didn't notice the help style guide, I'll read it and format the files accordingly.

In particular, I was referring to the part "Assume the user is tech-savvy enough to know about features that are intuitive or common across modern platforms, so you don’t need to repeat in every Help text".. the first example it gives it clicking on column headers to sort, but I think filtering in a selection filter also easily meets that criteria.

driusan · 2020-07-08T12:41:58Z

modules/electrophysiology_browser/help/view_session.md

+
+Files can be downloaded containing just the recording signal, the events, or other metadata, or all files compressed together, for the current session. These files are organized according to the EEG-BIDS standard<sup id="1">[1](#f1)</sup>, and are available for download as follows:
+
+- All files (tgz): a compressed folder containingscan all the recording data as well as metadata for the EEG scan session.


This is obviously a typo

driusan · 2020-07-08T12:43:25Z

modules/electrophysiology_browser/help/view_session.md

+
+Summary information about the candidate, the recording session and the hardware used is displayed.
+
+Files can be downloaded containing just the recording signal, the events, or other metadata, or all files compressed together, for the current session. These files are organized according to the EEG-BIDS standard<sup id="1">[1](#f1)</sup>, and are available for download as follows:


Just use a parenthesis to avoid mixing HTML and markdown.

Fixed typos, removed navigation explanation, changed "just" to "only" to makee it alex compliant, renamed view_sessions.md to sessions.md for loris to detect and display content.

christinerogers · 2020-07-13T22:18:28Z

just realized this PR thread never included the requested screenshots

The last step for Help text is to paste a screenshot of how it actually renders. (Make sure both pages render well in the Help dropdown in your browser, and then paste a screenshot of each in this comment thread.)

@h-karim can you do one last check that the line-breaks, bullets, special chars etc render ok in the actual Help Dropdown in your Loris front-end, for both pages? So that any fixes can go in before 23.1 is released - thanks.
(See #6600 for an example)

h-karim · 2020-07-14T14:34:35Z

@christinerogers Checked and added the screenshots to the description of the PR for reference.

…#6773) Add help content to electrophysiology_browser module. Resolves aces#6676

[skip ci] Add help directory and doc for EEG

2d1cffb

h-karim requested a review from christinerogers June 26, 2020 19:55

christinerogers requested changes Jun 26, 2020

View reviewed changes

modules/electrophysiology_browser/help/electrophysiology_browser.md Outdated Show resolved Hide resolved

modules/electrophysiology_browser/help/view_session.md Outdated Show resolved Hide resolved

modules/electrophysiology_browser/help/view_session.md Outdated Show resolved Hide resolved

h-karim and others added 2 commits June 26, 2020 20:28

Fix typos

162072c

Apply suggestions from code review

5ac6548

Co-authored-by: christinerogers <[email protected]>

h-karim force-pushed the 2020-6-26_AddHelpDocsEEG branch from 5af9d64 to 28ed74e Compare June 29, 2020 12:13

[skip ci] Elaborate on different downloads, BIDS

e6b5ec4

h-karim force-pushed the 2020-6-26_AddHelpDocsEEG branch from 28ed74e to e6b5ec4 Compare June 29, 2020 12:16

h-karim requested a review from christinerogers June 29, 2020 12:17

christinerogers requested changes Jun 29, 2020

View reviewed changes

h-karim marked this pull request as draft June 30, 2020 13:00

h-karim and others added 8 commits June 30, 2020 09:01

[skip ci] Reword description

b00bb7e

Co-authored-by: christinerogers <[email protected]>

Elaborate downloads

0304fdb

Co-authored-by: christinerogers <[email protected]>

Remove bottom BIDS description

0891f45

Co-authored-by: christinerogers <[email protected]>

[skip ci] Remove mention of naigation order

deb01ec

Co-authored-by: christinerogers <[email protected]>

[skip ci] Change description of information availability

9c6c341

Co-authored-by: christinerogers <[email protected]>

[skip ci] Reformat

2372626

add footer line

a83a22a

Clarify session

88337c9

h-karim requested a review from christinerogers June 30, 2020 18:47

christinerogers requested changes Jul 3, 2020

View reviewed changes

modules/electrophysiology_browser/help/electrophysiology_browser.md Outdated Show resolved Hide resolved

modules/electrophysiology_browser/help/view_session.md Outdated Show resolved Hide resolved

modules/electrophysiology_browser/help/view_session.md Outdated Show resolved Hide resolved

h-karim and others added 2 commits July 6, 2020 11:44

[skip ci] Update modules/electrophysiology_browser/help/electrophysio…

52ab617

…logy_browser.md Co-authored-by: christinerogers <[email protected]>

[skip ci] Update modules/electrophysiology_browser/help/view_session.md

f5f004a

Co-authored-by: christinerogers <[email protected]>

h-karim marked this pull request as ready for review July 6, 2020 15:45

h-karim requested a review from christinerogers July 6, 2020 15:45

driusan assigned christinerogers and h-karim Jul 7, 2020

christinerogers approved these changes Jul 7, 2020

View reviewed changes

christinerogers added the Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) label Jul 7, 2020

christinerogers added the Passed manual tests PR has been successfully tested by at least one peer label Jul 7, 2020

Update modules/electrophysiology_browser/help/view_session.md

f48cf2f

Co-authored-by: christinerogers <[email protected]>

h-karim force-pushed the 2020-6-26_AddHelpDocsEEG branch from 7ab0abd to f48cf2f Compare July 8, 2020 01:07

driusan requested changes Jul 8, 2020

View reviewed changes

h-karim added 2 commits July 8, 2020 10:39

Fix typos and wording

44deed3

Reformat according to style guide

84dbc2d

Fixed typos, removed navigation explanation, changed "just" to "only" to makee it alex compliant, renamed view_sessions.md to sessions.md for loris to detect and display content.

h-karim requested a review from driusan July 9, 2020 08:16

driusan merged commit 3fed1e7 into aces:master Jul 9, 2020

ridz1208 added this to the 24.0.0 milestone Jul 15, 2020

AlexandraLivadas pushed a commit to AlexandraLivadas/Loris that referenced this pull request Jun 29, 2021

[electrophysiology_browser] Add help directory and missing docs (aces…

ec1c5cd

…#6773) Add help content to electrophysiology_browser module. Resolves aces#6676

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[electrophysiology_browser] Add help directory and missing docs #6773

[electrophysiology_browser] Add help directory and missing docs #6773

h-karim commented Jun 26, 2020 •

edited

Loading

christinerogers left a comment

christinerogers left a comment •

edited

Loading

christinerogers Jun 29, 2020

h-karim Jun 30, 2020

h-karim commented Jun 30, 2020

christinerogers left a comment •

edited

Loading

christinerogers left a comment

driusan Jul 8, 2020

h-karim Jul 8, 2020 •

edited

Loading

driusan Jul 8, 2020

driusan Jul 8, 2020

driusan Jul 8, 2020

christinerogers commented Jul 13, 2020

h-karim commented Jul 14, 2020


		Summary information about the candidate, the recording session and the hardware used is displayed.

		Recording files can be downloaded individually or as a compressed folder (All Files download):

	Recording files can be downloaded individually or as a compressed folder (All Files download):
	File packages can be downloaded containing just the recording signal, the events, or other metadata for this session - or all files compressed together (All Files download). These file packages are organized according to the EEG-BIDS standard, and available for download as follows:


		This module allows you to review and download EEG recordings and metadata. Downloads are organized according the EEG-BIDS standard.

		The selection filter allows you to narrow down candidate sessions. Clicking on any column headers in the data table to sort the table by that column. Individual sessions can be accessed by clicking on the raw (for raw datasets) or all types (for all data) links of one of the rows under the links column, which will redirect you to the View Session page.


		Files can be downloaded containing just the recording signal, the events, or other metadata, or all files compressed together, for the current session. These files are organized according to the EEG-BIDS standard<sup id="1">[1](#f1)</sup>, and are available for download as follows:

		- All files (tgz): a compressed folder containingscan all the recording data as well as metadata for the EEG scan session.

[electrophysiology_browser] Add help directory and missing docs #6773

[electrophysiology_browser] Add help directory and missing docs #6773

Conversation

h-karim commented Jun 26, 2020 • edited Loading

Brief summary of changes

christinerogers left a comment

Choose a reason for hiding this comment

christinerogers left a comment • edited Loading

Choose a reason for hiding this comment

christinerogers Jun 29, 2020

Choose a reason for hiding this comment

h-karim Jun 30, 2020

Choose a reason for hiding this comment

h-karim commented Jun 30, 2020

christinerogers left a comment • edited Loading

Choose a reason for hiding this comment

christinerogers left a comment

Choose a reason for hiding this comment

driusan Jul 8, 2020

Choose a reason for hiding this comment

h-karim Jul 8, 2020 • edited Loading

Choose a reason for hiding this comment

driusan Jul 8, 2020

Choose a reason for hiding this comment

driusan Jul 8, 2020

Choose a reason for hiding this comment

driusan Jul 8, 2020

Choose a reason for hiding this comment

christinerogers commented Jul 13, 2020

h-karim commented Jul 14, 2020

h-karim commented Jun 26, 2020 •

edited

Loading

christinerogers left a comment •

edited

Loading

christinerogers left a comment •

edited

Loading

h-karim Jul 8, 2020 •

edited

Loading