Summary and Schedule
This lesson is intended to teach users how to use RO-Crate (Research Object Crates) for packaging research data.
Prerequisites
- Files and folder organization and using a text editor or IDE such as Visual Studio Code
- Familiarity with JSON file format
Target Audience
This tutorial targets researchers and infrastructure managers who are producing file-based datasets. The audience will learn the method RO-Crate for publishing such datasets using a pragmatic approach to structure and provide FAIR metadata.
Learning Objectives
- Construct an RO-Crate by hand using JSON
- Describe each part of the Research Object
- Learn basic JSON-LD to create FAIR metadata
- Connect different parts of the Research Object using identifiers
Setup Instructions | Download files required for the lesson | |
Duration: 00h 00m | 1. Introduction |
How do I package data in a FAIR way? How does an RO-Crate identify and describe its contents? What is the difference between data entities and context entities? What is the role of JSON-LD in RO-Crate? How can I list the authors of individual files? How can I validate and visualize RO-Crate metadata? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 17m | 2. Turning a folder into an RO-Crate |
How can I start a new
RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 24m | 3. Declaring the root folder |
What is the root
folder? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 27m | 4. Describing the root entity |
How can I describe the crate? How do I specify the license of the RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 35m | 5. Making a metadata descriptor |
Which RO-Crate version is used? How can the crate self-identify as an RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 39m | 6. Adding cross-references |
How can I describe an entity further? How can I cross-reference different entities? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 46m | 7. Data entities |
How do I describe the data files in my
RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 50m | 8. Contextual entities |
How can I describe contextual information about how data was
created? How can I represent an instrument used to generate a data file? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 00h 54m | 9. Authorship in crates |
How can I list who made the content of the crate? How do I affiliate a person with their place of work? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 00m | 10. Validating JSON-LD |
How can I validate the
JSON-LD? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 06m | 11. Converting JSON-LD to triples |
How can I generate RDF triples from an
RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 09m | 12. Visualizing a crate as HTML preview |
How can an RO-Crate be rendered without showing the JSON? How can I generate a preview of the RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 15m | 13. Completed RO-Crate |
What should the final RO-Crate look
like? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 16m | 14. Avoiding Common pitfalls |
What are common mistakes to avoid when authoring RO-Crate
packages? How can I troubleshoot errors in the metadata file? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 22m | 15. Next steps |
What else can I do with
RO-Crate? :::::::::::::::::::::::::::::::::::::::::::::::::: |
Duration: 01h 23m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
You do not need to install any software to follow this tutorial.