Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Large overhaul, including initial flowchart of the experiment #111

Merged
merged 2 commits into from
Aug 28, 2023

Conversation

oesteban
Copy link
Collaborator

Several interesting features in addition to the flowchart.

  • Preliminary session reorganized to improve readability
  • Removed trailing spaces
  • Added the thanks admonition
  • Used the quote admonition for all verbal exchange scripts in acquisition.

@oesteban oesteban force-pushed the fix/oesteban-revision branch from 495137f to 0e0d390 Compare August 28, 2023 12:35
@oesteban
Copy link
Collaborator Author

This is what the flowchart looks like:

sops_flowchart

It is done with Mermaid, which is an extension for markdown that allows generating charts from code.

You can play with it here

@oesteban oesteban requested review from acionca and esavary August 28, 2023 12:50
Comment on lines 7 to 43
``` mermaid
flowchart TB

subgraph "Scanning Room"
direction TB
sr1[Scanner]
sr2[Cannula]
sr3[RB]
sr4[ECG]
sr5[ET]
end

subgraph "BIOPAC"
direction TB
biopac1[DA100C]
biopac2[ECG100C MRI]
biopac3[AMI100D]
biopac4[STP100D]
end

sr1 --->|Trigger| sb[Syncbox]
sr2 ---> ga[Gas Analyzer]
sr3 --->|"Negative (-)"| biopac1[DA100C]
sr4 ---> biopac2[ECG100C MRI]
sr5 ---> et[Eye Tracker PC]

ga --->|"Channel 3 (CO<sub>2</sub>)"| biopac3
ga --->|"Channel 4 (O<sub>2</sub>)"| biopac3

sb --->|USB| pc1["Stimuli presentation Laptop ({{ secrets.hosts.psychopy | default("███") }})"]
pc1 <--->|Ethernet| et
pc1 --->|USB| modem[MMBT-S Interface]
pc1 --->|HDMI| display[Proyector]
modem --->|25-pin parallel| biopac4

BIOPAC --->|Ethernet| pc2["Physio-recording Laptop ({{ secrets.hosts.acqknowledge | default("███") }})"]
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the new flowchart.

> For this first part, all you have to do is stay still; you can relax and close your eyes if it helps.
>
> Are you ready?
???+ quote "Tell the participant that we are starting"
Copy link
Collaborator Author

@oesteban oesteban Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example of all script blocks changed to a quote admonition block (in this case it is foldable and it is first rendered expanded, as indicated by the ???+ prefix.

Copy link
Contributor

@esavary esavary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I just corrected some typos. I think the position of some images in pre-session. md is wrong, but I'll fix this in a next PR.

docs/data-collection/participant-prep.md Outdated Show resolved Hide resolved
1. **BIOPAC**.
The BIOPAC is the main recording hub.
It directly receives analogical signals from the Scanning Room (for the case of the RB and the ECG).
Indirectly, it receives the analogical signal from the GA, and digital signals from the *Psychopy laptop* ({{ secrets.hosts.psychopy | default("███") }}).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Indirectly, it receives the analogical signal from the GA, and digital signals from the *Psychopy laptop* ({{ secrets.hosts.psychopy | default("███") }}).
Indirectly, it receives the analogical signal from the GA, the triggers from the scanner and digital signals from the *Psychopy laptop* ({{ secrets.hosts.psychopy | default("███") }}).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It actually doesn't receive the trigger from the scanner, it is just one more signal.

@@ -102,15 +103,15 @@
???+ quote "Participant of Cohort II"

Hey [NAME], the next block is a bit long, around 30 minutes.


You can close your eyes and even sleep if you wish.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may need to change this if we record ET data during DWI

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you file a new issue to remind us to change this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, no problem!

docs/data-collection/preliminary.md Outdated Show resolved Hide resolved
@oesteban oesteban requested a review from esavary August 28, 2023 13:42
@oesteban oesteban merged commit df8c787 into mkdocs Aug 28, 2023
@oesteban oesteban deleted the fix/oesteban-revision branch August 28, 2023 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants