How to Encode examples - Githubissues

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

How to Encode examples #65

Closed remiadon closed 1 year ago

remiadon commented 3 years ago

This PR introduces a set of examples for our end-users to quickly identify a design pattern that has already been used in an other workflow, and make proper use of BIDS-prov to encode their own workflow

TODO

[ ] add more examples and make sure they are ready for communication
[x] check examples provide the fields described in the GDOC
[ ] provide a visual overview on the critical questions when using BIDS-prov. Suggestion : a decision tree, like in scikit-learn

remiadon commented 3 years ago

Other ideas of examples

"Should I always declare provenance in a single file ?" -> give directions so that "visualizing" the files separately still make sense. And explicitly state that NO, you can declare multiple files that share the same context
"I want to track provenance for subject-level analysis, should I declare a single prov file for every subject ?"

cmaumet commented 3 years ago

@remiadon - really like the how-to-encode.md file! Could we include this info directly in the spec?

remiadon commented 3 years ago

@cmaumet Yes, I just needed a place to clearly think about this

Do you have more use cases in mind before we merge this into the spec ?

cmaumet commented 3 years ago

Hey @remiadon! Please reply to my email about this afternoon's meeting. This is getting very urgent now.

remiadon commented 3 years ago

@remiadon - really like the how-to-encode.md file! Could we include this info directly in the spec?

@cmaumet done. There is a section called "6 How to encode your workflow with BIDS-prov" in suggestion mode