From 7708479671e066a31462b8f1bd8f053848aecfba Mon Sep 17 00:00:00 2001
From: Marc Lalancette <31040756+Moo-Marc@users.noreply.github.com>
Date: Tue, 21 Jul 2020 15:09:50 -0400
Subject: [PATCH] Clarify when ses-<label> is optional

Update to the entity table.
It's actually required in some cases, and not to be used in others.  It's never really optional...
---
 src/99-appendices/04-entity-table.md | 36 +++++++++++++++-------------
 1 file changed, 19 insertions(+), 17 deletions(-)

diff --git a/src/99-appendices/04-entity-table.md b/src/99-appendices/04-entity-table.md
index ade3287c11..98d4e3a193 100644
--- a/src/99-appendices/04-entity-table.md
+++ b/src/99-appendices/04-entity-table.md
@@ -13,20 +13,22 @@ A general introduction to entities is given in the section on
 | Entity                                                                                         | Subject       | Session       | Task           | Acquisition   | Contrast Enhancing Agent | Reconstruction | Phase-Encoding Direction | Run           | Corresponding modality | Echo           | Recording           | Processed (on device) | Space           | Split           |
 | :--------------------------------------------------------------------------------------------- | :------------ | :------------ | :------------- | :------------ | :----------------------- | :------------- | :----------------------- | :------------ | :--------------------- | :------------- | :------------------ | :-------------------- | :---------------| :-------------- |
 | Format                                                                                         | `sub-<label>` | `ses-<label>` | `task-<label>` | `acq-<label>` | `ce-<label>`             | `rec-<label>`  | `dir-<label>`            | `run-<index>` | `mod-<label>`          | `echo-<index>` | `recording-<label>` | `proc-<label>`        | `space-<label>` | `split-<index>` |
-| anat<br>(T1w T2w T1rho T1map T2map T2star FLAIR FLASH PD PDmap PDT2 inplaneT1 inplaneT2 angio) | REQUIRED      | OPTIONAL      |                | OPTIONAL      | OPTIONAL                 | OPTIONAL       |                          |               |                        |                |                     |                       |                 |                 |
-| anat<br>(defacemask)                                                                           | REQUIRED      | OPTIONAL      |                | OPTIONAL      | OPTIONAL                 | OPTIONAL       |                          |               | OPTIONAL               |                |                     |                       |                 |                 |
-| func<br>(bold cbv phase sbref events)                                                          | REQUIRED      | OPTIONAL      | REQUIRED       | OPTIONAL      | OPTIONAL                 | OPTIONAL       | OPTIONAL                 | OPTIONAL      |                        | OPTIONAL       |                     |                       |                 |                 |
-| func<br>(physio stim)                                                                          | REQUIRED      | OPTIONAL      | REQUIRED       | OPTIONAL      |                          | OPTIONAL       |                          | OPTIONAL      |                        |                | OPTIONAL            | OPTIONAL              |                 |                 |
-| dwi<br>(dwi bvec bval)                                                                         | REQUIRED      | OPTIONAL      |                | OPTIONAL      |                          |                | OPTIONAL                 | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| fmap<br>(phasediff phase1 phase2 magnitude1 magnitude2 magnitude fieldmap)                     | REQUIRED      | OPTIONAL      |                | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| fmap<br>(epi)                                                                                  | REQUIRED      | OPTIONAL      |                | OPTIONAL      | OPTIONAL                 |                | REQUIRED                 | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| beh<br>(events stim physio)                                                                    | REQUIRED      | OPTIONAL      | REQUIRED       |               |                          |                |                          |               |                        |                |                     |                       |                 |                 |
-| meg<br>                                                                                        | REQUIRED      | OPTIONAL      | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     | OPTIONAL              |                 | OPTIONAL        |
-| eeg<br>                                                                                        | REQUIRED      | OPTIONAL      | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| ieeg<br>                                                                                       | REQUIRED      | OPTIONAL      | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| channels<br>(meg/eeg/ieeg)                                                                     | REQUIRED      | OPTIONAL      | REQUIRED       |               |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
-| headshape<br>(meg)                                                                             | REQUIRED      | OPTIONAL      |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
-| markers<br>(meg)                                                                               | REQUIRED      | OPTIONAL      | OPTIONAL       | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
-| photo<br>(meg/eeg/ieeg)                                                                        | REQUIRED      | OPTIONAL      |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       |                 |                 |        
-| electrodes<br>(eeg/ieeg)                                                                       | REQUIRED      | OPTIONAL      |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
-| events<br>(meg/eeg/ieeg)                                                                       | REQUIRED      | OPTIONAL      | REQUIRED       |               |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |        
+| anat<br>(T1w T2w T1rho T1map T2map T2star FLAIR FLASH PD PDmap PDT2 inplaneT1 inplaneT2 angio) | REQUIRED      | REQUIRED*     |                | OPTIONAL      | OPTIONAL                 | OPTIONAL       |                          |               |                        |                |                     |                       |                 |                 |
+| anat<br>(defacemask)                                                                           | REQUIRED      | REQUIRED*     |                | OPTIONAL      | OPTIONAL                 | OPTIONAL       |                          |               | OPTIONAL               |                |                     |                       |                 |                 |
+| func<br>(bold cbv phase sbref events)                                                          | REQUIRED      | REQUIRED*     | REQUIRED       | OPTIONAL      | OPTIONAL                 | OPTIONAL       | OPTIONAL                 | OPTIONAL      |                        | OPTIONAL       |                     |                       |                 |                 |
+| func<br>(physio stim)                                                                          | REQUIRED      | REQUIRED*     | REQUIRED       | OPTIONAL      |                          | OPTIONAL       |                          | OPTIONAL      |                        |                | OPTIONAL            | OPTIONAL              |                 |                 |
+| dwi<br>(dwi bvec bval)                                                                         | REQUIRED      | REQUIRED*     |                | OPTIONAL      |                          |                | OPTIONAL                 | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| fmap<br>(phasediff phase1 phase2 magnitude1 magnitude2 magnitude fieldmap)                     | REQUIRED      | REQUIRED*     |                | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| fmap<br>(epi)                                                                                  | REQUIRED      | REQUIRED*     |                | OPTIONAL      | OPTIONAL                 |                | REQUIRED                 | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| beh<br>(events stim physio)                                                                    | REQUIRED      | REQUIRED*     | REQUIRED       |               |                          |                |                          |               |                        |                |                     |                       |                 |                 |
+| meg<br>                                                                                        | REQUIRED      | REQUIRED*     | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     | OPTIONAL              |                 | OPTIONAL        |
+| eeg<br>                                                                                        | REQUIRED      | REQUIRED*     | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| ieeg<br>                                                                                       | REQUIRED      | REQUIRED*     | REQUIRED       | OPTIONAL      |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| channels<br>(meg/eeg/ieeg)                                                                     | REQUIRED      | REQUIRED*     | REQUIRED       |               |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |
+| headshape<br>(meg)                                                                             | REQUIRED      | REQUIRED*     |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
+| markers<br>(meg)                                                                               | REQUIRED      | REQUIRED*     | OPTIONAL       | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
+| photo<br>(meg/eeg/ieeg)                                                                        | REQUIRED      | REQUIRED*     |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       |                 |                 |        
+| electrodes<br>(eeg/ieeg)                                                                       | REQUIRED      | REQUIRED*     |                | OPTIONAL      |                          |                |                          |               |                        |                |                     |                       | OPTIONAL        |                 |
+| events<br>(meg/eeg/ieeg)                                                                       | REQUIRED      | REQUIRED*     | REQUIRED       |               |                          |                |                          | OPTIONAL      |                        |                |                     |                       |                 |                 |        
+
+\*The session entity is REQUIRED when the session level is present in the folder structure.  It MUST NOT be used otherwise.