RO-crate support

Summary

RO-crate is a format to encode workflow (meta)data.

The type of data that are to be encoded in this format is not specified.

WESkit should add its workflow-run information and metadata (maybe also WESkit version, etc.) to these files.

Details

Which data to store in these files?

1. A WES cannot have knowledge of all file metadata (formats) that are created by one (of a large number of) workflows. The appropriate place for this responsibility is with the workflow (developer), or with the workflow engine (developer). However, a WES may know basic file information (paths, sizes, access times, permissions.
2. A WES basically is responsible only for the workflow run metadata of which the engine may not have knowledge (e.g., stdout, stderr, exit code, full execution command (container name), etc.

WESkit can open an existing RO-crate, or create a new RO-crate to supplement the information it has in such a way that it is clear that the information comes from WESkit.

The details have to be defined.

Risks

This is about execution metadata as known by WESkit. Therefore, currently, I would say ...

• Critical: None.
• Normal: None.
• Minor: None.

Verification & Validations

• Validate (both during development and review) that the RO-crate specification is followed correctly.
• Write tests, that RO-crate files are created, and -- if that is implemented -- the merging of information into existing RO-crate files is always possible.

Important Stakeholders

Implementation Suggestions (optional)