This is a Wiki page documenting dummy data and metadata. We want to demonstrate what information is important to include next to a data index. There are many variations possible to a Filenaming Convention. The recommendation is to follow standards available in the field or to adapt them if needed, preferrably after discussing it with colleagues. We provide general guidelines in our CRS Primer on [File Naming conventions](https://zenodo.org/records/10091967). An example of a domain-specific standard is [Brain Imaging Data Structure - BIDS](https://bids-standard.github.io/bids-starter-kit/folders_and_files/files.html).
The following schema was used in our dummy dataset (there is no real meaning to the different values and labels, but they are based on the type of information you may find in some imaging data). There are also some parts of the filename that are not present in all filenames and which content may vary accross files, as it often happens with real data.
The following schema was used in our dummy dataset (there is no real meaning to the different values and labels, but they are based on the type of information you may find in some imaging data). There are also some parts of the filename that are not present in all filenames and for which the content may vary accross files, as it often happens with real data.
## Filenaming convention
_\<value\>_ indicates this is a required _value_; _\<(value)\>_ _value_ in brackets are optional and may not appear in every file name; _str_ refers to strings; _num_ to numeric values.
_\<value\>_ indicates that this is a required _value_; _\<(value)\>_ _value_ in brackets are optional and may not appear in every file name; _str_ refers to strings; _num_ to numeric values.
#### Convention
`DS<DummySubjectID>_stat<status>_<number of scans>-<(desc)>_slc<slice><.ext>`
`DS<DummySubjectID>_stat<status>_<number of scans>-<(description)>_slc<slice><.ext>`
#### Label description
...
...
@@ -26,7 +26,7 @@ _\<value\>_ indicates this is a required _value_; _\<(value)\>_ _value_ in brack
`scanID`: _num_, scan number (e.g., 1scan or scan1)
`desc`: OPTIONAL _str | num_, some files have additional description of number of scans, recording times, anatomy, state, version, etc. (e.g., DS09_statA_20scan-ph1-Int_002_slc1234.jpg). Ph = phase, Int = intra, V1-N = version 1-N
`description`: OPTIONAL _str | num_, some files have additional descriptions of number of scans, recording times, anatomy, state, version, etc. (e.g., DS09_statA_20scan-ph1-Int_002_slc1234.jpg). Ph = phase, Int = intra, V1-N = version 1-N
`seq`: _num_, sequence number in the scanning session (e.g., 003)
...
...
@@ -36,7 +36,7 @@ _\<value\>_ indicates this is a required _value_; _\<(value)\>_ _value_ in brack
## Folder organization
#### Data folders (not shared in this hub)
#### Data folders
Note: each data package may follow different filename conventions (see corresponding ORD wiki section)
