Adding provenance RDF graphs

Author: bclenet

provenance_dcm2niix/README.md

@@ -11,18 +11,35 @@ That the `sourcedata/` directory contains the source dataset (DICOM files) known
 
 ## Directory tree
 
-After conversion, and adding provenance traces, the directory tree is as follows. Files marked with a ✍️ were generated manually.
-`sub-02/anat/sub-02_T1w.json` was generated by `dcm2niix`, then the `GeneratedBy` and `SidecarGeneratedBy` provenance-related fields were added manually.
+After conversion, and adding provenance traces, the directory tree is as follows.
+
+Legend:
+* files with a ⭐ were generated by `dcm2niix`;
+* files marked with a ✍️ were generated manually;
+* files marked with a 🤖 were comptued from the manually generated provenance metadata;
+* the ⭐✍️ marked `sub-02/anat/sub-02_T1w.json` file was generated by `dcm2niix`, then the `GeneratedBy` and `SidecarGeneratedBy` provenance-related fields were added manually.
+
+> [!NOTE]
+> Note that the `docs/` directory contains explanatory data (see [Provenance as a RDF graph](#provenance-as-a-rdf-graph)) that is not required to encode provenance.
 
 ```
+✍️ docs/
+├── 🤖 prov-dcm2niix.jsonld
+└── 🤖 prov-dcm2niix.png
 ✍️ prov/
 ├── ✍️ prov-dcm2niix_act.json
 ├── ✍️ prov-dcm2niix_ent.json
 ├── ✍️ prov-dcm2niix_env.json
 └── ✍️ prov-dcm2niix_soft.json
 sourcedata/
-sub-02/
-└── anat
-    ├── ✍️ sub-02_T1w.json
-    └── sub-02_T1w.nii
+⭐ sub-02/
+└── ⭐ anat
+    ├── ⭐✍️ sub-02_T1w.json
+    └── ⭐ sub-02_T1w.nii
 ```
+
+## Provenance as a RDF graph
+
+Provenance metadata can be aggregated as a JSON-LD RDF graph, which is available in [`docs/prov-dcm2niix.jsonld`](docs/prov-dcm2niix.jsonld). This is a rendered version of the graph, also available in [`docs/prov-dcm2niix.png`](docs/prov-dcm2niix.png).
+
+![Rendered version of the RDF graph](docs/prov-dcm2niix.png)