From 9fec41d708ff285f34756887e66fca611c07f147 Mon Sep 17 00:00:00 2001 From: Mathieu Guay-Paquet Date: Mon, 19 Feb 2024 10:13:29 -0500 Subject: [PATCH] Add file extension to README.md --- data/dataset-curation.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/data/dataset-curation.md b/data/dataset-curation.md index be7e3414..1cd5565b 100644 --- a/data/dataset-curation.md +++ b/data/dataset-curation.md @@ -31,7 +31,7 @@ Useful BIDS specifications are: The example below applies for MRI data: ``` -├── README +├── README.md ├── dataset_description.json ├── participants.tsv ├── participants.json @@ -130,11 +130,11 @@ Only **ONE** suffix can be used within the filename. - etc. -### `README` +### `README.md` -The [`README`](https://bids-specification.readthedocs.io/en/stable/03-modality-agnostic-files.html#readme) is a [markdown](https://markdown-guide.readthedocs.io/en/latest/index.html) file describing the dataset in more detail. +The [`README.md`](https://bids-specification.readthedocs.io/en/stable/03-modality-agnostic-files.html#readme) is a [markdown](https://markdown-guide.readthedocs.io/en/latest/index.html) file describing the dataset in more detail. -Please use the `README` template below: +Please use the `README.md` template below: ``` # @@ -289,7 +289,7 @@ Despite what is written above, to streamline data identification and reduce the Derived datasets follow the **same structure and hierarchy** as the `raw` dataset, with folders corresponding to subjects, [sessions] and MRI modalities: ``` -├── README +├── README.md ├── dataset_description.json ├── participants.tsv ├── participants.json @@ -308,7 +308,7 @@ Entities and suffixes are different from those used with the raw filenames and a ``` ```{note} -Because derived datasets are datasets, files and folders presented in the raw template section could also be included in this dataset (e.g. README, code/, etc.) +Because derived datasets are datasets, files and folders presented in the raw template section could also be included in this dataset (e.g. README.md, code/, etc.) ``` @@ -492,7 +492,7 @@ Here is an example of a dataset structure with a single subject `sub-001`: ``` sci-bordeaux -├── README +├── README.md ├── dataset_description.json ├── participants.tsv ├── participants.json @@ -507,7 +507,7 @@ sci-bordeaux └── derivatives └── labels ├── dataset_description.json - ├── README + ├── README.md └── sub-001 └── anat ├── sub-001_acq-sag_T2w_label-SC_seg.nii.gz # spinal cord (SC) binary segmentation