CSVW for energy datasets

From EERAdata Wiki
Revision as of 12:43, 7 October 2022 by Valerias (talk | contribs) (Worked example)
Jump to: navigation, search

This page collects examples of improving the FAIRness of datasets using the csv extension csvw. Most importantly, csv on the web offers a possibility to tie together metadata and data, starting from a well-known and widely used data format. The standard offers a rich framework to annotate existing csv documents with additional information and transform them into other forms of structured data exchange formats such as JSON(-ld) and RDF. At the same time, csv on the web is user-friendly offering a flexible mechanism from minimal FAIR extensions to elaborated context building for the data to be shared. CSV on the web is a W3C recommendation in coherence with ...

FAIR principles

The example illustrates how csv on the web contributes to realize the FAIR principles

To be Findable:

F1. (meta)data are assigned a globally unique and eternally persistent identifier.

F2. data are described with rich metadata.

F3. (meta)data are registered or indexed in a searchable resource.

F4. metadata specify the data identifier.

To be Accessible:

A1 (meta)data are retrievable by their identifier using a standardized communications protocol.

A1.1 the protocol is open, free, and universally implementable.

A1.2 the protocol allows for an authentication and authorization procedure, where necessary.

A2 metadata are accessible, even when the data are no longer available.

To be Interoperable:

I1. (meta)data use a formal, accessible, shared, and broadly applicable language for knowledge representation.

I2. (meta)data use vocabularies that follow FAIR principles.

I3. (meta)data include qualified references to other (meta)data.

To be Re-usable:

R1. (meta)data have a plurality of accurate and relevant attributes.

R1.1. (meta)data are released with a clear and accessible data usage license.

R1.2. (meta)data are associated with their provenance.

R1.3. (meta)data meet domain-relevant community standards.

Worked example

We start with a csv file whose contents are shown in this table:

Name status year of foundation national identifier Street address city postal code C/O lat lon website Activity National industrial sector classification (if no other information on area of activity available) Purpose (original language) Purpose (translation) date of removal country code Legal Form
Kvarkenvinden 1 active 1998-01-27 769602-8096 Norra Obbolavägen 89 Umeå 904 22 63.80667 20.27364 http://kvarkenvinden.se wind onshore 35110 Föreningen har till ändamål att främja sina medlemmars ekonomiska intressen och dess miljöintresse genom att utöva driftsansvar över vindkraftverk i syfte att tillhandahålla vindenergi för medlemmarnas konsumtion. All genom föreningen genererad vindenergi ägs av medlemmarna. The purpose of the association is to promote the financial interests of its members and its environmental interests by exercising operational responsibility for wind turbines in order to provide wind energy for the members' consumption. All wind energy generated by the association is owned by the members. SWE C61P
Ollebacken vind ekonomiska förening active 2008-01-08 769618-1010 SIKÅS NORRA BYVÄGEN 180 Hammerdal 833 49 63.67432 15.06297 https://www.ollebackenvind.se wind onshore 35110 Föreningen har till ändamål att främja medlemmarans ekonomiska intressen genom att i egen regi producera miljö vänlig energi. The purpose of the association is to promote the members' financial interests by producing environmentally friendly energy on their own. SWE C61P
Jamtkulingen ekonomiska förening active 2009-01-20 769619-7420 Södra Strandvägen 19 A Frösön 832 44 Sven Erik Eriksson 63.17622 14.61152 http://www.jamtkulingen.se/ wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig energi. The purpose of the association is to promote the members' financial interests by producing environmentally friendly energy on their own. SWE C61P
Hällingarna Vind active 2005-08-02 769612-8318 OLLEBACKEN 130 Hammerdal 833 49 63.59838 15.05107 wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig engeri. Medlemmarna deltar i verksamheten som konsumenter. The purpose of the association is to promote the members' financial interests by producing environmentally friendly areas on their own. The members participate in the business as consumers. SWE C61P
Offerdalsvind Ekonomiska förening active 2000-08-31 769606-0719 BERGE 718, Offerdal 835 97 63.46154 14.09483 http://www.offerdalsvind.se wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig energi. Medlemmarna deltar i verksamheten som konsumenter. The purpose of the association is to promote the members' financial interests by producing environmentally friendly areas on their own. The members participate in the business as consumers. SWE C61P
Trärike vindkraft ekonomisk förening liquidation 1996-08-07 769601-6331 VIKINGAVÄGEN 36 Sundsvall 857 41 62.40317 17.26335 http://www.trarikevindkraft.se/index.htm wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intresse genom att förse medlemmarna med egen vindkraft- producerad el och även främja medlemmarnas miljöintresse och vindkraftens utveckling. Föreningen skall bygga upp ett kapital som säkrar uppbyggnad, drift, underhåll och demontering av föreningens vindkraftverk. The purpose of the association is to promote the members 'financial interest by providing the members with their own wind-powered electricity and also promoting the members' environmental interest and the development of wind power. The association will build up a capital that ensures the construction, operation, maintenance and dismantling of the association's wind turbines. SWE C61P
Dala Vindkraft Ekonomisk förening active 2006-02-18 769613-8911 RIKSVÄGEN 15 Rättvik 795 32 60.88933 15.11092 http://dalavind.se/vindandelar-foreningar/dala-vindkraft-ekonomisk-forening/medlemsinformation wind onshore, E-trade 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen, samt deras miljöintresse, genom att tillhandahålla medlemmarna egen vindkraftsproducerad elkraft. The purpose of the association is to promote the members' financial interests, as well as their environmental interests, by providing the members with their own wind-powered electricity. SWE C61P
Vindela active 2004-08-17 769611-2411 BOX 4 Malung 782 21 60.6834 13.71603 http://dalavind.se/vindandelar-foreningar/vindela/ wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig elkraft. The purpose of the association is to promote the members' financial interests by producing environmentally friendly electricity on their own. SWE C61P
Äppelbovind active 2000-09-25 769606-1485 BOX 4 Malung 782 21 60.6834 13.71603 http://dalavind.se/vindandelar-foreningar/appelbovind/kontakt/ wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig elkraft. The purpose of the association is to promote the members' financial interests by producing environmentally friendly electricity on their own. SWE C61P
Fjällbergsvind ekonomisk förening liquidation 2005-09-13 769613-0587 Djupuddsvägen 35 Grängesberg 772 40 60.08136 14.98449 http://dalavind.se/vindandelar-foreningar/fjallbergs-vind-ekonomiskforening wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att tillhandahålla medlemmarna egen vindkrafts- producerad elkraft. The purpose of the association is to promote the members' financial interests by providing the members with their own wind power produced electricity. SWE C61P
Kyrkvinden ekonomiska förening active 2005-05-09 769613-0025 GIMOGATAN 6 B 3TR Uppsala 752 20 59.8687 17.6083 https://www.kyrkvinden.se wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att förmedla och i egen regi eller genom samarbetspartner producera miljövänlig elkraft. The purpose of the association is to promote the members' financial interests by conveying, on their own account or through partners, environmentally friendly electricity SWE C61P
Ljusterö Vind ekonomiska förening active 2008-04-02 769618-5961 LJUSTERÖ TORG Ljusterö 184 95 59.52403 18.60869 http://www.ljusterovind.se/ wind onshore 35110 Föreningen har till ändamål att främja medlemmarnas ekonomiska intressen genom att i egen regi producera miljövänlig energi samt annan därmed förenlig verksamhet. Medlemmarna deltar i verksamheten som konsumenter. The purpose of the association is to promote the members' financial interests by producing environmentally friendly energy and other related activities on their own behalf. The members participate in the business as consumers. SWE C61P
Windy ekonomisk förening active 2000-12-11 769606-4802 SVARTEDALSBACKEN 9 Lerum 443 39 Mattias Skjöldebrandt 57.76418 12.26767 http://windy-vindkraft.se/ wind onshore 35110 Föreningen har till ändamål att främja medlemmarna ekonomiska intressen genom att tillhandahålla medlemmarna egen vindkraft- producerad el, därigenom också främjande medlemmarnas intresse för miljö och energihushållning samt bedriva därmed förenlig verksamhet. The purpose of the association is to promote the members 'financial interests by providing the members with their own electricity produced by wind power, thereby also promoting the members' interest in the environment and energy management, and conducting compatible activities therewith. SWE C61P

The csv file contains information on the name of the initiatives, its legal status, its year of foundation, its national identifier, its street address, the city it is located in, the corresponding postal code, a possible C/O information, a latitude geo-information of the location (lat), a longitude geo-information of the location (lon), the website of the initiatives, some information for activities, a national industrial sector classification, a purpose statement in original language, the same purpose statement translated to English, the date of removal, the country code, and its legal form. To relate metadata information to this information in the csv file, we create a second file containing this metadata. The file format for this metadata information file is json. Let us assume that the csv file itself has the filename "SWE_initiatives_sample.csv". According to the csv on the web standard, the metadata file should have the filename "SWE_initiatives_sample.csv-metadata.json". A minimal form of the metadata file contains the following information

  {
     "@context": "http://www.w3.org/ns/csvw",
     "url": "SWE_initiatives_sample.csv"
  }    
 

The @context information links to the language conventions of the csvw standard, the url information states the filename of the csv file. This minimal file can be extended to contain more specific metadata. All entries are encoded in the form of property specifications and corresponding values.

   {
    "@context": "http://www.w3.org/ns/csvw",
    "url": "SWE_initiatives_sample.csv"
    "dc:title": "Example - list of citizen-led initiatives in Sweden",
    "dc:description": "List of citizen-led initiatives in Sweden, example dataset to be used for illustrating the use of csv on the web",
    "dc:creator": {
	"schema:name": "August Wierling",
	"schema:url": "https://orcid.org/0000-0002-7443-7593",
	"schema:contactPoint": { "email": "augustw@hvl.no}
    }
 

As in the example above, property specifications can be terms from popular metadata vocabularies. E.g. the Dublin Core, schema.org, or DCAT vocabulary can be used. All of these vocabularies can be used independently or together. In the above example, metadata terms from the Dublin core vocabulary are mixed with terms from schema.org. The title of the csv file, and its description are stated using the Dublin core terms. The information inside of the dc:creator term contains information which in turn is specified using the schema.org vocabulary. Information about the creator is given in more detail specifying a human-readable name of the creator, a url of the creator (here: his orcid number), and contact point details such as the email. The contact point information can be extended using also a telephone or a fax number.

The date follows ISO 8601. The language is specified following RFC 4646. For the media type, RFC 7111 has being used as a specification. The type is taken according to the DCMI type vocabulary

Resources