User Tools

Site Tools


public:metadata

Metadata

Who is this guide for

  • Editors
  • Contributors willing to add content to the SmartDublin Data Portal

What this guide teaches

  • What is metadata, and why it is important?
  • Guidelines for creating an accurate metadata
  • Open Development metadata templates

What is metadata, and why is it important?

Metadata is data that describes data.

Imagine you received a parcel. Without having to tear the wrapping paper and open the box, a label on the outside can tell you what's in the parcel. A carefully wrapped parcel without a label might add excitement for the recipient, but data without metadata is not usable. Data is simply numbers and figures. Data doesn’t mean anything without a description, metadata.

For CKAN purposes, data is published in units called “datasets”. A dataset is a parcel of data - for example, it could be the crime statistics for a region, the spending figures for a government department, temperature readings from various weather stations or a reference document.

A dataset contains two things:

  • Metadata that describes information about the data. For example, the title and publisher, date, what formats it is available in, what license it is released under, etc.
  • A number of “resources”, which hold the data itself. CKAN does not mind what format the data is in. A resource can be a CSV or Excel spreadsheet, XML file, PDF document, image file, linked data in RDF format, etc. CKAN can store the resource internally, or store it simply as a link, the resource itself being elsewhere on the web. A dataset can contain any number of resources. For example, different resources might contain the data for different years, or they might contain the same data in different formats.

Example: https://data.smartdublin.ie/dataset/disabled-parking-spaces

Metadata provides important context about an informational asset’s source and manner of creation, as well as in what applications or environments the asset is relevant.

Metadata also has the following purposes:

  • certifies the authenticity and degree of completeness of the content;
  • establishes and documents the context of the content;
  • identifies and exploits the structural relationships within and between information objects;
  • provides a range of intellectual access points for an increasingly diverse range of users.

Guidelines for creating accurate metadata

Information is often imperfect, whether it is produced by members of the SmartDublin team or by others. Details may be missing, badly defined, or even completely wrong. Sometimes it is possible to improve the quality of the information by contacting its source. But even even then, problems may remain.

How may we create an accurate and useful metadata when the information it is describing might be flawed?

We aim to produce, to the best of our ability, accurate metadata by describing the extent of our knowledge the asset/resource. Good metadata should clearly state what is known about the resource and what is not known or problematic. Metadata changes when the asset itself or knowledge about its condition changes.

If information is missing or inconsistent, describe the known inconsistencies or gaps instead of disregarding the resource. Mention any steps being taken to address these issues, along with an expected timeline.

Dublinked metadata template

For each different type of data, there are specific terms that relate to that type of data. On the Datahub 1 type of dataset is currently stored/administered:

  • Dataset (both spatial and non-spatial)

This metadata template was developed by adapting and enhancing the standard CKAN's metadata template.

The template below outlines information that should be included and offers instruction for each metadata field.

Metadata for dataset (both spatial and non-spatial)

public:geospatial_metadata

Other metadata fields exposed by the CKAN API:

Label Field Name (API) Definition Guidelines Example
Type* type Dataset type dataset or library_record dataset
Resources* resources Array with information about resources
Tags* tags Array with information about tags/topics
public/metadata.txt · Last modified: 2021/09/27 13:53 by admin