Unhead
Vue
You're viewing Unhead v3 beta documentation. Install with unhead@beta
Schema
On this page

Schema.org Dataset

Type: defineDataset(input?: Dataset)

Describes a research dataset for scientific, academic, or data science purposes.

Useful Links

Required properties

  • name string
    The name of the dataset. This is a required field for valid Dataset structured data.
  • description string
    A short summary describing the dataset. This is a required field for valid Dataset structured data.

Recommended Properties

  • creator NodeRelations<Person | Organization | string>
    The person or organization who created the dataset. Resolves to Person or Organization.
  • distribution NodeRelations<DataDownload>
    Information about how to access/download the dataset.
  • temporalCoverage string
    The time period the dataset covers (ISO 8601 format, e.g., "2020-01-01/2024-12-31").
  • spatialCoverage string
    The geographic area the dataset covers.
  • keywords string[]
    Keywords describing the dataset.
  • license string
    URL or text specifying the dataset's license.

Defaults

Examples

Minimal

defineDataset({
  name: 'Global Temperature Data 2000-2024',
  description: 'Comprehensive global temperature measurements from weather stations worldwide',
})

Complete

defineDataset({
  name: 'Global Temperature Data 2000-2024',
  description: 'Comprehensive global temperature measurements from weather stations worldwide, including daily readings and anomaly calculations',
  url: 'https://example.com/datasets/global-temp-2000-2024',
  creator: {
    name: 'Climate Research Institute',
    url: 'https://example.com/about',
  },
  datePublished: new Date(2024, 0, 1),
  dateModified: new Date(2024, 11, 1),
  version: '2.0',
  keywords: ['climate', 'temperature', 'weather', 'global warming'],
  license: 'https://creativecommons.org/licenses/by/4.0/',
  temporalCoverage: '2000-01-01/2024-12-31',
  spatialCoverage: 'Global',
  distribution: {
    contentUrl: 'https://example.com/downloads/global-temp-data.csv',
    encodingFormat: 'CSV',
    contentSize: '125 MB',
  },
  variableMeasured: ['temperature', 'humidity', 'pressure'],
  citation: 'Smith, J. et al. (2024). Global Temperature Dataset. Climate Research Institute.',
  isAccessibleForFree: true,
})

Types

export interface DataDownload extends Thing {
  '@type'?: 'DataDownload'
  'contentUrl'?: string
  'encodingFormat'?: string
  'contentSize'?: string
}

export interface DataCatalog extends Thing {
  '@type'?: 'DataCatalog'
  'name'?: string
  'url'?: string
}

export interface DatasetSimple extends Thing {
  '@type'?: Arrayable<'Dataset'>
  'name': string
  'description': string
  'url'?: string
  'keywords'?: string[]
  'creator'?: NodeRelations<Identity>
  'citation'?: string | string[]
  'license'?: string
  'temporalCoverage'?: string
  'spatialCoverage'?: string
  'distribution'?: NodeRelations<DataDownload>
  'variableMeasured'?: string | string[]
  'includedInDataCatalog'?: NodeRelation<DataCatalog>
  'isAccessibleForFree'?: boolean
  'datePublished'?: ResolvableDate
  'dateModified'?: ResolvableDate
  'version'?: string | number
  'sameAs'?: string[]
  'identifier'?: string | string[]
}

Related Schemas

Edit this page
Markdown For LLMs
Did this page help you?