bids-specification icon indicating copy to clipboard operation
bids-specification copied to clipboard

[SCHEMA] BEP017

Open rwblair opened this issue 1 year ago • 1 comments
trafficstars

Schematization attempt based on google doc of BEP017.

Todo:

objects/metadata.yaml

The following entries still need to be added:

  • [ ] AdditionalMatrixDimensions
  • [ ] AdditionalMatrixDimensionDescription
  • [ ] AdditionalMatrixDimensionsUnits
  • [ ] MeasureDescription
  • [ ] MeasurePoint
  • [ ] MeasureUnits
  • [ ] NodeIndicesFile
  • [ ] Serialization

These may be need unique entries or could use built in ones:

  • [ ] Description
  • [ ] Sources

Axes Definition needs to be completed:

  • [ ] schema for objects in array

NodeFiles in google doc is either a uri or a list of uris. I defined it only as an array of uris.

  • [ ] Is that ok?
  • [ ] Should this be a bids-uri?

Every description needs to be filled in:

  • [ ] Replace every Todo I left in descriptions.

objects/columns.yaml

Fill in descriptions:

  • [ ] matrix_index
  • [ ] node_file
  • [ ] node_index

node_file example uses labels for atlas- entities. Should it be the full filename? Or should the shorthand name be defined in the _relmat.json NodeFiles entry?

rules/tabular_data/derivatives/relmat.yaml

  • [ ] Does *_relmat.tsv need an entry here?
  • [ ] Confirm nodeindices entry.

rules/sidecars/derivatives/relmat.yaml

  • [ ] Review requirement levels
  • [ ] Enforce Serialization level_addendum
  • [ ] nodeindices.json Looks to be only fields describing columns. Do we need this? Are there any metadata fields missing?

rules/checks/derivatives/relmat.yaml

  • [ ] Does not currently exist. What requirements in the BEP not covered in metadata and tsv need to be enforced here?

rules/files/derivatives/relmat.yaml

  • [ ] datatypes currently listed as any which isn't valid. Should there be a wildcard datatype? Or should this be filled in explicitly?

meta/associations.yaml

  • [ ] Does _relmat.* need _nodeindices.tsv in its associations for any checks?
  • [ ] Does _nodeindices.tsv need _relmat.json in its associations for any checks?

rwblair avatar Aug 21 '24 18:08 rwblair

Hi @rwblair,

thanks so much for starting to work on this! As I'm not super familiar with the schema and the approach here, I wanted to ask how I should provide feedback/help out? I could, for example, answer some of the questions you raised here.

Best, Peer

PeerHerholz avatar Aug 22 '24 09:08 PeerHerholz