Skip to content

Commit

Permalink
[infra] update schema manually
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Feb 4, 2022
1 parent 8315849 commit efb2fee
Show file tree
Hide file tree
Showing 24 changed files with 256 additions and 129 deletions.
1 change: 1 addition & 0 deletions bids-specification
Submodule bids-specification added at e47283
2 changes: 1 addition & 1 deletion schema/objects/associated_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
36 changes: 21 additions & 15 deletions schema/objects/columns.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand All @@ -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"
Expand All @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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"
Expand All @@ -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",
Expand All @@ -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"
},
Expand All @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -524,4 +530,4 @@
}
]
}
}
}
2 changes: 1 addition & 1 deletion schema/objects/datatypes.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@
"name": "Positron Emission Tomography",
"description": "Positron emission tomography data\n"
}
}
}
Loading

0 comments on commit efb2fee

Please sign in to comment.