From efb2fee5dc030afe700121b0936e88a06aede1a0 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 4 Feb 2022 17:39:16 +0100 Subject: [PATCH] [infra] update schema manually --- bids-specification | 1 + schema/objects/associated_data.json | 2 +- schema/objects/columns.json | 36 +++--- schema/objects/datatypes.json | 2 +- schema/objects/entities.json | 24 ++-- schema/objects/metadata.json | 169 +++++++++++++++------------- schema/objects/modalities.json | 2 +- schema/objects/suffixes.json | 2 +- schema/objects/top_level_files.json | 2 +- schema/rules/associated_data.json | 2 +- schema/rules/datatypes/anat.json | 3 +- schema/rules/datatypes/beh.json | 2 +- schema/rules/datatypes/dwi.json | 21 +++- schema/rules/datatypes/eeg.json | 20 +++- schema/rules/datatypes/fmap.json | 2 +- schema/rules/datatypes/func.json | 2 +- schema/rules/datatypes/ieeg.json | 20 +++- schema/rules/datatypes/meg.json | 21 +++- schema/rules/datatypes/micr.json | 2 +- schema/rules/datatypes/perf.json | 21 +++- schema/rules/datatypes/pet.json | 21 +++- schema/rules/entities.json | 4 +- schema/rules/modalities.json | 2 +- schema/rules/top_level_files.json | 2 +- 24 files changed, 256 insertions(+), 129 deletions(-) create mode 160000 bids-specification diff --git a/bids-specification b/bids-specification new file mode 160000 index 000000000..e47283a26 --- /dev/null +++ b/bids-specification @@ -0,0 +1 @@ +Subproject commit e47283a268f20b98d5c05ad1bb8c63da3d2a1ceb diff --git a/schema/objects/associated_data.json b/schema/objects/associated_data.json index f656e79d4..ad6f6f003 100644 --- a/schema/objects/associated_data.json +++ b/schema/objects/associated_data.json @@ -15,4 +15,4 @@ "name": "Stimulus files", "description": "The stimulus files can be added in a `/stimuli` folder\n(under the root folder of the dataset; with optional subfolders)\nAND using a stim_file column in *_events.tsv mentioning which stimulus file was\nused for a given event.\n\nThere are no restrictions on the file formats of the stimuli files, but they should be\nstored in the `/stimuli` folder.\n" } -} +} \ No newline at end of file diff --git a/schema/objects/columns.json b/schema/objects/columns.json index eafe2f156..bc69e8d92 100644 --- a/schema/objects/columns.json +++ b/schema/objects/columns.json @@ -9,9 +9,15 @@ "description": "The unique label abbreviation\n", "type": "string" }, - "acq_time": { + "acq_time__scans": { "name": "acq_time", - "description": "Acquisition time refers to when the first data point in each run was acquired.\nFurthermore, if this header is provided, the acquisition times of all files that\nbelong to a recording MUST be identical.\n\nDatetime should be expressed as described in [Units](/02-common-principles.html#units).\n\nFor anonymization purposes all dates within one subject should be shifted by a randomly\nchosen (but consistent across all recordings) number of days.\nThis way relative timing would be preserved, but chances of identifying a person based\non the date and time of their scan would be decreased.\nDates that are shifted for anonymization purposes SHOULD be set to the year 1925 or earlier\nto clearly distinguish them from unmodified data.\nNote that some data formats do not support arbitrary recording dates.\nFor example, the [EDF](https://www.edfplus.info/)\ndata format can only contain recording dates after 1985.\nShifting dates is RECOMMENDED, but not required.\n", + "description": "Acquisition time refers to when the first data point in each run was acquired.\nFurthermore, if this header is provided, the acquisition times of all files\nfrom the same recording MUST be identical.\nDatetime format and their anonymization are described in [Units](/02-common-principles.html#units).\n", + "type": "string", + "format": "datetime" + }, + "acq_time__sessions": { + "name": "acq_time", + "description": "Acquisition time refers to when the first data point of the first run was acquired.\nDatetime format and their anonymization are described in [Units](/02-common-principles.html#units).\n", "type": "string", "format": "datetime" }, @@ -50,7 +56,7 @@ }, "duration": { "name": "duration", - "description": "Duration of the event (measured from onset) in seconds.\nMust always be either zero or positive (or `\"n/a\"` if unavailable).\nA \"duration\" value of zero implies that the delta function or event is so\nshort as to be effectively modeled as an impulse.\n", + "description": "Duration of the event (measured from onset) in seconds.\nMust always be either zero or positive (or `n/a` if unavailable).\nA \"duration\" value of zero implies that the delta function or event is so\nshort as to be effectively modeled as an impulse.\n", "anyOf": [ { "type": "number", @@ -108,7 +114,7 @@ }, "hemisphere": { "name": "hemisphere", - "description": "The hemisphere in which the electrode is placed, one of `['L' or 'R']` (MUST be in upper-case).\n", + "description": "The hemisphere in which the electrode is placed.\n", "type": "string", "enum": [ "L", @@ -177,7 +183,7 @@ }, "material": { "name": "material", - "description": "Material of the electrode (for example, `\"Tin\"`, `\"Ag/AgCl\"`, `\"Gold\"`).\n", + "description": "Material of the electrode (for example, `Tin`, `Ag/AgCl`, `Gold`).\n", "type": "string" }, "metabolite_parent_fraction": { @@ -244,7 +250,7 @@ }, "plasma_radioactivity": { "name": "plasma_radioactivity", - "description": "Radioactivity in plasma, in unit of plasma radioactivity (for example, `\"kBq/mL\"`).\n", + "description": "Radioactivity in plasma, in unit of plasma radioactivity (for example, `kBq/mL`).\n", "type": "number" }, "reference__eeg": { @@ -254,7 +260,7 @@ }, "reference__ieeg": { "name": "reference", - "description": "Specification of the reference (for example, 'mastoid', 'ElectrodeName01', 'intracranial', 'CAR', 'other', 'n/a').\nIf the channel is not an electrode channel (for example, a microphone channel) use `n/a`.\n", + "description": "Specification of the reference (for example, `mastoid`, `ElectrodeName01`, `intracranial`, `CAR`, `other`, `n/a`).\nIf the channel is not an electrode channel (for example, a microphone channel) use `n/a`.\n", "anyOf": [ { "type": "string" @@ -274,7 +280,7 @@ }, "response_time": { "name": "response_time", - "description": "Response time measured in seconds.\nA negative response time can be used to represent preemptive responses and\n\"n/a\" denotes a missed response.\n", + "description": "Response time measured in seconds.\nA negative response time can be used to represent preemptive responses and\n`n/a` denotes a missed response.\n", "anyOf": [ { "type": "number", @@ -301,7 +307,7 @@ }, "sample_type": { "name": "sample_type", - "description": "Biosample type defined by\n[ENCODE Biosample Type](https://www.encodeproject.org/profiles/biosample_type).\nOne of: `\"cell line\"`, `\"in vitro differentiated cells\"`, `\"primary cell\"`, `\"cell-free sample\"`,\n`\"cloning host\"`, `\"tissue\"`, `\"whole organisms\"`, `\"organoid\"`, or `\"technical sample\"`.\n", + "description": "Biosample type defined by\n[ENCODE Biosample Type](https://www.encodeproject.org/profiles/biosample_type).\n", "type": "string", "enum": [ "cell line", @@ -358,7 +364,7 @@ }, "software_filters": { "name": "software_filters", - "description": "List of temporal and/or spatial software filters applied\n(for example, \"SSS\", `\"SpatialCompensation\"`).\nNote that parameters should be defined in the general MEG sidecar .json file.\nIndicate `n/a` in the absence of software filters applied.\n", + "description": "List of temporal and/or spatial software filters applied\n(for example, `SSS`, `SpatialCompensation`).\nNote that parameters should be defined in the general MEG sidecar .json file.\nIndicate `n/a` in the absence of software filters applied.\n", "anyOf": [ { "type": "string" @@ -378,7 +384,7 @@ }, "status": { "name": "status", - "description": "Data quality observed on the channel.\nMust be one of: `good`, `bad`, or `n/a` (when quality is unknown).\nA channel is considered `bad` if its data quality is compromised by excessive noise.\nDescription of noise type SHOULD be provided in `[status_description]`.\n", + "description": "Data quality observed on the channel.\nA channel is considered `bad` if its data quality is compromised by excessive noise.\nIf quality is unknown, then a value of `n/a` may be used.\nDescription of noise type SHOULD be provided in `[status_description]`.\n", "type": "string", "enum": [ "good", @@ -393,7 +399,7 @@ }, "stim_file": { "name": "stim_file", - "description": "Represents the location of the stimulus file (such as an image, video, or\naudio file) presented at the given onset time.\nThere are no restrictions on the file formats of the stimuli files,\nbut they should be stored in the `/stimuli` folder\n(under the root folder of the dataset; with optional subfolders).\nThe values under the `stim_file` column correspond to a path relative to\n`/stimuli`.\nFor example `\"images/cat03.jpg\"` will be translated to `\"/stimuli/images/cat03.jpg\"`.\n", + "description": "Represents the location of the stimulus file (such as an image, video, or\naudio file) presented at the given onset time.\nThere are no restrictions on the file formats of the stimuli files,\nbut they should be stored in the `/stimuli` folder\n(under the root folder of the dataset; with optional subfolders).\nThe values under the `stim_file` column correspond to a path relative to\n`/stimuli`.\nFor example `images/cat03.jpg` will be translated to `/stimuli/images/cat03.jpg`.\n", "type": "string", "format": "stimuli_relative" }, @@ -416,7 +422,7 @@ }, "trial_type": { "name": "trial_type", - "description": "Primary categorisation of each trial to identify them as instances of the\nexperimental conditions.\nFor example: for a response inhibition task, it could take on values \"go\" and\n\"no-go\" to refer to response initiation and response inhibition experimental\nconditions.\n", + "description": "Primary categorisation of each trial to identify them as instances of the\nexperimental conditions.\nFor example: for a response inhibition task, it could take on values `go` and\n`no-go` to refer to response initiation and response inhibition experimental\nconditions.\n", "type": "string" }, "trigger": { @@ -496,7 +502,7 @@ }, "whole_blood_radioactivity": { "name": "whole_blood_radioactivity", - "description": "Radioactivity in whole blood samples,\nin unit of radioactivity measurements in whole blood samples (for example, `\"kBq/mL\"`).\n", + "description": "Radioactivity in whole blood samples,\nin unit of radioactivity measurements in whole blood samples (for example, `kBq/mL`).\n", "type": "number" }, "x": { @@ -524,4 +530,4 @@ } ] } -} +} \ No newline at end of file diff --git a/schema/objects/datatypes.json b/schema/objects/datatypes.json index 93130f511..8cfaa3dc9 100644 --- a/schema/objects/datatypes.json +++ b/schema/objects/datatypes.json @@ -43,4 +43,4 @@ "name": "Positron Emission Tomography", "description": "Positron emission tomography data\n" } -} +} \ No newline at end of file diff --git a/schema/objects/entities.json b/schema/objects/entities.json index 246f4b4ce..7ca178239 100644 --- a/schema/objects/entities.json +++ b/schema/objects/entities.json @@ -2,14 +2,14 @@ "acquisition": { "name": "Acquisition", "entity": "acq", - "description": "The `acq-