Dataset
The top-level object in the RDLS schema is a risk dataset. A risk dataset is described as:
A collection of risk data, published or curated by a single entity, consisting of one or more resources and described using metadata structured according to the Risk Data Library Standard.
The general attributes of a dataset are described by fields based on the Data Catalog Vocabulary and the Dublin Core Metadata Initiative Metadata Terms.
Overview
erDiagram
Direction LR
Dataset {
string id*
string title*
string description*
array risk_data_type*
object publisher*
object creator*
object contact_point*
string license*
object lineage
object spatial* "Spatial coverage"
object temporal "Temporal coverage"
object hazard "Hazard metadata"
object exposure "Exposure metadata"
object vulnerability "Vulnerability metadata"
object loss "Loss metadata"
}
Dataset ||--|{ Resource: "Includes"
Dataset ||--o{ Attribution: "Related to entity by"
Dataset ||--o{ "Related resource": "Referenced by"
Dataset ||--o{ Source: "Created using"
Properties
Title |
Description |
Type |
Format |
Required |
|---|---|---|---|---|
id |
string |
Required |
||
Dataset identifier |
A unique identifier for the dataset. Use of an HTTP URI is recommended. For more information, see how to assign a dataset identifier. |
|||
title |
string |
Required |
||
Title |
The title of the dataset. |
|||
description |
string |
Required |
||
Description |
A short description of the dataset. |
|||
risk_data_type |
array[string] |
Required |
||
Risk data type |
The types of risk data included in the dataset, from the closed risk_data_type codelist. |
|||
publisher |
object |
Required |
||
Publisher |
The entity responsible for making the dataset available. |
|||
version |
string |
|||
Dataset version |
The version indicator (name or identifier) of the dataset. |
|||
purpose |
string |
|||
Dataset purpose |
The purpose for which the dataset was created. |
|||
project |
object |
|||
Project |
Information about the project that produced the dataset. |
|||
project/name |
string |
Required |
||
Project name |
The name of the project that produced the dataset. |
|||
project/url |
string |
iri |
||
Project URL |
A URL associated with the project. |
|||
details |
string |
|||
Additional details |
Additional details about the dataset. |
|||
resources |
array[Resource] |
Required |
||
Resources |
Information about the resources included in the dataset. See Resource |
|||
spatial |
object |
Required |
||
Spatial coverage |
The geographical area covered by the dataset. If specified using coordinates, the use of See Spatial coverage |
|||
spatial_resolution |
number |
|||
Spatial resolution |
The minimum spatial separation resolvable amongst this dataset’s resources, measured in meters. The spatial coverage and resolution of the resources belonging to a dataset may differ, therefore the minimum spatial resolution of the dataset may not be resolvable for all resources. For more information, refer to spatial and temporal properties. |
|||
temporal |
object |
|||
Temporal coverage |
The period of time covered by the dataset. The temporal coverage of the resources belonging to a dataset may differ and may be non-contiguous. For more information, refer to spatial and temporal properties. |
|||
temporal/start |
string |
|||
Start |
The start of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported. |
|||
temporal/end |
string |
|||
End date |
The end of the period. A date (YYYY-MM-DD) is recommended. However, year-months (YYYY-MM) and years (YYYY) are supported. |
|||
temporal/duration |
string |
duration |
||
Duration |
The duration of the period in ISO 8601 duration format, e.g. ‘P50Y’ for 50 years |
|||
temporal/central_year |
integer |
|||
Central year |
The central or representative year as a single point in time rather than a period (e.g., ‘2050’ representing the period 2040-2060). Use this instead of start/end when data represents conditions centered on a specific year. |
|||
temporal_resolution |
string |
duration |
||
Temporal resolution |
The minimum period of time resolvable amongst this dataset’s resources, in ISO8601 duration format. The temporal coverage and resolution of the resources belonging to a dataset may differ, therefore the minimum temporal resolution of the dataset may not be resolvable for all resources. For more information, refer to spatial and temporal properties. |
|||
license |
string |
Required |
||
License |
The license under which this dataset is made available, from the open license codelist. This can be a URL to a legal document (e.g., https://creativecommons.org/licenses/by/4.0/) or a text description (e.g., ‘Commercial license’, ‘Proprietary’). When licensing a dataset, a Public Domain Dedication or Open Definition Conformant license is recommended. Documents linked from this dataset can be made available under other license conditions. |
|||
rights |
string |
|||
Rights |
Information about rights held in and over the source, including access rights and usage restrictions. This field may contain a rights management statement or reference a service providing such information. For detailed license terms, use the |
|||
contact_point |
object |
Required |
||
Contact point |
Contact information for the maintainer of the dataset. |
|||
creator |
object |
Required |
||
Creator |
The entity responsible for producing the dataset. |
|||
attributions |
array[Attribution] |
|||
Attributions |
Information about entities and their roles in relation to the dataset. See Attribution |
|||
lineage |
object |
|||
Lineage |
Information about the provenance of the dataset, including the inputs used and the transformation processes applied to create the dataset. |
|||
lineage/description |
string |
|||
Description |
A free-text description of the provenance of the dataset. Provenance includes processing steps (e.g., corrections, transformations, algorithms), the tools or software used, and the personnel involved. For example, clipping a source dataset or model to a specific geographic region, resampling to a different resolution, or reprojecting to a different CRS. |
|||
lineage/sources |
array[Source] |
|||
Sources |
The data sources and other inputs used to create the dataset. See Source |
|||
referenced_by |
array[Related resource] |
|||
Referenced by |
Related resources, such as publications, that reference, cite, or otherwise point to the dataset. See Related resource |
|||
hazard |
object |
|||
Hazard metadata |
Metadata that is specific to datasets that describe natural processes or phenomena that may cause loss of life, injury or other health impacts, property damage, social and economic disruption or environmental degradation. See Hazard metadata |
|||
exposure |
array[Exposure item] |
|||
Exposure metadata |
Metadata that is specific to datasets that describe the situation of people, infrastructure, housing, production capacities and other tangible human assets that might be located in hazard-prone areas. |
|||
vulnerability |
object |
|||
Vulnerability metadata |
Metadata that is specific to datasets that describe the vulnerability relationships in relation to specific hazards, or geospatial indices associated with the chance of suffering losses from hazard events. |
|||
loss |
object |
|||
Loss metadata |
Metadata that is specific to datasets that describe probabilistic risk or empirical measures of impact in the form of damage or destruction caused by a disaster. See Loss metadata |
|||
links |
array[Link] |
|||
Links |
Links to related resources. The purpose of this field is to declare the version of the RDLS schema that describes the metadata. The first item in the links array must be a link to the canonical URL of the RDLS JSON schema with relation type ‘describedby’. Subsequent items must conform to an IANA link relation type other than ‘describedby’. To link to sources of information that contribute to the creation of the dataset or to related resources that point to the dataset, use |
|||
links/0/href |
string |
iri |
Required |
|
Link target |
The URL of this related resource. |
|||
links/0/rel |
object |
Required |
||
None |
||||
Publisher, contact point and creator
Title |
Description |
Type |
Format |
Required |
|---|---|---|---|---|
name |
string |
Required |
||
Name |
A name for the entity. |
|||
email |
string |
|||
Email address |
An email address for the entity. |
|||
url |
string |
iri |
||
URL |
A URL associated with the entity. |
|||
affiliation |
object |
|||
Affiliation |
The organization or institution with which the entity is affiliated. |
|||
affiliation/name |
string |
Required |
||
Affiliation name |
The name of the affiliated organization. |
|||
affiliation/url |
string |
iri |
||
Affiliation URL |
A URL for the affiliated organization. Preferably use a ROR (Research Organization Registry) identifier (e.g., https://ror.org/example). |
|||
Spatial coverage
Title |
Description |
Type |
Format |
Required |
|---|---|---|---|---|
scale |
string |
|||
Spatial scale |
The spatial scale of the geographical area, from the closed spatial scale codelist. |
|||
countries |
array[string] |
|||
Countries |
The countries covered by the geographical area, from the closed country codelist. |
|||
gazetteer_entries |
array[Gazetteer entry] |
|||
Gazetteer entries |
Entries from geographical indices or directories describing the geographical area. This field should be used to describe sub-national coverage. Use of ISO 3166-2 is recommended. |
|||
gazetteer_entries/0/id |
string |
Required |
||
Gazetteer entry identifier |
An identifier drawn from the gazetteer identified in |
|||
gazetteer_entries/0/scheme |
string |
|||
Scheme |
The gazetteer from which the entry is drawn, from the open location gazetteers codelist. |
|||
gazetteer_entries/0/description |
string |
|||
Description |
A description for the gazetteer entry. |
|||
gazetteer_entries/0/uri |
string |
iri |
||
Uniform resource locator |
A URI for the gazetteer entry. |
|||
bbox |
array[number] |
|||
Bounding box |
A geographic bounding box delimiting the geographical area. This field is an array of numbers. It must contain exactly four numbers with the first two numbers being the longitude and latitude of the most southwesterly point and the second two numbers being the longitude and latitude of the most northeasterly point. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84. |
|||
centroid |
array[number] |
|||
Centroid |
The coordinates of the centre of the geographical area. This field is an array of numbers. It must contain exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84. |
|||
Attribution
Title |
Description |
Type |
Format |
Required |
|---|---|---|---|---|
id |
string |
Required |
||
Attribution identifier |
A locally unique identifier for the attribution. |
|||
entity |
object |
Required |
||
Entity |
An entity with a role in relation to the dataset. |
|||
entity/name |
string |
Required |
||
Name |
A name for the entity. |
|||
entity/email |
string |
|||
Email address |
An email address for the entity. |
|||
entity/url |
string |
iri |
||
URL |
A URL associated with the entity. |
|||
entity/affiliation |
object |
|||
Affiliation |
The organization or institution with which the entity is affiliated. |
|||
entity/affiliation/name |
string |
Required |
||
Affiliation name |
The name of the affiliated organization. |
|||
entity/affiliation/url |
string |
iri |
||
Affiliation URL |
A URL for the affiliated organization. Preferably use a ROR (Research Organization Registry) identifier (e.g., https://ror.org/example). |
|||
role |
string |
Required |
||
Role |
The entity’s role in relation to the dataset, using the open roles codelist. |
|||
Source
Title |
Description |
Type |
Format |
Required |
|---|---|---|---|---|
id |
string |
Required |
||
Source identifier |
A locally unique identifier for the source. |
|||
name |
string |
|||
Name |
The name or title of the source. |
|||
url |
string |
iri |
||
URL |
The uniform resource locator for the source, e.g. the web address at which the source can be accessed. |
|||
citation |
string |
|||
Citation |
The bibliographic citation for the source. This should follow standard citation formats and include authors, year, title, publisher, and other relevant information. |
|||
type |
string |
|||
Type |
The nature of the source, from the closed source_type codelist. |
|||
risk_data_type |
array[string] |
|||
Risk data type |
The types of risk data included in the source, from the closed risk_data_type codelist. |
|||
used_in |
string |
|||
Used in |
The types of risk data produced using the source as an input, from the closed risk_data_type codelist. |
|||
license |
string |
|||
License |
The license under which the source data is made available, from the open license codelist. This can be a URL to a legal document or a text description (e.g., ‘Commercial license’, ‘Proprietary’). |
|||
rights |
string |
|||
Rights |
Information about rights held in and over the source, including access rights and usage restrictions. This field may contain a rights management statement or reference a service providing such information. For detailed license terms, use the |
|||