Merge pull request #2106 from bclenet/spec-refac

[ENH] Reorganise modality agnostic files section into multiple pages

Author: effigies

mkdocs.yml

@@ -5,7 +5,11 @@ nav:
   - The BIDS Specification:
       - Introduction: introduction.md
       - Common principles: common-principles.md
-      - Modality agnostic files: modality-agnostic-files.md
+      - Modality agnostic files:
+          - Dataset description: modality-agnostic-files/dataset-description.md
+          - Data summary files: modality-agnostic-files/data-summary-files.md
+          - Phenotypic and assessment data: modality-agnostic-files/phenotypic-and-assessment-data.md
+          - Code: modality-agnostic-files/code.md
       - Modality specific files:
           - Magnetic Resonance Imaging: modality-specific-files/magnetic-resonance-imaging-data.md
           - Magnetoencephalography: modality-specific-files/magnetoencephalography.md
@@ -132,7 +136,8 @@ plugins:
       redirect_maps:
         "01-introduction.md": "introduction.md"
         "02-common-principles.md": "common-principles.md"
-        "03-modality-agnostic-files.md": "modality-agnostic-files.md"
+        "03-modality-agnostic-files.md": "modality-agnostic-files/dataset-description.md"
+        "modality-agnostic-files.md": "modality-agnostic-files/dataset-description.md"
         "04-modality-specific-files/01-magnetic-resonance-imaging-data.md": "modality-specific-files/magnetic-resonance-imaging-data.md"
         "04-modality-specific-files/02-magnetoencephalography.md": "modality-specific-files/magnetoencephalography.md"
         "04-modality-specific-files/03-electroencephalography.md": "modality-specific-files/electroencephalography.md"

src/CHANGES.md

@@ -625,7 +625,7 @@
 ## 1.0.1-rc1
 
 -   Added T1 Rho maps: [4.1 Anatomy imaging data](modality-specific-files/magnetic-resonance-imaging-data.md#anatomy-imaging-data).
--   Added support for phenotypic information split into multiple files: [3.2 Participant key file](modality-agnostic-files.md#participants-file).
+-   Added support for phenotypic information split into multiple files: [3.2 Participant key file](modality-agnostic-files/data-summary-files.md#participants-file).
 -   Added recommendations for multi site datasets.
 -   Added `SoftwareVersions`.
 -   Added `run-<run_index>` to the phase encoding maps. Improved the description.

src/appendices/meg-file-formats.md

@@ -212,7 +212,7 @@ entity to indicate each part.
 If there are multiple parts of a recording and the optional `scans.tsv` is provided,
 remember to list all files separately in `scans.tsv` and that the entries
 for the `acq_time` column in `scans.tsv` MUST all be identical, as described in
-[Scans file](../modality-agnostic-files.md#scans-file).
+[Scans file](../modality-agnostic-files/data-summary-files.md#scans-file).
 
 Example:
 

src/appendices/qmri.md

@@ -314,7 +314,7 @@ and a guide for using macros can be found at
 ### Metadata requirements for qMRI maps
 
 As qMRI maps are stored as derivatives, they are subjected to the metadata requirements of
-[derived datasets](../modality-agnostic-files.md#derived-dataset-and-pipeline-description).
+[derived datasets](../modality-agnostic-files/dataset-description.md#derived-dataset-and-pipeline-description).
 
 An example `dataset_description.json` for a qMRI map derivatives directory:
 

src/common-principles.md

@@ -109,7 +109,7 @@ Data for each subject are placed in subdirectories named "`sub-<label>`",
 where string "`<label>`" is substituted with the unique identification
 label of each subject.
 Additional information on each participant MAY be provided in a
-[participants file](modality-agnostic-files.md#participants-file)
+[participants file](modality-agnostic-files/data-summary-files.md#participants-file)
 in the root directory of the dataset.
 
 If data for the subject were acquired across multiple sessions, then within
@@ -119,7 +119,7 @@ label for each session.
 In datasets where at least one subject has more than one session, this
 additional subdirectory later SHOULD be added for all subjects in the dataset.
 Additional information on each session MAY be provided in a
-[sessions file](modality-agnostic-files.md#sessions-file)
+[sessions file](modality-agnostic-files/data-summary-files.md#sessions-file)
 within the subject directory.
 
 Within the session subdirectory (or the subject subdirectory if no
@@ -1144,8 +1144,8 @@ to suppress warnings or provide interpretations of your filenames.
 
 <!-- Link Definitions -->
 
-[dataset-description]: modality-agnostic-files.md#dataset-description
-[dataset_description.json]: modality-agnostic-files.md#dataset_descriptionjson
-[derived-dataset-description]: modality-agnostic-files.md#derived-dataset-and-pipeline-description
+[dataset-description]: modality-agnostic-files/data-summary-files.md
+[dataset_description.json]: modality-agnostic-files/data-summary-files.md#dataset_descriptionjson
+[derived-dataset-description]: modality-agnostic-files/data-summary-files.md#derived-dataset-and-pipeline-description
 [deprecated]: #definitions
 [uris]: #uniform-resource-indicator

src/derivatives/introduction.md

@@ -129,7 +129,7 @@ for GIFTI files.
 
 [storage]: ../common-principles.md#storage-of-derived-datasets
 
-[derived-dataset-description]: ../modality-agnostic-files.md#derived-dataset-and-pipeline-description
+[derived-dataset-description]: ../modality-agnostic-files/dataset-description.md#derived-dataset-and-pipeline-description
 
 [gifti]: https://www.nitrc.org/projects/gifti/
 

src/longitudinal-and-multi-site-studies.md

@@ -3,7 +3,7 @@
 Multiple sessions (visits) are encoded by adding an extra layer of directories
 and [filenames](common-principles.md#filenames)
 in the form of a session (for example `ses-<label>`) and
-with a [`*_sessions.tsv` file](modality-agnostic-files.md#sessions-file).
+with a [`*_sessions.tsv` file](modality-agnostic-files/data-summary-files.md#sessions-file).
 
 <!-- This block generates a file tree.
 A guide for using macros can be found at