Skip to content
Draft
Show file tree
Hide file tree
Changes from 94 commits
Commits
Show all changes
113 commits
Select commit Hold shift + click to select a range
3b64a2b
Adding dir at dataset level
bclenet Mar 18, 2025
45f6af4
Adding dir at any level
bclenet Mar 18, 2025
4c315ce
Adding rule for dir at dataset level
bclenet Mar 18, 2025
b490c91
Adding objects: JSONLD extension + top level dir
bclenet Mar 18, 2025
f2a67a6
Adding object : prov entity
bclenet Mar 18, 2025
d9bb7b0
Add suffixes in object.suffixes
bclenet Mar 18, 2025
64e2c65
GeneratedByProv and SidecarGeneratedBy metadata
bclenet Mar 18, 2025
acc6af0
prov entitiy and provenance json/jsonld files
bclenet Mar 19, 2025
34fafe1
provenance json/jsonld files inside new rules file
bclenet Mar 19, 2025
f73b668
Merge branch 'master' into BEP028_schema
bclenet Apr 10, 2025
a1fbb8a
[SCHEMA] removing provenance subdir level description
bclenet Apr 10, 2025
6622d08
Yaml lint
bclenet Apr 10, 2025
b05b950
[SPEC] first draft for BEP028 BIDS-Prov
bclenet Apr 10, 2025
9ae1649
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 10, 2025
f572174
Adapting markdown to mkdocs
bclenet Apr 22, 2025
ee0d30d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 22, 2025
b619de1
Broken paragraph links
bclenet Apr 23, 2025
74722b1
Citing BIRS Provenance + removing 'BIDS-Prov' from spec
bclenet Apr 23, 2025
34411ba
Into JSON only provenance files
bclenet Apr 25, 2025
248d2b8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 25, 2025
99faa51
Into JSON only provenance files
bclenet Apr 25, 2025
ac7aff4
Into JSON only provenance files
bclenet Apr 25, 2025
6289722
Merge branch 'master' into BEP028_schema
bclenet Apr 25, 2025
3fef3dc
Merge branch 'spec-refac' into BEP028_spec
bclenet Apr 25, 2025
03026d1
Flags for markdown code blocks
bclenet Apr 25, 2025
a3dd018
Merge branch 'master' into BEP028_spec
bclenet Apr 25, 2025
0202806
Typo in provenance.md
bclenet Apr 25, 2025
58055b7
Remark check
bclenet May 6, 2025
a3cef66
Removing non latin content
bclenet May 7, 2025
c9a65b7
Merge branch 'master' into BEP028_spec
bclenet May 13, 2025
4f89eff
Removing inline description of activities inside dataset_description
bclenet May 15, 2025
3d45ac9
Update description for suffixes
bclenet May 15, 2025
ae91f1d
Adding provenance contexte
bclenet May 15, 2025
197e173
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 15, 2025
fdd60f2
GeneratedByProv only contain uri(s)
bclenet May 20, 2025
710f008
Merge branch 'master' into BEP028_schema
bclenet May 20, 2025
93c75e1
Change name for GeneratedBy in JSON sidecars
bclenet May 21, 2025
2b8ad75
Merge branch 'master' into BEP028_schema
bclenet May 21, 2025
0211151
Adding Provenance records in the schema: Activities, Entities, Softwa…
bclenet May 21, 2025
b2ccd67
Adding metadata info for provenance records
bclenet May 21, 2025
46a7ea8
Change provenance suffixes definitions
bclenet May 21, 2025
b153ad0
Merge branch 'master' into BEP028_spec
bclenet May 21, 2025
f219c11
Refactoring provenance spec
bclenet May 21, 2025
29b2166
Refactoring provenance spec
bclenet May 21, 2025
c02c227
Adding ActedOnBehalfOf
bclenet May 23, 2025
a6c6943
Codespell
bclenet May 23, 2025
0598f8b
Merge branch 'master' into BEP028_spec
bclenet May 27, 2025
ded0420
Provenance datatype + removing base suffix
bclenet Jun 3, 2025
aabf81f
Merge branch 'master' into BEP028_schema
bclenet Jun 3, 2025
2f2b6a2
Merge branch 'master' into BEP028_spec
bclenet Jun 3, 2025
a61fe5a
Update examples
bclenet Jun 3, 2025
27459f2
Remark & latin-phrases
bclenet Jun 3, 2025
6bfbb50
Remark & latin-phrases
bclenet Jun 3, 2025
06ff6bc
Merge branch 'master' into BEP028_schema
bclenet Jun 10, 2025
2597af3
Merge branch 'master' into BEP028_spec
bclenet Jun 10, 2025
0dc7b6a
Merge branch 'BEP028_schema' into BEP028_spec
bclenet Jun 10, 2025
5ca65af
Latin + Yaml lint
bclenet Jun 10, 2025
d62fc27
Digest and Type added as metadata for Entity records
bclenet Jun 10, 2025
1fbc042
Using macros for records files
bclenet Jun 17, 2025
b24deb9
Using macros to define provenance in sidecar JSON and dataset_descrip…
bclenet Jun 18, 2025
9fae7b6
YML lint + codespell
bclenet Jun 18, 2025
053f6b1
Issue with provenance spec link
bclenet Jun 18, 2025
208131b
Merge branch 'master' into BEP028_spec
bclenet Jun 18, 2025
792c617
Provenance of derived dataset
bclenet Jun 18, 2025
e9796f8
Link issues
bclenet Jun 18, 2025
f5ea386
Entity Ids are BIDS URIs
bclenet Jun 19, 2025
c4e926d
Remove GeneratedByProv -> integrated into GeneratedBy for dataset lev…
bclenet Jun 19, 2025
0a0368f
Entities allowed in prov-*_ent.json files
bclenet Jun 19, 2025
a851f8b
Remark
bclenet Jun 19, 2025
2052b37
Entities allowed in prov-*_ent.json files
bclenet Jun 19, 2025
8415096
Removing GeneratedByProv
bclenet Jun 19, 2025
ab8ccaf
GeneratedBy field for Entities allow arrays
bclenet Jun 20, 2025
482c440
fMRIPrep example
bclenet Jun 24, 2025
be27631
Markdown lint
bclenet Jul 1, 2025
05022aa
Merge branch 'master' into BEP028_spec
bclenet Jul 22, 2025
ab7872d
BIDS-Prov citation + Provenance example links
bclenet Jul 22, 2025
535705c
Correcting typos
bclenet Jul 22, 2025
8cf521f
Links from snippets to bids-examples
bclenet Jul 22, 2025
2c43698
Links from snippets to bids-examples
bclenet Jul 22, 2025
d978907
Provenance graph for definitions
bclenet Jul 22, 2025
d4dabb4
Provenance example graph with neuro context
bclenet Jul 31, 2025
5eb1ec3
Merge branch 'master' into BEP028_spec
bclenet Sep 3, 2025
9381bf4
Remove unrelated changes
bclenet Sep 3, 2025
5c83813
Typo and replace CAN by MAY
bclenet Sep 3, 2025
891730b
Examples at the begining of subsections
bclenet Sep 3, 2025
5181dd0
Uniqueness of ids
bclenet Sep 3, 2025
c20912c
Minimal example > consistency of Ids
bclenet Sep 3, 2025
ff4746a
Issue with dataset naming
bclenet Sep 3, 2025
9f6eeae
Simplification in definitions
bclenet Sep 3, 2025
2f05124
Deidentification
bclenet Sep 4, 2025
ca61869
Merge branch 'master' into BEP028_spec
bclenet Sep 4, 2025
7345757
Removing prefix all
bclenet Sep 4, 2025
a3f5238
Remove unrelated changes
bclenet Sep 4, 2025
242062c
Sidecargeneratedby precision
bclenet Sep 11, 2025
4840a3e
Using markdown mermaid graph for provenance
bclenet Sep 16, 2025
575c7c3
Scopes of provenance description
bclenet Sep 16, 2025
b80d616
Environments added in provenance context
bclenet Sep 16, 2025
ca88629
Removing non existing terms Entity Activity and Environment
bclenet Sep 16, 2025
957f1d4
Entities description
bclenet Sep 19, 2025
bca8614
Descriptions for ids in metatadta
bclenet Sep 19, 2025
9ca908f
Descriptions for ids in metatadta
bclenet Sep 19, 2025
07b99a8
Removing caps to entity, activity, environment and software
bclenet Sep 19, 2025
386fcc0
descriptions of suffixes
bclenet Sep 19, 2025
8c484c7
@cmaumet review
bclenet Sep 23, 2025
92ebb2c
@cmaumet review
bclenet Sep 23, 2025
ea8de55
GeneratedBy can be an array of objects (pipelines) or an activitiy Id
bclenet Sep 24, 2025
a426280
Removing groups of provenance
bclenet Sep 24, 2025
1a9b496
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 24, 2025
5215609
GeneratedBy schema modification
bclenet Sep 24, 2025
f557eaa
Reorganize and consistency in naming
bclenet Sep 24, 2025
32f80c7
Using identifier instead of
bclenet Sep 25, 2025
b0db166
Id for entities other than BIDS URI
bclenet Sep 25, 2025
7dd01e6
Minimal example for study dataset
bclenet Sep 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ nav:
- Data summary files: modality-agnostic-files/data-summary-files.md
- Phenotypic and assessment data: modality-agnostic-files/phenotypic-and-assessment-data.md
- Code: modality-agnostic-files/code.md
- Provenance: modality-agnostic-files/provenance.md
- Events: modality-agnostic-files/events.md
- Modality specific files:
- Magnetic Resonance Imaging: modality-specific-files/magnetic-resonance-imaging-data.md
Expand Down
Binary file added src/images/provenance_definitions_graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,15 @@ For example:
Scientific Data 12, (13841).
[doi:10.1038/s41597-025-05543-2](https://doi.org/10.1038/s41597-025-05543-2)

### Other extensions specific publications

#### Provenance

- Rémi Adon, Stefan Appelhoff, Tibor Auer, Laurent Guillo, Yaroslav O Halchenko, David Keator, Christopher J Markiewicz, Thomas E Nichols, Jean-Baptiste Poline, Satrajit Ghosh, Camille Maumet (2021).
**BIDS-prov: a provenance framework for BIDS**.
OHBM 2021 - 25th Annual Meeting of the Organization for Human Brain Mapping, Jun 2021, Online, South Korea. pp.1-3
[https://inserm.hal.science/inserm-03478998v1](https://inserm.hal.science/inserm-03478998v1)

### Research Resource Identifier (RRID)

BIDS has also a
Expand Down
13 changes: 0 additions & 13 deletions src/modality-agnostic-files/dataset-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,6 @@ and a guide for using macros can be found at
}
) }}

Each object in the `GeneratedBy` array includes the following REQUIRED, RECOMMENDED
and OPTIONAL keys:

<!-- This block generates a table describing subfields within a metadata field.
The definitions of these fields can be found in
src/schema/objects/metadata.yaml
and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_subobject_table("metadata.GeneratedBy.items") }}

Example:

```JSON
Expand Down Expand Up @@ -107,8 +96,6 @@ Example:
}
```

### Derived dataset and pipeline description

As for any BIDS dataset, a `dataset_description.json` file MUST be found at the
top level of every derived dataset:
`<dataset>/derivatives/<pipeline-name>/dataset_description.json`.
Expand Down
48 changes: 48 additions & 0 deletions src/modality-agnostic-files/provenance-context.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"@context": {
"prov" : "http://www.w3.org/ns/prov#",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"RRID": "http://scicrunch.org/resolver/",
"Id": "@id",
"Type": "@type",
"Label": "http://www.w3.org/2000/01/rdf-schema#label",
"StartedAtTime" : {
"@id": "prov:startedAtTime",
"@type": "http://www.w3.org/2001/XMLSchema#dateTime"
},
"EndedAtTime" : {
"@id": "prov:endedAtTime",
"@type": "xsd:dateTime"
},
"GeneratedBy" : {
"@id": "prov:wasGeneratedBy",
"@type": "@id"
},
"AttributedTo" : {
"@id": "prov:wasAttributedTo",
"@type": "@id"
},
"AssociatedWith" : {
"@id": "prov:wasAssociatedWith",
"@type": "@id"
},
"InformedBy" : {
"@id": "prov:wasInformedBy",
"@type": "@id"
},
"Used" : {
"@id": "prov:used",
"@type": "@id"
},
"ActedOnBehalfOf" : {
"@id": "prov:actedOnBehalfOf",
"@type": "@id"
},
"Entities": "prov:Entity",
"Entity": "prov:Entity",
"Activities": "prov:Activity",
"Activity": "prov:Activity",
"Software": "prov:SoftwareAgent",
"Atlocation": "prov:atLocation"
}
}
Loading
Loading