diff --git a/src/02-common-principles.md b/src/02-common-principles.md index ca238fa64c..5e1379b163 100644 --- a/src/02-common-principles.md +++ b/src/02-common-principles.md @@ -265,6 +265,10 @@ However, in the case that these data are to be included: Alternatively one can organize their data in the following way + {{ MACROS___make_filetree_example( { "my_dataset-1": { @@ -360,6 +364,10 @@ Derivatives can be stored/distributed in two ways: Example of a derivative dataset including the raw dataset as source: + {{ MACROS___make_filetree_example( { "my_processed_data": { @@ -461,6 +469,12 @@ Note that if a field name included in the data dictionary matches a column name then that field MUST contain a description of the corresponding column, using an object containing the following fields: + {{ MACROS___make_metadata_table( { "LongName": "OPTIONAL", @@ -592,6 +606,10 @@ Corollaries: Example 1: Demonstration of inheritance principle + {{ MACROS___make_filetree_example( { "sub-01": { @@ -635,6 +653,10 @@ absence in the metadata file at the lower level (rule 5.b; corollary 3). Example 2: Impermissible use of multiple metadata files at one directory level (rule 4) + {{ MACROS___make_filetree_example( { "sub-01": { @@ -656,6 +678,10 @@ Example 2: Impermissible use of multiple metadata files at one directory level ( Example 3: Modification of filesystem structure from Example 2 to satisfy inheritance principle requirements + {{ MACROS___make_filetree_example( { "sub-01": { @@ -676,6 +702,10 @@ principle requirements Example 4: Single metadata file applying to multiple data files (corollary 2) + {{ MACROS___make_filetree_example( { "sub-01": { @@ -823,6 +853,10 @@ This is an example of the directory and file structure. Because there is only on session, the session level is not required by the format. For details on individual files see descriptions in the next section: + {{ MACROS___make_filetree_example( { "sub-control01": { diff --git a/src/03-modality-agnostic-files.md b/src/03-modality-agnostic-files.md index 014e5e6726..82bdc20af0 100644 --- a/src/03-modality-agnostic-files.md +++ b/src/03-modality-agnostic-files.md @@ -14,6 +14,12 @@ Templates: The file `dataset_description.json` is a JSON file describing the dataset. Every dataset MUST include this file with the following fields: + {{ MACROS___make_metadata_table( { "Name": "REQUIRED", @@ -99,6 +105,12 @@ top level of every derived dataset: In contrast to raw BIDS datasets, derived BIDS datasets MUST include a `GeneratedBy` key: + {{ MACROS___make_metadata_table( { "GeneratedBy": "REQUIRED" @@ -209,6 +221,12 @@ Commonly used *optional* columns in `participants.tsv` files are `age`, `sex`, of these columns, and in case that you do use them, we RECOMMEND to use the following values for them: + {{ MACROS___make_columns_table( { "participant_id": ("REQUIRED", "There MUST be exactly one row for each participant."), @@ -288,6 +306,12 @@ The purpose of this file is to describe properties of samples, indicated by the This file is REQUIRED if `sample-