Standards: Data Description and Packaging

Arkisto uses RO-Crate, which is a method for describing and packaging research data from ANY discipline into distributable, reusable Digital Objects with any amount of detailed metadata from simple who/what/where discovery-oriented description to metadata at the file-level or even variable level inside files.

RO-Crate is an implementer-focussed guide to best practice and is based on widely-used standards with annotations in JSON-LD and aims to make it easy to creat good quality metadata description tools which are accessible and practical for use in a wide variety of situations; from an individual researcher working with a folder of data, to large data-intensive computational research environments.

RO-Crate is used in the UTS Research Data Portal and the Modern PARADISEC demonstrator for all data objects.

<p class="my-4">๐Ÿ“„
ID? Title? Description?</p>
<p class="my-4">๐Ÿ‘ฉโ€๐Ÿ”ฌ๐Ÿ‘จ๐Ÿฟโ€๐Ÿ”ฌWho created this data?
๐Ÿ“„What parts does it have?
๐Ÿ“… When?
๐Ÿ—’๏ธ What is it about?
โ™ป๏ธ How can it be reused?
๐Ÿ—๏ธ As part of which project?
๐Ÿ’ฐ Who funded it?
โš’๏ธ How was it made?
Addressable resources
Local Data - Files

RO-Crate is method for describing a dataset as a digital object using a single linked-data metadata document

<p class="my-4">๐Ÿ”ฌ ๐Ÿ”ญ ๐Ÿ“น ๐Ÿ’ฝ ๐Ÿ–ฅ๏ธ โš™๏ธ๐ŸŽผ๐ŸŒก๏ธ๐Ÿ”ฎ๐ŸŽ™๏ธ๐Ÿ”๐ŸŒ๐Ÿ“ก๐Ÿ’‰๐Ÿฅ๐Ÿ’Š๐ŸŒช๏ธ

The dataset may contain any kind of data resource about anything, in any format as a file or URL

<p class="my-4">|-- Folder1/
|          |-- file1.this
|          |-- file2.that
|-- Folder2/
|		   -- file1.this
|          |-- file2.that
|-2021-04-08 07.58.17.jpg
"@id": "2021-04-08 07.58.17.jpg",
"@type": "File",
"contentSize": 3271409,
"dateModified": "2021-04-08T07:58:17+10:00",
"description": "",
"encodingFormat": [
"@id":  ""
"name": "Cute puppy"
<p class="my-4">

Each resource can have a machine readable description in JSON-LD format

<p class="my-4">|-- Folder1/
|          |-- file1.this
|          |-- file2.that
|-- Folder2/
|		   -- file1.this
|          |-- file2.that
|-2021-04-08 07.58.17.jpg</p>
<p class="my-4">

A human-readable description and preview can be in an HTML file that lives alongside the metadata

<p class="my-4">๐Ÿ“‚
<p class="my-4">๐Ÿญ CreateAction ๐Ÿญ
Date: 2021-04-01
โš™๏ธSoftware / workflow
Name: My Workflow
<p class="my-4">๐Ÿฅresult

Provenance and workflow information can be included - to assist in data and research-process re-use


RO-Crate Digital Objects may be packaged for distribution eg via Zip, Bagit and OCFL Objects