Skip to content

Commit

Permalink
Various textual updates
Browse files Browse the repository at this point in the history
related to issue #53
- add all docs to meta namespace
- address remarks in issue
  • Loading branch information
semanticfire committed Jan 19, 2022
1 parent 5227a3f commit 7664445
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 11 deletions.
12 changes: 6 additions & 6 deletions documentation/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ There is one `sh:property` definition per dimension so the lookup only needs to
<aside class='example' id='relexample' title='Expressing the relation'>

```turtle
PREFIX relation: <https://cube.link/relation/>
PREFIX meta: <https://cube.link/meta/>
[
sh:path <dimension/precision>
Expand All @@ -53,22 +53,22 @@ PREFIX relation: <https://cube.link/relation/>
</aside>

A relation between dimensions is described only with `cube` and `meta` vocabulary. The relation classes itself can be extended based on specific use cases.
The controlled vocabulary introduced with namespace `PREFIX relation: <https://cube.link/relation/>` provides the most common relation Classes, and is proposed as a guideline.
The controlled vocabulary introduced with namespace `PREFIX meta: <https://cube.link/meta/>` provides the most common relation Classes, and is proposed as a guideline.

This is an advanced usage of the cube and increases its complexity. But it gives the expressiveness needed to describe the complex relationship between data in a machine-processable way.

### Classes

#### Cube:Relation {#Relation}
#### meta:Relation {#Relation}

A Cube:Relation resource is used to express the relation between different dimensions, the nature of the relationship is determined by the properties used. A Cube:Relation is linked to an observation through a [cube:relation](#relation) property.
A Cube:Relation resource is used to express the relation between different dimensions, the nature of the relationship is determined by the properties used. A Cube:Relation is linked to an observation through a [meta:relation](#relation) property.
See [this example](#relexample).

### Properties

#### cube:relation {#relation}
#### meta:relation {#relation}

This property is used on a Dimension Constraint to express a relation with other properties through a [Cube:Relation](#Relation) instance, the nature of this relationship is determined by the properties used on the instance.
This property is used on a Dimension Constraint to express a relation with other properties through a [meta:Relation](#Relation) instance, the nature of this relationship is determined by the properties used on the instance.
See [this example](#relexample).

## Nested hierarchies
Expand Down
2 changes: 1 addition & 1 deletion documentation/existingwork.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Existing Work
# Related Work

## RDF Data Cube Vocabulary

Expand Down
4 changes: 2 additions & 2 deletions documentation/visualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ To describe the unit of the values in a dimension the respective `qudt:Unit` ins

#### qudt:scaleType

To provide more information on the statistical property of the scale of measure is described by `qudt:NominalScale`, `qudt:OrdinalScale`, `qudt:IntervalScale` or `qudt:RatioScale` which is attached through `qudt:scaleType` to the [Cube Constraint per Dimension](https://github.com/zazuko/rdf-cube-schema#metadata-and-validation-constraint).
To provide more information on the statistical property scale of measure it can be described by `qudt:NominalScale`, `qudt:OrdinalScale`, `qudt:IntervalScale` or `qudt:RatioScale` which is attached through `qudt:scaleType` to the [Dimension Constraint](#dimensionconstraints).

The different scale types hint about features that can be used for visualization properties:

Expand All @@ -98,7 +98,7 @@ To describe the datatype used by the dimension attach the `shacl:datatype` to th
Be aware that this implies the presence of a typed literal as the dimension value

#### meta:dataKind (temporal / spatial)
Finally to express that the dimension provides a specific _kind_ of data which is necessary to select the correct visual representation we add `https://cube.link/meta/dataKind/` with the following structure possible values:
To express that the dimension provides a specific _kind_ of data which is necessary to select the correct visual representation you can add a `meta:dataKind` resource with the following possible structures:

* [`schema:GeoCoordinates`](https://schema.org/GeoCoordinates): To hint that the dimension does provide Resources with latitude and longitude which can be shown on a map.

Expand Down
1 change: 1 addition & 0 deletions meta/abstract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This vocubulary is intended as a companion vocabulary to the RDF Cube Schema vocabulary.
1 change: 1 addition & 0 deletions meta/core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## Meta vocabulary ##
4 changes: 2 additions & 2 deletions meta/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
<body>
<h1 id='title'>RDF Cube Schema - Meta vocabulary</h1>
<section id='issue-summary'></section>
<section id='abstract' data-include-format="markdown" data-include="documentation/abstract.md"></section>
<section id='abstract' data-include-format="markdown" data-include="abstract.md"></section>
<section id='sotd'> </section>

<section id='core' data-include-format="markdown" data-include="documentation/core.md"></section>
<section id='core' data-include-format="markdown" data-include="core.md"></section>

<section id='references'></section>

Expand Down

0 comments on commit 7664445

Please sign in to comment.