Open jcohenadad opened 2 years ago
From my understanding, we have the freedom of using this custom field. Most field in the json sidecar files are recommended and very few are required. I think that the bids-validator doesn't check the contents of it.
Thanks @alexfoias for the clarification.
I think you are right. I was under the impression that additional "non-standardized" metadata fields were prohibited but I did not find anything preventing it in the spec. Moreover, the BIDS-validator does not raise errors (nor warnings) for the unstandardized fields at the moment.
Metadata
field is not an issue for validation.sub-userXX
method in sct-testing-large
. In the case of Microscopy, to be BIDS-compliant, the JSON would need to have at least the PixelSize
and PixelSizeUnits
fields in addition of the custom Metadata
field, as they are both always REQUIRED.As a reference, I found this about how to deal with "unstandardized" data and metadata in the spec. It does not name JSON metadata specifically but I think it applies:
Knowing all that, here are some thoughts, feel free to disregard if not appropriate:
Metadata
is pretty generic and I would recommend using a more specific name, ex: NeuropolyMetadata
, so it is clear that it is not standardized.Metadata
field into columns of the participants.tsv
file.The name Metadata is pretty generic and I would recommend using a more specific name, ex: NeuropolyMetadata, so it is clear that it is not standardized.
+1
Currently, for data shared by users, we add the following info in the JSON. Example:
This might not be BIDS-compliant, therefore we need to address this limitation and find a solution.