ResearchObject / ro-crate

Research Object Crate
https://w3id.org/ro/crate/
Apache License 2.0
79 stars 34 forks source link

Use Case: Associate Jupyter Notebooks with RO-Crate data #207

Open ptsefton opened 1 year ago

ptsefton commented 1 year ago

As a service designer I want to associate RO-Crates or their parts with Jupyter Notebooks or other code

The below recording shows the system in action, but we would like some advice about how to indicate in RO-Crate (a) that a File Entity for a notebook works with a particular dataset (by ID) and (b) that it knows how to consume data that complies with a Profile (such as a profile for Frictionless Table Schema).

We borrowed “input” from the bioschema ComputationalWorkflow profile but is that appropriate?

Also we want to be able to say input is anything that conformsTo a profile - such as a profile that explains how to write a conformant Frictionless schema for a CSV file, such that the file can be imported no matter what

{
        "@id": "farms-to-freeways.ipynb",
        "@type": [ "File", "SoftwareApplication"],
        "author": [
            {
                "@id": "#0000-0003-0879-9251"
            }
        ],
        "conformsTo": [
            {
                "@id": "https://purl.archive.org/textcommons/profile#Notebook"
            }
        ],
        "description": "A sample notebook for the Farms to Freeways data",
        "encodingFormat": "application/x-ipynb+json",
        "input": [
            {
                "@id": "arcp://name,farms-to-freeways/corpus/root"
            }
        ],
        "name": "Farms to freeways notebook"
    }

screen_recording_2022-08-19_at_4 25 09_pm