Skip to content
This repository has been archived by the owner on Jun 24, 2022. It is now read-only.

How to structure the manifest metadata file

bvhpatel edited this page Jul 22, 2020 · 11 revisions

Background

SODA helps you generate the manifest metadata files automatically. We explain here how it must be structured according to the SPARC rules in order to provide some insight about the structure of the file generated by SODA.

How to

  • Format: the manifest file is accepted in either xlsx, csv, or json format. SODA generates it in the xlsx format based on the template provided by the Curation Team.

  • Location in the dataset: a manifest file is required in either 1) each of the high-level SPARC folders or 2) in each of the dataset folders with at least one file. SODA follows the structure #1 when generating the manifest files automatically for you.

  • Content: The "filename" and "timestamp" fields are mandatory and it is suggested to provide other fields as needed to understand each file.

    • Filename, structure #1: In structure #1, this should be path to the files relative to the high-level SPARC folder where the manifest file is located. For e.g, it would be "sub-1\ses-1\anat\anat-1-1.txt" for a manifest file located in the primary folder. Note that the extension of the file is included.
    • Filename, structure #2: In structure #2, this should be the name of the files located in the folder where the manifest file is located. For e.g., it would be "anat-1-1.txt" for a manifest file located under "sub-1\ses-1\anat" in the primary folder. Note that the extension of the file is included.
    • Timestamp: The last time the file was modified preferably in ISO format with UTC offset. For example, this would be "2019-07-13T02:43:14+05:30" for a file last modified on July 13th 2019 at 2:43 AM (14 seconds) in PST (thus +5:30 to show the offset from UTC).
    • File type: Type of this file. Would be '.txt' or 'Text file' for the file anat-1-1.txt.
Clone this wiki locally