Skip to content

Commit

Permalink
Merge pull request #231 from ResearchObject/profiles-on-data-entities
Browse files Browse the repository at this point in the history
Indicate encoding format profile using conformsTo
  • Loading branch information
stain authored Mar 23, 2023
2 parents a04b036 + bd3e133 commit e013a5e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/1.2-DRAFT/data-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,31 @@ If there is no web-accessible description for a file format it SHOULD be describ
}
```

### File format profiles

Some generic file formats like `application/json` may be specialized using a _profile_ document that define expectations for the file's content as expected by some applications, by using [conformsTo] to a contextual entity with type [CreativeWork]:

```json
{
"@id": "attributes.csv",
"@type": "File",
"encodingFormat": ["text/csv", {"@id": "https://www.nationalarchives.gov.uk/PRONOM/x-fmt/18"}],
"conformsTo": {"@id": "https://docs.ropensci.org/dataspice/#create-spice"}
},
{
"@id": "https://docs.ropensci.org/dataspice/#create-spice",
"@type": "CreativeWork",
"name": "dataspice CSV profile"
}
```

{: .tip }
Profiles expressed in formal languages (e.g. XML Schema for validation) can have their own `encodingFormat` and `conformsTo` to indicate their file format.

{: .note}
The [Metadata File Descriptor](root-data-entity.md#ro-crate-metadata-file-descriptor) `ro-crate-metadata.json` is not a data entity, but is described with `conformsTo` to an implicit contextual entity for the RO-Crate specification, a profile of [JSON-LD](appendix/jsonld). RO-Crates themselves can be specialized using [Profile Crates](profiles), specified with `conformsTo` on the root data entity.


## Core Metadata for Data Entities

The table below outlines the properties that Data Entities, when present, MUST have to be minimally valid.
Expand Down

0 comments on commit e013a5e

Please sign in to comment.