Source and Prov Approaches#

About#

This section will present an identifier discussion and then focus on approaches publishers can use to provide more source and provenance information.This section is heavily influenced by [] [] and the reader is highly encouraged to read these references.

It is not uncommon for a single resource to be described at multiple locations. The following items represent properties that can help address the disambiguation of resources as the Ocean InfoHub graph grows.

We will look at the following seven properties: identifier, provider, publisher, sameAs, isBasesOn, subjectOf and its inverse, about.

It should be noted that only subjectOf and sameAs can be used on type Thing. That is, these properties can be used on any Schema.org type.

The others have their domain and range values listed. All these properties work on CreativeWork. So they are all valid for that type and subtypes like Dataset and Map.

Example Graph#

The following example graph shows some of the properties we can use to provide source and provenance information about a resource.

 1{
 2    "@context": {
 3        "@vocab": "https://schema.org/"
 4    },
 5    "@id": "https://example.org/id/XYZ",
 6    "@type": "CreativeWork",
 7    "url": "https://example.org/url/of/the/item",
 8    "sameAs": "https://doi.org/10.5066/F7VX0DMQ",
 9    "isBasedOn": "https://example.org/id/xyz",
10    "identifier": {
11        "@id": "https://doi.org/10.5066/F7VX0DMQ",
12        "@type": "PropertyValue",
13        "propertyID": "https://registry.identifiers.org/registry/doi",
14        "url": "https://doi.org/10.5066/F7VX0DMQ",
15        "value": "doi:10.5066/F7VX0DMQ"
16    },
17    "subjectOf": {
18        "@type": "CreativeWork",
19        "@id": "http://purl.unep.org/sdg/SDGIO_00020173",
20        "url": "http://www.ontobee.org/ontology/SDGIO?iri=http://purl.unep.org/sdg/SDGIO_00020173",
21        "name": "UNSD SDG indicator code:C140c01",
22        "description": "Number of countries making progress ... the oceans and their resources"
23    },
24    "provider": {
25        "@id": "https://www.sample-data-repository.org",
26        "@type": "Organization",
27        "legalName": "Sample Data Repository Office",
28        "name": "SDRO",
29        "sameAs": "http://www.re3data.org/repository/r3dxxxxxxxxx",
30        "url": "https://www.sample-data-repository.org"
31    },
32    "publisher": {
33        "@id": "https://www.sample-data-repository.org"
34    }
35}
Hide code cell source 
import json
from pyld import jsonld
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)
jbutils.show_graph(compacted)
../../_images/943753fe37bf1971a025072dfe1d42750c9be5edff7f038f335085adfbc3a539.svg

identifier#

This is the main subject of the start of this section. Please refer there for details on this property.

Values expected to be one of these types

Used on these types

Hide code cell source 
import json
from rdflib.extras.external_graph_libs import rdflib_to_networkx_multidigraph
from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
from pyld import jsonld
import graphviz
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

frame = {
  "@context": {"@vocab": "https://schema.org/"},
  "@explicit": "true",
  "@requireAll": "true",
  "@type":     "CreativeWork",
  "identifier": ""
}

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)

framed = jsonld.frame(compacted, frame)
jd = json.dumps(framed, indent=4)
print(jd)

jbutils.show_graph(framed)

{
    "@context": {
        "@vocab": "https://schema.org/"
    },
    "@id": "https://example.org/id/XYZ",
    "@type": "CreativeWork",
    "identifier": {
        "@id": "https://doi.org/10.5066/F7VX0DMQ",
        "@type": "PropertyValue",
        "propertyID": "https://registry.identifiers.org/registry/doi",
        "url": "https://doi.org/10.5066/F7VX0DMQ",
        "value": "doi:10.5066/F7VX0DMQ"
    }
}
../../_images/147685ac70ea2618b862728bb037b0bb07d2f80f0ffd6001204d2b3de1f65aac.svg

propertyID#

A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be (1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific id of the property), or (3) a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry). Standards bodies should promote a standard prefix for the identifiers of properties from their standards.

value#

The value of the quantitative value or property value node. For PropertyValue, it can be ‘Text;’, ‘Number’, ‘Boolean’, or ‘StructuredValue’.

url (pointing to type URL)#

URL of the item.

provider#

schema.org/provider

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

For OIH this is the agent that is responsible for distributing the resource and the descriptive metadata. That is, the provider actually runs and supports the services that presents the resource on the net or otherwise makes the data available.

Values expected to be one of these types

Used on these types

Hide code cell source 
import json
from rdflib.extras.external_graph_libs import rdflib_to_networkx_multidigraph
from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
from pyld import jsonld
import graphviz
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

frame = {
  "@context": {"@vocab": "https://schema.org/"},
  "@explicit": "true",
  "@requireAll": "true",
  "@type":     "CreativeWork",
  "provider": ""
}

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)

framed = jsonld.frame(compacted, frame)
jd = json.dumps(framed, indent=4)
print(jd)

jbutils.show_graph(framed)

{
    "@context": {
        "@vocab": "https://schema.org/"
    },
    "@id": "https://example.org/id/XYZ",
    "@type": "CreativeWork",
    "provider": {
        "@id": "https://www.sample-data-repository.org",
        "@type": "Organization",
        "legalName": "Sample Data Repository Office",
        "name": "SDRO",
        "sameAs": "http://www.re3data.org/repository/r3dxxxxxxxxx",
        "url": "https://www.sample-data-repository.org"
    }
}
../../_images/5fcb373d484863edeca9367c72fc80b1c969f0fb153561546ff5a87deacfa4a0.svg

publisher#

See: schema.org/publisher

The publisher is defined as “The publisher of the creative work”. This is viewed as the agent that is primarily responsible for making the content described by the structured metadata.

Values expected to be one of these types

Used on these types

Hide code cell source 
import json
from rdflib.extras.external_graph_libs import rdflib_to_networkx_multidigraph
from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
from pyld import jsonld
import graphviz
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

frame = {
  "@context": {"@vocab": "https://schema.org/"},
  "@explicit": "true",
  "@requireAll": "true",
  "@type":     "CreativeWork",
  "publisher": ""
}

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)

framed = jsonld.frame(compacted, frame)
jd = json.dumps(framed, indent=4)
print(jd)

jbutils.show_graph(framed)

{
    "@context": {
        "@vocab": "https://schema.org/"
    },
    "@id": "https://example.org/id/XYZ",
    "@type": "CreativeWork",
    "publisher": {
        "@id": "https://www.sample-data-repository.org",
        "@type": "Organization",
        "legalName": "Sample Data Repository Office",
        "name": "SDRO",
        "sameAs": "http://www.re3data.org/repository/r3dxxxxxxxxx",
        "url": "https://www.sample-data-repository.org"
    }
}
../../_images/b113ebb5d595253bc60e6ae3f14dd6b3ffed235e87f2ce4e5d4e15f505f5d664.svg

sameAs#

See: schema.org/sameAs

The sameAs property links a Thing to a URL. It is expected that the URL is a resource that is the the most canonical URL for the original.

In cases where your resource is not the canonical URL, you can use the sameAs property to link to the canonical URL. This is useful when you wish to publish a resource and give credit to the original resource. Note, in this case the resource must not be altered, but actually be the same as the canonical URL resource.

The sameAs property should always point to only one resource. It is not logically consistent to point to multiple sameAs resources.

Values expected to be one of these types

Used on these types

Hide code cell source 
import json
from rdflib.extras.external_graph_libs import rdflib_to_networkx_multidigraph
from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
from pyld import jsonld
import graphviz
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

frame = {
  "@context": {"@vocab": "https://schema.org/"},
  "@explicit": "true",
  "@requireAll": "true",
  "@type":     "CreativeWork",
  "sameAs": ""
}

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)

framed = jsonld.frame(compacted, frame)
jd = json.dumps(framed, indent=4)
print(jd)

jbutils.show_graph(framed)

{
    "@context": {
        "@vocab": "https://schema.org/"
    },
    "@id": "https://example.org/id/XYZ",
    "@type": "CreativeWork",
    "sameAs": "https://doi.org/10.5066/F7VX0DMQ"
}
../../_images/56a2fec34de69f4f0c6a440957d3eafe054f2c743ce7d10870ea9a1ee0d36ec4.svg

isBasedOn#

See: schema.org/isBasedOn

Where sameAs is used to link to the canonical URL of the resource, isBasedOn provides a means to link derivative works to the original resource this new resources is based on.

The isBasedOn property can be used to link to multiple resources if more than one was used in the generation of this new resource.

Values expected to be one of these types

Used on these types

subjectOf and inverse about#

See: schema.org/subjectOf

The property subjectOf of can be used to indicate a resource that is related to the described resource, although not necessarily a part of it. The subjectOf property can be used in an educational framework to indicate the field(s) of science or literature the dataset relates to.

Values expected to be one of these types

Used on these types

The subjectOf property has an inverse-property about. The property about can be used to:

indicate the subject matter this thing is about

Values expected to be one of these types

Used on these types

Hide code cell source 
import json
from rdflib.extras.external_graph_libs import rdflib_to_networkx_multidigraph
from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
from pyld import jsonld
import graphviz
import os, sys

currentdir = os.path.dirname(os.path.abspath(''))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir)
from lib import jbutils

with open("../../../odis-in/dataGraphs/thematics/identifier/graphs/creativework.json") as dgraph:
    doc = json.load(dgraph)

frame = {
  "@context": {"@vocab": "https://schema.org/"},
  "@explicit": "true",
  "@requireAll": "true",
  "@type":     "CreativeWork",
  "subjectOf": ""
}

context = {
    "@vocab": "https://schema.org/",
}

compacted = jsonld.compact(doc, context)

framed = jsonld.frame(compacted, frame)
jd = json.dumps(framed, indent=4)
print(jd)

jbutils.show_graph(framed)

{
    "@context": {
        "@vocab": "https://schema.org/"
    },
    "@id": "https://example.org/id/XYZ",
    "@type": "CreativeWork",
    "subjectOf": {
        "@id": "http://purl.unep.org/sdg/SDGIO_00020173",
        "@type": "CreativeWork",
        "description": "Number of countries making progress ... the oceans and their resources",
        "name": "UNSD SDG indicator code:C140c01",
        "url": "http://www.ontobee.org/ontology/SDGIO?iri=http://purl.unep.org/sdg/SDGIO_00020173"
    }
}
../../_images/d643041cd188862adb7d17baebbfea5feff6bdc41216400377cca6471300c8b4.svg