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

[ADD] issue template for proposals #19

Closed remiadon closed 4 years ago

remiadon commented 4 years ago

Issue template to follow every time Example using this template to propose type indexing in BIDS-prov

Type-indexing on agents/activities/entities in BIDS-prov


Problem Statement

When defining new graphs in BIDS-prov we have no way to know the type of an object in advance. If we want to find all entities in a given graph, we must iterate over the entire graph. In addition, this layout currently makes reading of the graph harder, and spotting errors becomes tedious


Rationale

We propose to use a feature called type indexing, for all our graphs This will allow to group nodes by type, and maybe to create a hierarchy in the future, accessing the most basic types at first and then descending in the graph for more specific types (eg. Agent vs Software Agent)


Minimal examples

Before

"@graph": [
        {
          "@id" : "dfsiosndfn1",
          "label" : "realign",
          "@type" : "prov:Activity",
        },
]

After

"@graph": {
        "prov:Activity" : [
        {
          "@id" : "dfsiosndfn1",
          "label" : "realign",
        },
    ]
}

Checklist