Road to community review - Top priorities

[bclenet]

Here is a list of actions left to be done before BEP028 enters community review:

• desc entity:
  - include in the spec that : descriptions.tsv and desc-<label> can be used in the prov/ dir
  - desc-<label> not only dedicated to derivative data.
  - check if compliant with this section
• [examples] propose an example for manual annotated provenance
• [spec] rework current study dataset minimal example and create a new bids-example from it
• [schema] allow for an optional subdirectory prov/[prov-<label>] #169
  • rwblair has a solution he will contribute
• [spec] rewrite the section about RDF
  • JSON metadata can be aggregated to JSON-LD
  • we use W3C as common vocabulary (explain the context file)
  • add a link to the context file
• [spec] in the example of the ProvEntities section, the Id of the provEntity should have this format: bids::prov#provEntity-<label>
• [spec] change the Consistency and uniqueness of Ids sections:
  • provEntity of a BIDS file in the dataset MUST be a BIDS URI
  • provEntity of a BIDS file not in the dataset SHOULD be a BIDS URI + fragment, if not possible, it MAY have this format: bids::prov#provEntity-<label>
  • review the consistency of the whole section
• [spec] check the consistency of descriptions of metadata fields along the povenance section
• [examples] issue with the spm bids-example, (see. comment in the dedicated PR); the output files from SPM do not have BIDS compliant names and therefore the sidecar JSON files too > how to validate the sidecars ?
• [schema/validator] different usages of GeneratedBy #170
  • is it possible for the schema to have several representations of the same metadata key (here we want several usages for GeneratedBy).
    • if not (or too complicated): we can change naming for GeneratedByProv
    • if possible it should be implemented in the schema
• [ci] pdf rendering error due to "multiline links" #171

[cmaumet]

@bclenet - about "desc entity:", could we simply update the text describing where this file may be found in https://bids-specification.readthedocs.io/en/stable/derivatives/common-data-types.html#descriptionstsv as follows:

This file MAY be located at the root of the derivative dataset, **or at the root of the prov folder**, or at the subject or session level ([Inheritance Principle](https://bids-specification.readthedocs.io/en/stable/common-principles.html#the-inheritance-principle)).

[bclenet]

@cmaumet I mostly agree, but one of my concerns is that the descriptions.tsv section is currently under derivatives/ in the page tree. I think deeper changes are needed e.g. moving the whole section under modality-agnostic-files/dataset-description.md or modality-agnostic-files/data-summary-files.md

[cmaumet]

@cmaumet I mostly agree, but one of my concerns is that the descriptions.tsv section is currently under derivatives/ in the page tree. I think deeper changes are needed e.g. moving the whole section under modality-agnostic-files/dataset-description.md or modality-agnostic-files/data-summary-files.md

Oh good point! Could this change be proposed as a PR (I mean separate of BIDS-Prov)? (Similarly to what you had done earlier for creating a new page for modality-agnostic)