https://github.com/dnlbauer/bh24-ro-crate-extension

https://github.com/dnlbauer/bh24-ro-crate-extension

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dnlbauer/bh24-ro-crate-extension
• Owner: dnlbauer
• Created: 2024-11-06T11:28:48.000Z (8 days ago)
• Default Branch: main
• Last Pushed: 2024-11-06T13:59:51.000Z (8 days ago)
• Last Synced: 2024-11-06T14:31:26.278Z (8 days ago)
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Biohackathon 2024 Project 19 RO-Crate extension

This repository contains descriptions and examples for two possible extensions of RO-Crate

to enable the use of profiles on subdirectories of an RO-Crate

while also retaining the option to link between objects in differing subdirectories.

## sub-ro-crates

This solution extends existing methods for referencing other RO-Crates by specifying

- nested RO-Crates (via a profile) that can not be standalone, i.e. they should only exist within another RO-Crate

- requirements for additional contextual entities withing sub-crates to point onto sibling objects in the parent RO-Crate

### Example Use Case

The directory `sub-rocrate` contains an example ro-crate to showcase the extended structure (containing invalid comments in json).

## ro-crate-multiple-entrypoints

This RO-Crate metadata structure shows how the specification of RO-Crate could be extended

to support multiple entry points in an RO-Crate.

An entry point in this context can be considered as a kind of "lense"

through which the content of the RO-Crate can be seen.

This allows for a more flexible organization of related data, i.e by having one subgroup of files in the crate

representing a machine-actionable workflows with additional data within the same crate.

### Key differences to the RO-Crate 1.2 Draft specification

- Multiple Entry Points: Instead of a single entry point (`./`), this RO-Crate includes an additional entry point (`./workflow-subdirectory`) conforming to

the Workflow RO-Crate profile.

- All entry points can be identified by their additional type `Entrypoint`.

- Additionally, the `ro-crate-metadata.json` entity lists all entry points in its `about` property. The main entry point (`./`)

is pointed to by `mainEntity`

### Example Use Case

This structure is particularly useful for projects requiring a modular approach, where the main data repository (./) can be accompanied by one or more specialized workflows or datasets

that need to link to each others files.

## ro-crate-multiple-entrypoints-workflow-and-process

Also shows an example on how RO-Crates could be expanded for multiple entry points.

This shows how a workflow run can be decomposed into an entry point for the workflow RO-Crate (only the executable workflow),

and another entry point for the process run RO-Crate representing the execution of said workflow.