Skip to content

Commit 53480fc

Browse files
committed
address review comments
1 parent c361138 commit 53480fc

File tree

8 files changed

+79
-11
lines changed

8 files changed

+79
-11
lines changed

episodes/05-metadata-descriptor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ exercises: 2
1717

1818
## RO-Crate Metadata descriptor
1919

20-
The first JSON-LD _entity_ to add in the `@graph` array has the `@id` value of `ro-crate-metadata.json` to describe the JSON file itself:
20+
Next, we'll add another _entity_ to the `@graph` array has the `@id` value of `ro-crate-metadata.json` to describe the JSON file itself:
2121

2222

2323
```json

episodes/06-cross-references.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ teaching: 3
44
exercises: 4
55
---
66
:::::::::::::::::::::::::::::::::::::::: questions
7-
- How does RO Crate use flattened JSON-LD?
7+
- How can I describe an entity further?
88
- How can I cross-reference different entities?
99
::::::::::::::::::::::::::::::::::::::::::::::::::
1010

episodes/07-data-entities.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,32 @@ as shown in the above example, this does not need to match the filename/identifi
5959
The `encodingFormat` indicates the media file type so that consumers of the crate can open `data.csv` in an appropriate program,
6060
and can be particularly important for less common file extensions frequently encountered in outputs from research software and instruments.
6161

62-
You can override the license for the root data entity by specifying a `license` property on the data entity itself.
63-
6462
For more information on describing files and folders,
6563
including their recommended and required attributes,
6664
see section on [data entities](https://www.researchobject.org/ro-crate/specification/1.2/data-entities.html).
6765

66+
:::::::::::::::::::::::::::::::::::::::: challenge
67+
## Override the licence
68+
69+
1. Consider if the file content of `data.csv` is not covered by our overall license (CC0),
70+
but [Creative Commons BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
71+
(which only permits non-commercial use)
72+
2. To override, add an `license` cross-reference property on this particular data entity
73+
74+
::::::::::::::: solution
75+
```json
76+
{
77+
"@id": "data.csv",
78+
"@type": "File",
79+
"name": "Rainfall Katoomba 2022-02",
80+
"description": "Rainfall data for Katoomba, NSW Australia February 2022",
81+
"encodingFormat": "text/csv",
82+
"license": { "@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/" }
83+
},
84+
```
85+
:::::::::::::::::::::::::
86+
::::::::::::::::::::::::::::::::::::::::::::::::::
87+
6888

6989
:::::::::::::::::::::::::::::::::::::::: keypoints
7090
- Data entities are files & folders within the root, as well as external Web references

episodes/08-contextual-entities.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,45 @@ for instance how to link to authors and their affiliations.
3737
Simplifying slightly, a data entity is referenced from `hasPart` in a `Dataset`,
3838
while a contextual entity is referenced using any other defined property.
3939

40+
## Detailing licenses
41+
42+
We have previously declared two different `license` cross-references.
43+
While following the URLs in this case explain the licenses well,
44+
it is also best practice to include a very brief summary of contextual entities in the RO-Crate Metadata Document.
45+
This is more important if the cross-reference do not use a permalink and may change over time.
46+
As a minimum, each referenced entity should have a `@type` and `name` property.
47+
It is also possible to add `url` for more information.
48+
49+
:::::::::::::::::::::::::::::::::::::::: challenge
50+
## Add licence entities
51+
52+
Add a contextual entity for each of the two licenses,
53+
see the [licensing](https://www.researchobject.org/ro-crate/1.1/contextual-entities.html#licensing-access-control-and-copyright) section for details:
54+
55+
::::::::::::::: solution
56+
```json
57+
{
58+
"@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/",
59+
"@type": "CreativeWork",
60+
"name": "CC BY-NC-SA 4.0 International",
61+
"description": "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International"
62+
},
63+
{
64+
"@id": "http://spdx.org/licenses/CC0-1.0",
65+
"@type": "CreativeWork",
66+
"name": "CC0-1.0",
67+
"description": "Creative Commons Zero v1.0 Universal",
68+
"url": "https://creativecommons.org/publicdomain/zero/1.0/"
69+
},
70+
```
71+
:::::::::::::::::::::::::
72+
::::::::::::::::::::::::::::::::::::::::::::::::::
73+
74+
75+
An additional exercise is to try to unify the two entities so that both use spdx identifiers,
76+
remembering to update the corresponding `license` cross-references when changing the `@id`.
77+
However, not all licenses have a direct SPDX identifier.
78+
4079
## Instrument details
4180

4281
For example, the instrument used to capture weather data is not itself part of the dataset, but knowing what device created the measurements helps the data consumer interpret and validate the data.

episodes/13-complete.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ The final RO-Crate Metadata Document constructed in this tutorial should look so
5252
"name": "Rainfall Katoomba 2022-02",
5353
"description": "Rainfall data for Katoomba, NSW Australia February 2022",
5454
"encodingFormat": "text/csv",
55+
"license": {"@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/"},
5556
"instrument": { "@id": "https://example.org/instrument/ws-2000" }
5657
},
5758
{
@@ -60,14 +61,20 @@ The final RO-Crate Metadata Document constructed in this tutorial should look so
6061
"name": "WS-2000 Weather Station",
6162
"description": "Automated weather station used to record temperature and rainfall data.",
6263
"url": "https://example.org/instrument/ws-2000"
63-
},
64+
},
65+
{
66+
"@id": "https://creativecommons.org/licenses/by-nc-sa/4.0/",
67+
"@type": "CreativeWork",
68+
"name": "CC BY-NC-SA 4.0 International",
69+
"description": "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International"
70+
},
6471
{
6572
"@id": "http://spdx.org/licenses/CC0-1.0",
6673
"@type": "CreativeWork",
6774
"name": "CC0-1.0",
6875
"description": "Creative Commons Zero v1.0 Universal",
6976
"url": "https://creativecommons.org/publicdomain/zero/1.0/"
70-
},
77+
},
7178
{
7279
"@id": "https://orcid.org/0000-0002-1825-0097",
7380
"@type": "Person",

episodes/14-common-pitfalls.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ Here's an incorrect metadata example. Identify and fix the issues.
9191
3. The data.csv entity should be defined separately in the @graph.
9292
4. The encodingFormat should be a valid IANA media type (e.g., "text/csv").
9393
5. Missing required properties (description, datePublished, license) on the root dataset.
94-
::::::::::::::::::::::::::::::::::::::::
94+
:::::::::::::::::::::::::
95+
::::::::::::::::::::::::::::::::::::::::::::::::::
9596

9697
## RO-Crate validation tools
9798

episodes/15-next-steps.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ You have completed making a basic RO-Crate. You may try any of the following:
2323

2424
- **RO-Crate Profiles**: Delve into [RO-Crate Profiles](https://www.researchobject.org/ro-crate/profiles.html), which are community-defined content checklists that extend the base specification to meet the specific needs of a domain or data type. Profiles impose conventions and may add domain specific terms/vocabularies, effectively making RO-Crates typed and machine-actionable for specific use cases. Examples include the [Workflow RO-Crate profile](https://about.workflowhub.eu/Workflow-RO-Crate/) used by WorkflowHub and the [Five Safes RO-Crate profile](https://trefx.uk/5s-crate/) for trusted workflow execution in Trusted Research Environments (TREs).
2525

26-
- **FAIR Signposting**: Understand how [FAIR Signposting](https://catalogue.fair-impact.eu/resources/fair-signposting) can be used in combination with RO-Crate to guide machine agents through metadata space. It re-uses existing web standards (HTTP Link headers or HTML `<link>` tags tags) to make machine navigation explicit, helping automated agents locate an object's identifier, data records, and metadata records.
26+
- **FAIR Signposting**: Understand how [FAIR Signposting](https://catalogue.fair-impact.eu/resources/fair-signposting) can be used in combination with RO-Crate to guide machine agents through metadata space.
2727

28-
- **Bioschemas**: Explore [Bioschemas](https://bioschemas.org/), a community initiative built on schema.org that defines domain-specific profiles (e.g., Dataset, ComputationalWorkflow, ChemicalSubstance) to add structured metadata to web resources, improving findability and interoperability, particularly in the life sciences.
28+
- **Bioschemas**: Explore [Bioschemas](https://bioschemas.org/), a life sciences community initiative built on schema.org that defines domain-specific profiles (e.g., Dataset, ComputationalWorkflow, ChemicalSubstance).
2929

30-
- **Community and Tools**: Join the open [RO-Crate community](https://www.researchobject.org/ro-crate/community) on GitHub, participate in drop-in sessions, and explore available tools like Crate-O, RO-Crate Playground, and libraries for various programming languages (Python, JavaScript). This active community and the developer-friendly tools are key to RO-Crate's adoption and sustainability.
30+
- **Community and Tools**: Join the open [RO-Crate community](https://www.researchobject.org/ro-crate/community) on GitHub, participate in drop-in sessions, and explore the tools and libraries for various programming languages.
3131

32-
- **Real-world Use Cases**: Gain inspiration from how RO-Crates are being [used in practice](https://www.researchobject.org/ro-crate/use_cases) across various domains, such as in ELIXIR resources for life sciences, WorkflowHub for computational workflows, for Electronic Lab Notebooks (ELN) provenance, and for packaging earth observation data. RO-Crate enables exchange between services and data repositories, fostering an ecosystem of research infrastructure.
32+
- **Real-world Use Cases**: Explore how RO-Crates are being [used in practice](https://www.researchobject.org/ro-crate/use_cases) across various domains.

index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ packaging research data.
1010
:::::::::::::::::::::::::::::::::::::::::: prereq
1111
## Prerequisites
1212
- Files and folder organization and using a text editor or IDE such as [Visual Studio Code](https://code.visualstudio.com/)
13+
- Familiarity with [JSON](https://www.json.org/) file format
1314
::::::::::::::::::::::::::::::::::::::::::::::::::
1415

1516
### Target Audience

0 commit comments

Comments
 (0)