GitHub Twitter

DataCatalog Profile

Version: 0.3 (01 July 2019)


If you spot any errors or omissions with this type, please file an issue in our GitHub.


Contributors

The following people have been involved in the creation of this specification document. They are all members of the Data Repositories group.

Group Leader(s)

Henning Hermjakob

Other team members

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > CreativeWork > DataCatalog

Description

A guide for how to describe data catalogs/repositories in the life-sciences using Schema.org-like annotation.





Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.


CD = Cardinality


View all examples
Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
description Text
Schema:

A description of the item.


Bioschemas:

A short summary describing a dataset.

ONE
View ≪description≫ example
keywords Text
Schema:

Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.


Bioschemas:

These keywords provide a summary of the dataset.

MANY
View ≪keywords≫ example
name Text
Schema:

The name of the item.


Bioschemas:

A descriptive name of the dataset.

ONE
View ≪name≫ example
provider Organization
Person
Schema:

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.


Bioschemas:

Contact information for this data repository/catalog.

MANY
View ≪provider≫ example
url URL
Schema:

URL of the item.


Bioschemas:

The location of a page describing the dataset.

ONE
View ≪url≫ example
Marginality: Recommended.
about Thing
Schema:

The subject matter of the content. Inverse property: subjectOf.


MANY
alternateName Text
Schema:

An alias for the item.


MANY
View ≪alternateName≫ example
citation CreativeWork
Text
Schema:

A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.


Bioschemas:

A citation for a publication that describes the dataset.

MANY
View ≪citation≫ example
dataset Dataset
Schema:

A dataset contained in this catalog. Inverse property: includedInDataCatalog.


MANY
View ≪dataset≫ example
dateCreated Date
DateTime
Schema:

The date on which the CreativeWork was created or the item was added to a DataFeed.


ONE
identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

Identifier of the DataCatalog in Curie form. Eg. prefix:accession.

MANY
View ≪identifier≫ example
license CreativeWork
URL
Schema:

A license document that applies to this content, typically indicated by URL.


Bioschemas:

A license under which the dataset is distributed.

ONE
View ≪license≫ example
sourceOrganization Organization
Schema:

The Organization on whose behalf the creator was working.


MANY
Marginality: Optional.
dateModified Date
DateTime
Schema:

The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed.


Bioschemas:

The date on which the data catalog/repository was most recently modified.

ONE
encodingFormat Text
URL
Schema:

Media type typically expressed using a MIME format (see IANA site and MDN reference) e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.). In cases where a CreativeWork has several media type representations, encoding can be used to indicate each MediaObject alongside particular encodingFormat information. Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. Supersedes fileFormat.


MANY

Top ▲