Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address "semantic conflict" for GeneratedBy #89

Open
yarikoptic opened this issue Oct 28, 2024 · 2 comments
Open

Address "semantic conflict" for GeneratedBy #89

yarikoptic opened this issue Oct 28, 2024 · 2 comments

Comments

@yarikoptic
Copy link
Contributor

We already have GeneratedBy field in BIDS: see e.g. https://bids-specification.readthedocs.io/en/stable/glossary.html#generatedby-metadata . It is a simplified / lightweight version of a more complete GeneratedBy which is being proposed as part of the BEP028. For an example of it look at "Alternative representation for file-level provenance JSON-LD" section.

In

@satra (attn @cmaumet) points to "semantic conflict" between ad-hoc GeneratedBy in BIDS and formalized in BEP028 PROV record. Ideally there should be no such conflicts. I see two potential ways to address

  • rename BIDS's GeneratedBy into e.g. BIDSGeneratedBy (suggest better alternatives) and leave it as a simplified
    • worth explicitly listing/stating what would be missing to seamlessly convert to proper PROV GeneratedBy and potentially extend schema to include those fields
  • harmonize GeneratedBy to the PROV version.
    • question is either it is not too detailed/cumbersome and simplified version has merit to exist
@satra
Copy link

satra commented Oct 28, 2024

adding an older discussion in relation to this: bids-standard/bids-specification#440 (comment)

in prov there is a property (wasAttributedTo) that connects entities to agents. it's not generatedBy, which connects entities to activities. hence the mismatch in semantics.

@yarikoptic
Copy link
Contributor Author

I think we are "ok" in that sense of the semantic: there is "Description" field reserved which would/could describe the activity, as I have just done in my adjustment to the

example. And that "Description" aligns well in semantic of BIDS having now those _desc entities and descriptions.tsv - https://bids-specification.readthedocs.io/en/stable/derivatives/common-data-types.html#descriptionstsv , as description of activity lead to the derivative. So, altogether GeneratedBy ATM links to the composite of the agent + activity in a single flattened record.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants