You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: bep028spec.md
+52-2Lines changed: 52 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,59 @@ Note that some level of provenance is already encoded in BIDS (cf. [`GeneratedBy
51
51
52
52
### 1.3 File naming {#1-3-file-naming}
53
53
54
-
This section describes the places where BIDS-Prov contents can be stored; for naming and organization conventions, please consult the BIDS specification ([https://bids-specification.readthedocs.io](https://bids-specification.readthedocs.io)). Until these conventions are established in BIDS, it is RECOMMENDED to use the following.
54
+
This section describes additions to the naming conventions in the BIDS specification for BIDS-Prov files.
55
55
56
-
BIDS-Prov files contain JSON or JSON-LD data. JSON-LD is a specific type of JSON that allows encoding graph-like structures with the Resource Description Framework[^1].
56
+
For further information about naming conventions, please consult the BIDS specification ([https://bids-specification.readthedocs.io](https://bids-specification.readthedocs.io)). Until these conventions are established in BIDS, it is RECOMMENDED to use the following.
57
+
58
+
#### File formats
59
+
60
+
BIDS-Prov files contain JSON or JSON-LD data.
61
+
62
+
[JSON-LD](https://www.w3.org/TR/json-ld11/) is a specific type of JSON that allows encoding graph-like structures with the Resource Description Framework[^1].
63
+
64
+
When using a `.jsonld` extension, the content of the file must be JSON-LD.
65
+
66
+
#### The `prov` entity
67
+
68
+
We introduce the following BIDS entity:
69
+
70
+
*`prov`
71
+
* Full name: Provenance records
72
+
* Format: `prov-<label>`
73
+
* Definition: A grouping of provenance records. Defining multiple provenance records groups is appropriate when several processings have been performed on data.
74
+
75
+
In the following example, two separated processes (`conversion` and `smoothing`) were performed on the data, resulting in two groups of provenance records.
76
+
77
+
```
78
+
└─ dataset
79
+
├─ sub-001/
80
+
│ └─ prov/
81
+
│ └─ sub-001_prov-conversion_act.json
82
+
└─ prov/
83
+
├─ prov-conversion_base.json
84
+
├─ prov-conversion_software.json
85
+
├─ prov-smoothing_base.json
86
+
├─ prov-smoothing_activities.json
87
+
├─ prov-smoothing_software.json
88
+
├─ prov-smoothing_entities.json
89
+
└─ ...
90
+
```
91
+
92
+
#### Suffixes
93
+
94
+
The following BIDS suffixes specify the contents of a provenance file:
95
+
96
+
*`act`: the file describes BIDS Prov Activities for the group of provenance records
97
+
*`soft`: the file describes BIDS Prov Software for the group of provenance records
98
+
*`ent`: the file describes BIDS Prov Entities for the group of provenance records
99
+
*`env`: the file describes BIDS Prov Environments for the group of provenance records
100
+
*`base`: the file describes common BIDS Prov parameters for the group of provenance records (version and context for BIDS Prov)
This section describes the places where BIDS-Prov contents can be stored.
105
+
106
+
For further information about organization conventions, please consult the BIDS specification ([https://bids-specification.readthedocs.io](https://bids-specification.readthedocs.io)). Until these conventions are established in BIDS, it is RECOMMENDED to use the following.
0 commit comments