GitHub Twitter

Dataset DRAFT Profile

Version: 0.3-DRAFT (27 November 2018)


Contributors

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

Group Leader(s)
Other team members

Schema.org hierarchy

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

Thing > CreativeWork > Dataset

Description

A guide for how to describe datasets 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
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.


MANY
View ≪identifier≫ 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
url URL
Schema:

URL of the item.


Bioschemas:

The location of a page describing the dataset.

ONE
View ≪url≫ example
Marginality: Recommended.
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
creator Organization
Person
Schema:

The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.


Bioschemas:

The name of the dataset creator (person or organization).

MANY
View ≪creator≫ example
distribution DataDownload
Schema:

A downloadable form of this dataset, at a specific location, in a specific format.


ONE
View ≪distribution≫ example
includedInDataCatalog DataCatalog
Schema:

A data catalog which contains this dataset. Supersedes catalog, includedDataCatalog. Inverse property: dataset.


MANY
View ≪includedInDataCatalog≫ 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
measurementTechnique Text
URL
Schema:

A technique or technology used in a Dataset (or DataDownload, DataCatalog), corresponding to the method used for measuring the corresponding variable(s) (described using variableMeasured). This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but rather as a high level summary for dataset discovery. For example, if variableMeasured is: molecule concentration, measurementTechnique could be: “mass spectrometry” or “nmr spectroscopy” or “colorimetry” or “immunofluorescence”. If the variableMeasured is “depression rating”, the measurementTechnique could be “Zung Scale” or “HAM-D” or “Beck Depression Inventory”. If there are several variableMeasured properties recorded for some given data object, use a PropertyValue for each variableMeasured and attach the corresponding measurementTechnique.


MANY
View ≪measurementTechnique≫ example
variableMeasured PropertyValue
Text
Schema:

The variableMeasured property can indicate (repeated as necessary) the variables that are measured in some dataset, either described as text or as pairs of identifier and description using PropertyValue.


Bioschemas:

What does the dataset measure? (e.g., temperature, pressure).

MANY
View ≪variableMeasured≫ example
version Number
Text
Schema:

The version of the CreativeWork embodied by a specified resource.


Bioschemas:

The version number for this dataset.

ONE
View ≪version≫ example

Top ▲