From 7903e507ea58a11b62f43d5cd6528c8cf8995c56 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 26 Oct 2023 12:08:04 +0200 Subject: [PATCH] add todo comments to enums that are still missing a definition --- src/schema/meta/context.yaml | 2 ++ src/schema/objects/columns.yaml | 7 +++++++ src/schema/objects/metadata.yaml | 16 ++++++++++++++++ 3 files changed, 25 insertions(+) diff --git a/src/schema/meta/context.yaml b/src/schema/meta/context.yaml index 20ae418bb2..3f8135aaa8 100644 --- a/src/schema/meta/context.yaml +++ b/src/schema/meta/context.yaml @@ -300,6 +300,7 @@ context: name: 'XYZ Units' description: 'String representing the unit of voxel spacing.' type: string + # TODO: Add definitions for these values. enum: - 'unknown' - 'meter' @@ -309,6 +310,7 @@ context: name: 'Time Unit' description: 'String representing the unit of inter-volume intervals.' type: string + # TODO: Add definitions for these values. enum: - 'unknown' - 'sec' diff --git a/src/schema/objects/columns.yaml b/src/schema/objects/columns.yaml index 89d28a5f09..bcef147c71 100644 --- a/src/schema/objects/columns.yaml +++ b/src/schema/objects/columns.yaml @@ -63,6 +63,7 @@ component: For example, `x`,`y`,`z` for position channels, or `quat_x`, `quat_y`, `quat_z`, `quat_w` for quaternion orientation channels. type: string + # TODO: Add definitions for these values. enum: - x - y @@ -162,6 +163,7 @@ handedness: For "ambidextrous", use one of these values: `ambidextrous`, `a`, `A`, `AMBIDEXTROUS`, `Ambidextrous`. type: string + # TODO: Add definitions for these values. enum: - left - l @@ -424,6 +426,7 @@ sample_type: Biosample type defined by [ENCODE Biosample Type](https://www.encodeproject.org/profiles/biosample_type). type: string + # TODO: Add definitions for these values. enum: - cell line - in vitro differentiated cells @@ -461,6 +464,7 @@ sex: For "other", use one of these values: `other`, `o`, `O`, `OTHER`, `Other`. type: string + # TODO: Add definitions for these values. enum: - male - m @@ -543,6 +547,7 @@ status: If quality is unknown, then a value of `n/a` may be used. Description of noise type SHOULD be provided in `[status_description]`. type: string + # TODO: Add definitions for these values. enum: - good - bad @@ -685,6 +690,7 @@ type__optodes: description: | The type of the optode. type: string + # TODO: Add definitions for these values. enum: - source - detector @@ -730,6 +736,7 @@ volume_type: The `*_aslcontext.tsv` table consists of a single column of labels identifying the `volume_type` of each volume in the corresponding `*_asl.nii[.gz]` file. type: string + # TODO: Add definitions for these values. enum: - control - label diff --git a/src/schema/objects/metadata.yaml b/src/schema/objects/metadata.yaml index d0fa480198..ee5b708b89 100644 --- a/src/schema/objects/metadata.yaml +++ b/src/schema/objects/metadata.yaml @@ -98,6 +98,7 @@ AnatomicalLandmarkCoordinateUnits: description: | Units of the coordinates of `"AnatomicalLandmarkCoordinateSystem"`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -363,6 +364,7 @@ CASLType: description: | Describes if a separate coil is used for labeling. type: string + # TODO: Add definitions for these values. enum: - single-coil - double-coil @@ -488,6 +490,7 @@ ContrastBolusIngredient: Active ingredient of agent. Corresponds to DICOM Tag 0018, 1048 `Contrast/Bolus Ingredient`. type: string + # TODO: Add definitions for these values. enum: - IODINE - GADOLINIUM @@ -534,6 +537,7 @@ DatasetType: The interpretation of the dataset. For backwards compatibility, the default value is `"raw"`. type: string + # TODO: Add definitions for these values. enum: - raw - derivative @@ -609,6 +613,7 @@ DetectorType: - type: string format: unit - type: string + # TODO: Add definitions for these values. enum: - mixed DeviceSerialNumber: @@ -673,6 +678,7 @@ DigitizedHeadPointsCoordinateUnits: description: | Units of the coordinates of `"DigitizedHeadPointsCoordinateSystem"`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -774,6 +780,7 @@ EEGCoordinateUnits: description: | Units of the coordinates of `EEGCoordinateSystem`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -982,6 +989,7 @@ FiducialsCoordinateUnits: Units in which the coordinates that are listed in the field `"FiducialsCoordinateSystem"` are represented. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -1280,6 +1288,7 @@ HeadCoilCoordinateUnits: description: | Units of the coordinates of `HeadCoilCoordinateSystem`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -1803,6 +1812,7 @@ MEGCoordinateUnits: description: | Units of the coordinates of `"MEGCoordinateSystem"`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -2143,6 +2153,7 @@ NIRSCoordinateUnits: description: | Units of the coordinates of `NIRSCoordinateSystem`. type: string + # TODO: Add definitions for these values. enum: - m - mm @@ -2398,6 +2409,7 @@ PixelSizeUnits: Unit format of the specified `"PixelSize"`. MUST be one of: `"mm"` (millimeter), `"um"` (micrometer) or `"nm"` (nanometer). type: string + # TODO: Add definitions for these values. enum: - mm - um @@ -2714,6 +2726,7 @@ RotationOrder: description: | Specify the sequence in which the elemental 3D extrinsic rotations are applied around the three distinct axes. type: string + # TODO: Add definitions for these values. enum: - XYZ - XZY @@ -2730,6 +2743,7 @@ RotationRule: clockwise around an axis when seen from the positive direction (left-hand rule) or counter-clockwise (right-hand rule). Must be one of: "left-hand", "right-hand". type: string + # TODO: Add definitions for these values. enum: - left-hand - right-hand @@ -2754,6 +2768,7 @@ SampleEnvironment: Environment in which the sample was imaged. MUST be one of: `"in vivo"`, `"ex vivo"` or `"in vitro"`. type: string + # TODO: Add definitions for these values. enum: - in vivo - ex vivo @@ -3638,6 +3653,7 @@ iEEGCoordinateUnits: Units of the `*_electrodes.tsv`. MUST be `"pixels"` if `iEEGCoordinateSystem` is `Pixels`. type: string + # TODO: Add definitions for these values. enum: - m - mm