Finalize proposal submission

bids-standard / BEP028_BIDSprov

Organizing and coordinating BIDS extension proposal 28 : BIDS Provenance

https://bids.neuroimaging.io/bep028

Creative Commons Attribution 4.0 International

4 stars 12 forks source link

Finalize proposal submission #57

Open cmaumet opened 3 years ago

cmaumet commented 3 years ago

[ ] First pass at updating the BEP028 spec to be compliant with latest discussions.

Add a usage examples of this spec for the following:

[ ] 1- simplest model with one activity and its parameters,
[ ] 2- workflow with more than 1 activity,
[ ] 3- encoding environement (Matlab, docker, bash, etc.).
[ ] 4- an example with hierarchies of activities (use isPartOf form PROVONE)
[ ] 5- an example that uses the ontology of processings / image types
[ ] 6- an example discussing file-level prov VS dataset-level prov

remiadon commented 3 years ago

@cmaumet I just updated the document, mainly to

update the examples (json-ld files structure and content)
discuss about dataset-level representation (global sidecar file) VS file-level representation (one sidecar file per datafile)

IMO point 2 is not really to be discussed, as we strive for a global sidecar file in most cases, and even allow definitions to be shared across multiple files.

Should would start a separate thread to add more examples and usecases for beta users of BIDS-prov ?? There is a running issue that may be suited for this, here https://github.com/bids-standard/BEP028_BIDSprov/issues/56

remiadon commented 3 years ago

TODO : add this field to the common definition, just after @context

"BIDSProvVersion": "1.0.0",

cmaumet commented 3 years ago

@remiadon: you can implement the changes to the examples (version) directly in your PR https://github.com/bids-standard/BEP028_BIDSprov/pull/58.

remiadon commented 3 years ago

@cmaumet done in https://github.com/bids-standard/BEP028_BIDSprov/pull/58/commits/47fb0a9c0ca2730ac29fa7c056d3699979486c34

BTW is there a way to define a common header for all sides car files ?? Just adding "BIDSProvVersion": "1.0.0", got me going into editing all the .json files in our repo