diff --git a/docs/changelog.md b/docs/changelog.md index c43731d..37c65a5 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -15,7 +15,7 @@ In our case, given a version `MAJOR.MINOR.PATCH`, we increment the: ## Changelog -This section documents all notable changes for each graph version. This page is going to replace the updates listed until the end of 2022 on the OpenAIRE website at https://www.openaire.eu/aggregation-and-content-provision-workflows +This section documents all notable changes for each graph version. --- @@ -73,7 +73,7 @@ _Start Date: 2022-12-19 • Release Date: 2022-12-28 • Dump release: **y - [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result - [Beginner's kit](/downloads/beginners-kit) in the Downloads section -- New relationship types were introduced; see the complete list [here](/data-model/relationships#relationship-types) +- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types) #### Changed diff --git a/docs/data-model/data-model.md b/docs/data-model/data-model.md index 912b436..e5530ca 100644 --- a/docs/data-model/data-model.md +++ b/docs/data-model/data-model.md @@ -1,6 +1,6 @@ # Data model -The OpenAIRE Graph comprises several types of [entities](../category/entities) and [relationships](./relationships) among them. +The OpenAIRE Graph comprises several types of [entities](../category/entities) and [relationships](/category/relationships) among them. The latest version of the JSON schema can be found on the [Downloads](../downloads/full-graph) section. @@ -11,12 +11,12 @@ The latest version of the JSON schema can be found on the [Downloads](../downloa The figure above, presents the graph's data model. Its main entities are described in brief below: -* [Results](entities/result) represent the outcomes (or products) of research activities. -* [Data Sources](entities/data-source) are the sources from which the metadata of graph objects are collected. -* [Organizations](entities/organization) correspond to companies or research institutions involved in projects, +* [Results](/data-model/entities/result) represent the outcomes (or products) of research activities. +* [Data Sources](/data-model/entities/data-source) are the sources from which the metadata of graph objects are collected. +* [Organizations](/data-model/entities/organization) correspond to companies or research institutions involved in projects, responsible for operating data sources or consisting the affiliations of Product creators. -* [Projects](entities/project) are research project grants funded by a Funding Stream of a Funder. -* [Communities](entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances). +* [Projects](/data-model/entities/project) are research project grants funded by a Funding Stream of a Funder. +* [Communities](/data-model/entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances). :::note Further reading diff --git a/docs/data-model/entities/community.md b/docs/data-model/entities/community.md index 5887d81..b1df85e 100644 --- a/docs/data-model/entities/community.md +++ b/docs/data-model/entities/community.md @@ -2,7 +2,7 @@ sidebar_position: 6 --- -# Community +# Communities Research communities and research initiatives are intended as groups of people with a common research intent and can be of two types: ​research initiatives or ​research communities​: diff --git a/docs/data-model/entities/data-source.md b/docs/data-model/entities/data-source.md index 9b68231..8834654 100644 --- a/docs/data-model/entities/data-source.md +++ b/docs/data-model/entities/data-source.md @@ -2,7 +2,7 @@ sidebar_position: 2 --- -# Data source +# Data sources OpenAIRE entity instances are created out of data collected from various data sources of different kinds, such as publication repositories, dataset archives, CRIS systems, funder databases, etc. Data sources export information packages (e.g., XML records, HTTP responses, RDF data, JSON) that may contain information on one or more of such entities and possibly relationships between them. diff --git a/docs/data-model/entities/organization.md b/docs/data-model/entities/organization.md index 61e54eb..ad94c47 100644 --- a/docs/data-model/entities/organization.md +++ b/docs/data-model/entities/organization.md @@ -2,7 +2,7 @@ sidebar_position: 3 --- -# Organization +# Organizations Organizations include companies, research centers or institutions involved as project partners or as responsible of operating data sources. Information about organizations are collected from funder databases like CORDA, registries of data sources like OpenDOAR and re3Data, and CRIS systems, as being related to projects or data sources. diff --git a/docs/data-model/entities/project.md b/docs/data-model/entities/project.md index a03ee7c..e06790d 100644 --- a/docs/data-model/entities/project.md +++ b/docs/data-model/entities/project.md @@ -2,7 +2,7 @@ sidebar_position: 4 --- -# Project +# Projects Of crucial interest to OpenAIRE is also the identification of the funders (e.g. European Commission, WellcomeTrust, FCT Portugal, NWO The Netherlands) that co-funded the projects that have led to a given result. Projects are characterized by a list of funding streams (e.g. FP7, H2020 for the EC), which identify the strands of fundings. Funding streams can be nested to form a tree of sub-funding streams. diff --git a/docs/data-model/entities/result.md b/docs/data-model/entities/result.md index 65dcb94..c650e41 100644 --- a/docs/data-model/entities/result.md +++ b/docs/data-model/entities/result.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Result +# Results Results are intended as digital objects, described by metadata, resulting from a scientific process. In this page, we descibe the properties of the `Result` object. diff --git a/docs/data-model/relationships.md b/docs/data-model/relationships.md deleted file mode 100644 index 18a4875..0000000 --- a/docs/data-model/relationships.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Relationships - -A relationship in the graph is represented by the following data type, which aims to model a directed edge between two nodes, providing information about the semantic of the relation, its provenance and validation. - ---- - -## The `Relationship` object - -### source -_Type: [Node](#the-node-object) • Cardinality: ONE_ - -Represents the source node in the relation. - -```json -"source": { - "id": "20|openorgs____::1cb75a3ad756e4c83e455e3e7347643b", - "type": "organization" -} -``` - -### target -_Type: [Node](#the-node-object) • Cardinality: ONE_ - -Represents the target node in the relation. - -```json -"target": { - "id": "10|doajarticles::022409068174087a003647ff46070f7f", - "type": "datasource" -} -``` - -### reltype -_Type: [RelType](#the-reltype-object) • Cardinality: ONE_ - -Represent the semantics of the relation between two nodes of the graph. - -```json -"reltype": { - "name": "provides", - "type": "provision" -} -``` -### provenance -_Type: [Provenance](entities/other#provenance-1) • Cardinality: ONE_ - -Indicates the process that produced (or provided) the information. - -```json -"provenance": { - "provenance": "Harvested", - "trust":"0.900" -} -``` - -### validated -_Type: Boolean • Cardinality: ONE_ - -Indicates weather or not the relation was validated. - -```json -"validated": true -``` - -### validationDate -_Type: String • Cardinality: ONE_ - -Indicates the validation date of the relation - applies only when the validated flag is set to true. - -```json -"validationDate": "2022-09-02" -``` - ---- - -## The `Node` object - -The Node data type contains the minimum information needed to identify a graph node, its identifier and entity type. - - -### id -_Type: String • Cardinality: ONE_ - -OpenAIRE identifier of the node in the graph. - -```json -"id": "10|doajarticles::022409068174087a003647ff46070f7f" -``` - -### type -_Type: String • Cardinality: ONE_ - -Graph node type. - -```json -"type": "datasource" -``` - -## The `RelType` object - -The RelType data type models the semantic of the relationship among two nodes. - -### type -_Type: String • Cardinality: ONE_ - -Relation category, e.g. affiliation, citation, see table Relation typologies. - -```json -"name": "provides" -``` - -### name -_Type: String • Cardinality: ONE_ - -Further specifies the relation semantic, indicating the relation direction, e.g. Cites, isCitedBy. - -```json -"type": "provision" -``` ---- - -## Relationship types - -The following table lists all the possible relation semantics found in the graph dump. - -Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them. - -| # | Source entity type | Target entity type | Relation name / inverse | Provenance | -|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:| -| 1 | [Project](entities/project) | [Result](entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user | -| 2 | [Project](entities/project) | [Organization](entities/organization) | hasParticipant / isParticipant | Harvested | -| 3 | [Project](entities/project) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 4 | [Result](entities/result) | [Result](entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE | -| 5 | [Result](entities/result) | [Result](entities/result) | IsSupplementTo / IsSupplementedBy | Harvested | -| 6 | [Result](entities/result) | [Result](entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | -| 7 | [Result](entities/result) | [Result](entities/result) | IsPartOf / HasPart | Harvested | -| 8 | [Result](entities/result) | [Result](entities/result) | IsDocumentedBy / Documents | Harvested | -| 9 | [Result](entities/result) | [Result](entities/result) | IsObsoletedBy / Obsoletes | Harvested | -| 10 | [Result](entities/result) | [Result](entities/result) | IsSourceOf / IsDerivedFrom | Harvested | -| 11 | [Result](entities/result) | [Result](entities/result) | IsCompiledBy / Compiles | Harvested | -| 12 | [Result](entities/result) | [Result](entities/result) | IsRequiredBy / Requires | Harvested | -| 13 | [Result](entities/result) | [Result](entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE | -| 14 | [Result](entities/result) | [Result](entities/result) | IsReferencedBy / References | Harvested | -| 15 | [Result](entities/result) | [Result](entities/result) | IsReviewedBy / Reviews | Harvested | -| 16 | [Result](entities/result) | [Result](entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested | -| 17 | [Result](entities/result) | [Result](entities/result) | IsVersionOf / HasVersion | Harvested | -| 18 | [Result](entities/result) | [Result](entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested | -| 19 | [Result](entities/result) | [Result](entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested | -| 20 | [Result](entities/result) | [Result](entities/result) | IsContinuedBy / Continues | Harvested | -| 21 | [Result](entities/result) | [Result](entities/result) | IsDescribedBy / Describes | Harvested | -| 22 | [Result](entities/result) | [Organization](entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE | -| 23 | [Result](entities/result) | [Data source](entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE | -| 24 | [Result](entities/result) | [Data source](entities/data-source) | isProvidedBy / provides | Harvested | -| 25 | [Result](entities/result) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | -| 26 | [Organization](entities/organization) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 27 | [Organization](entities/organization) | [Organization](entities/organization) | IsChildOf / IsParentOf | Linked by user | -| 28 | [Data source](entities/data-source) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 29 | [Data source](entities/data-source) | [Organization](entities/organization) | isProvidedBy / provides | Harvested | - diff --git a/docs/data-model/relationships/relationship-object.md b/docs/data-model/relationships/relationship-object.md new file mode 100644 index 0000000..252496d --- /dev/null +++ b/docs/data-model/relationships/relationship-object.md @@ -0,0 +1,120 @@ +--- +title: The Relationship object +--- + +# The `Relationship` object + +A relationship in the Graph is represented with the data type presented in this page, which aims to model a directed edge between two nodes, providing information about its semantics, provenance and validation. + +### source +_Type: [Node](#the-node-object) • Cardinality: ONE_ + +Represents the source node in the relation. + +```json +"source": { + "id": "20|openorgs____::1cb75a3ad756e4c83e455e3e7347643b", + "type": "organization" +} +``` + +### target +_Type: [Node](#the-node-object) • Cardinality: ONE_ + +Represents the target node in the relation. + +```json +"target": { + "id": "10|doajarticles::022409068174087a003647ff46070f7f", + "type": "datasource" +} +``` + +### reltype +_Type: [RelType](#the-reltype-object) • Cardinality: ONE_ + +Represent the semantics of the relation between two nodes of the graph. + +```json +"reltype": { + "name": "provides", + "type": "provision" +} +``` +### provenance +_Type: [Provenance](/data-model/entities/other#provenance-1) • Cardinality: ONE_ + +Indicates the process that produced (or provided) the information. + +```json +"provenance": { + "provenance": "Harvested", + "trust":"0.900" +} +``` + +### validated +_Type: Boolean • Cardinality: ONE_ + +Indicates weather or not the relation was validated. + +```json +"validated": true +``` + +### validationDate +_Type: String • Cardinality: ONE_ + +Indicates the validation date of the relation - applies only when the validated flag is set to true. + +```json +"validationDate": "2022-09-02" +``` + +--- + +## The `Node` object + +The Node data type contains the minimum information needed to identify a graph node, its identifier and entity type. + + +### id +_Type: String • Cardinality: ONE_ + +OpenAIRE identifier of the node in the graph. + +```json +"id": "10|doajarticles::022409068174087a003647ff46070f7f" +``` + +### type +_Type: String • Cardinality: ONE_ + +Graph node type. + +```json +"type": "datasource" +``` + +## The `RelType` object + +The RelType data type models the semantic of the relationship among two nodes. + +### type +_Type: String • Cardinality: ONE_ + +Relation category, e.g. affiliation, citation, see table Relation typologies. + +```json +"name": "provides" +``` + +### name +_Type: String • Cardinality: ONE_ + +Further specifies the relation semantic, indicating the relation direction, e.g. Cites, isCitedBy. + +```json +"type": "provision" +``` +--- \ No newline at end of file diff --git a/docs/data-model/relationships/relationship-types.md b/docs/data-model/relationships/relationship-types.md new file mode 100644 index 0000000..55378b3 --- /dev/null +++ b/docs/data-model/relationships/relationship-types.md @@ -0,0 +1,37 @@ +# Relationship types + +The following table lists all the possible relation semantics found in the graph dump. + +Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them. + +| # | Source entity type | Target entity type | Relation name / inverse | Provenance | +|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:| +| 1 | [Project](/data-model/entities/project) | [Result](/data-model/entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user | +| 2 | [Project](/data-model/entities/project) | [Organization](/data-model/entities/organization) | hasParticipant / isParticipant | Harvested | +| 3 | [Project](/data-model/entities/project) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 4 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE | +| 5 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSupplementTo / IsSupplementedBy | Harvested | +| 6 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | +| 7 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPartOf / HasPart | Harvested | +| 8 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDocumentedBy / Documents | Harvested | +| 9 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsObsoletedBy / Obsoletes | Harvested | +| 10 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSourceOf / IsDerivedFrom | Harvested | +| 11 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCompiledBy / Compiles | Harvested | +| 12 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRequiredBy / Requires | Harvested | +| 13 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE | +| 14 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReferencedBy / References | Harvested | +| 15 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReviewedBy / Reviews | Harvested | +| 16 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested | +| 17 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsVersionOf / HasVersion | Harvested | +| 18 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested | +| 19 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested | +| 20 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsContinuedBy / Continues | Harvested | +| 21 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDescribedBy / Describes | Harvested | +| 22 | [Result](/data-model/entities/result) | [Organization](/data-model/entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE | +| 23 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE | +| 24 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isProvidedBy / provides | Harvested | +| 25 | [Result](/data-model/entities/result) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | +| 26 | [Organization](/data-model/entities/organization) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 27 | [Organization](/data-model/entities/organization) | [Organization](/data-model/entities/organization) | IsChildOf / IsParentOf | Linked by user | +| 28 | [Data source](/data-model/entities/data-source) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 29 | [Data source](/data-model/entities/data-source) | [Organization](/data-model/entities/organization) | isProvidedBy / provides | Harvested | diff --git a/docs/graph-production-workflow/merge-by-id.md b/docs/graph-production-workflow/merge-by-id.md index 199500f..72c7ebd 100644 --- a/docs/graph-production-workflow/merge-by-id.md +++ b/docs/graph-production-workflow/merge-by-id.md @@ -12,7 +12,7 @@ This phase is therefore responsible to compensate for such inconsistencies and p a global grouping of every record available in the graph: - entities are grouped by [`id`](../data-model/entities/result#id) -- relations are grouped by [`source`, `target`, `reltype`](../data-model/relationships#the-relationship-object) +- relations are grouped by [`source`, `target`, `reltype`](../data-model/relationships/relationship-object) This ensures that the same record, possibly assigned to different types by different mappings, appears only once in the graph and under a single typing. In case of clashing diff --git a/docs/intro.md b/docs/intro.md index 8f47310..54b32f8 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -6,7 +6,7 @@ sidebar_position: 1 # Overview -The OpenAIRE Graph (formerly known as the OpenAIRE Research Graph) is one of the largest open scholarly record collections worldwide, key in fostering Open Science and establishing its practices in the daily research activities. +The [OpenAIRE Graph](https://graph.openaire.eu/) (formerly known as the OpenAIRE Research Graph) is one of the largest open scholarly record collections worldwide, key in fostering Open Science and establishing its practices in the daily research activities. Conceived as a public and transparent good, populated out of data sources trusted by scientists, the Graph aims at bringing discovery, monitoring, and assessment of science back in the hands of the scientific community. Imagine a vast collection of research products all linked together, contextualised and openly available. For the past years OpenAIRE has been working to gather this valuable record. It is a massive collection of metadata and links between scientific products such as articles, datasets, software, and other research products, entities like organisations, funders, funding streams, projects, communities, and data sources. diff --git a/sidebars.js b/sidebars.js index 3f99733..38a0e8a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -23,7 +23,6 @@ const sidebars = { label: "Data model", link: {type: 'doc', id: 'data-model/data-model'}, items: [ - { type: 'doc', id: 'data-model/pids-and-identifiers' }, { type: 'category', label: "Entities", @@ -40,9 +39,18 @@ const sidebars = { ] }, { - type: 'doc', - id: 'data-model/relationships' - } + type: 'category', + label: "Relationships", + link: { + type: 'generated-index', + description: 'This section describes the relationships between entities in the OpenAIRE Graph: they way they are modelled as well as the different relationship types currently supported.' + }, + items: [ + { type: 'doc', id: 'data-model/relationships/relationship-object' }, + { type: 'doc', id: 'data-model/relationships/relationship-types' }, + ] + }, + { type: 'doc', id: 'data-model/pids-and-identifiers' }, ] }, { diff --git a/versioned_docs/version-5.0.0/changelog.md b/versioned_docs/version-5.0.0/changelog.md index c2a5366..6ac49dd 100644 --- a/versioned_docs/version-5.0.0/changelog.md +++ b/versioned_docs/version-5.0.0/changelog.md @@ -26,7 +26,7 @@ This section will document all notable changes for each graph version. - [Impact indicators](/data-model/entities/result#indicators) at the level of the Result - [Beginner's kit](/downloads/beginners-kit) in the Downloads section -- New relationship types were introduced; see the complete list [here](/data-model/relationships#relationship-types) +- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types) #### Changed diff --git a/versioned_docs/version-5.1.0/changelog.md b/versioned_docs/version-5.1.0/changelog.md index df6e5b5..4248012 100644 --- a/versioned_docs/version-5.1.0/changelog.md +++ b/versioned_docs/version-5.1.0/changelog.md @@ -43,7 +43,7 @@ _Start Date: 2022-12-19 • Release Date: 2022-12-28 • Dump release: **y - [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result - [Beginner's kit](/downloads/beginners-kit) in the Downloads section -- New relationship types were introduced; see the complete list [here](/data-model/relationships#relationship-types) +- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types) #### Changed diff --git a/versioned_docs/version-5.1.1/changelog.md b/versioned_docs/version-5.1.1/changelog.md index 6962ad4..a33f5ac 100644 --- a/versioned_docs/version-5.1.1/changelog.md +++ b/versioned_docs/version-5.1.1/changelog.md @@ -62,7 +62,7 @@ _Start Date: 2022-12-19 • Release Date: 2022-12-28 • Dump release: **y - [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result - [Beginner's kit](/downloads/beginners-kit) in the Downloads section -- New relationship types were introduced; see the complete list [here](/data-model/relationships#relationship-types) +- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types) #### Changed diff --git a/versioned_docs/version-5.1.2/changelog.md b/versioned_docs/version-5.1.2/changelog.md index c43731d..37c65a5 100644 --- a/versioned_docs/version-5.1.2/changelog.md +++ b/versioned_docs/version-5.1.2/changelog.md @@ -15,7 +15,7 @@ In our case, given a version `MAJOR.MINOR.PATCH`, we increment the: ## Changelog -This section documents all notable changes for each graph version. This page is going to replace the updates listed until the end of 2022 on the OpenAIRE website at https://www.openaire.eu/aggregation-and-content-provision-workflows +This section documents all notable changes for each graph version. --- @@ -73,7 +73,7 @@ _Start Date: 2022-12-19 • Release Date: 2022-12-28 • Dump release: **y - [Impact & Usage indicators](/data-model/entities/result#indicators) at the level of the Result - [Beginner's kit](/downloads/beginners-kit) in the Downloads section -- New relationship types were introduced; see the complete list [here](/data-model/relationships#relationship-types) +- New relationship types were introduced; see the complete list [here](/data-model/relationships/relationship-types) #### Changed diff --git a/versioned_docs/version-5.1.2/data-model/data-model.md b/versioned_docs/version-5.1.2/data-model/data-model.md index 912b436..e5530ca 100644 --- a/versioned_docs/version-5.1.2/data-model/data-model.md +++ b/versioned_docs/version-5.1.2/data-model/data-model.md @@ -1,6 +1,6 @@ # Data model -The OpenAIRE Graph comprises several types of [entities](../category/entities) and [relationships](./relationships) among them. +The OpenAIRE Graph comprises several types of [entities](../category/entities) and [relationships](/category/relationships) among them. The latest version of the JSON schema can be found on the [Downloads](../downloads/full-graph) section. @@ -11,12 +11,12 @@ The latest version of the JSON schema can be found on the [Downloads](../downloa The figure above, presents the graph's data model. Its main entities are described in brief below: -* [Results](entities/result) represent the outcomes (or products) of research activities. -* [Data Sources](entities/data-source) are the sources from which the metadata of graph objects are collected. -* [Organizations](entities/organization) correspond to companies or research institutions involved in projects, +* [Results](/data-model/entities/result) represent the outcomes (or products) of research activities. +* [Data Sources](/data-model/entities/data-source) are the sources from which the metadata of graph objects are collected. +* [Organizations](/data-model/entities/organization) correspond to companies or research institutions involved in projects, responsible for operating data sources or consisting the affiliations of Product creators. -* [Projects](entities/project) are research project grants funded by a Funding Stream of a Funder. -* [Communities](entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances). +* [Projects](/data-model/entities/project) are research project grants funded by a Funding Stream of a Funder. +* [Communities](/data-model/entities/community) are groups of people with a common research intent (e.g. research infrastructures, university alliances). :::note Further reading diff --git a/versioned_docs/version-5.1.2/data-model/entities/community.md b/versioned_docs/version-5.1.2/data-model/entities/community.md index 5887d81..b1df85e 100644 --- a/versioned_docs/version-5.1.2/data-model/entities/community.md +++ b/versioned_docs/version-5.1.2/data-model/entities/community.md @@ -2,7 +2,7 @@ sidebar_position: 6 --- -# Community +# Communities Research communities and research initiatives are intended as groups of people with a common research intent and can be of two types: ​research initiatives or ​research communities​: diff --git a/versioned_docs/version-5.1.2/data-model/entities/data-source.md b/versioned_docs/version-5.1.2/data-model/entities/data-source.md index 9b68231..8834654 100644 --- a/versioned_docs/version-5.1.2/data-model/entities/data-source.md +++ b/versioned_docs/version-5.1.2/data-model/entities/data-source.md @@ -2,7 +2,7 @@ sidebar_position: 2 --- -# Data source +# Data sources OpenAIRE entity instances are created out of data collected from various data sources of different kinds, such as publication repositories, dataset archives, CRIS systems, funder databases, etc. Data sources export information packages (e.g., XML records, HTTP responses, RDF data, JSON) that may contain information on one or more of such entities and possibly relationships between them. diff --git a/versioned_docs/version-5.1.2/data-model/entities/organization.md b/versioned_docs/version-5.1.2/data-model/entities/organization.md index 61e54eb..ad94c47 100644 --- a/versioned_docs/version-5.1.2/data-model/entities/organization.md +++ b/versioned_docs/version-5.1.2/data-model/entities/organization.md @@ -2,7 +2,7 @@ sidebar_position: 3 --- -# Organization +# Organizations Organizations include companies, research centers or institutions involved as project partners or as responsible of operating data sources. Information about organizations are collected from funder databases like CORDA, registries of data sources like OpenDOAR and re3Data, and CRIS systems, as being related to projects or data sources. diff --git a/versioned_docs/version-5.1.2/data-model/entities/project.md b/versioned_docs/version-5.1.2/data-model/entities/project.md index a03ee7c..e06790d 100644 --- a/versioned_docs/version-5.1.2/data-model/entities/project.md +++ b/versioned_docs/version-5.1.2/data-model/entities/project.md @@ -2,7 +2,7 @@ sidebar_position: 4 --- -# Project +# Projects Of crucial interest to OpenAIRE is also the identification of the funders (e.g. European Commission, WellcomeTrust, FCT Portugal, NWO The Netherlands) that co-funded the projects that have led to a given result. Projects are characterized by a list of funding streams (e.g. FP7, H2020 for the EC), which identify the strands of fundings. Funding streams can be nested to form a tree of sub-funding streams. diff --git a/versioned_docs/version-5.1.2/data-model/entities/result.md b/versioned_docs/version-5.1.2/data-model/entities/result.md index 65dcb94..c650e41 100644 --- a/versioned_docs/version-5.1.2/data-model/entities/result.md +++ b/versioned_docs/version-5.1.2/data-model/entities/result.md @@ -2,7 +2,7 @@ sidebar_position: 1 --- -# Result +# Results Results are intended as digital objects, described by metadata, resulting from a scientific process. In this page, we descibe the properties of the `Result` object. diff --git a/versioned_docs/version-5.1.2/data-model/relationships.md b/versioned_docs/version-5.1.2/data-model/relationships.md deleted file mode 100644 index 18a4875..0000000 --- a/versioned_docs/version-5.1.2/data-model/relationships.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Relationships - -A relationship in the graph is represented by the following data type, which aims to model a directed edge between two nodes, providing information about the semantic of the relation, its provenance and validation. - ---- - -## The `Relationship` object - -### source -_Type: [Node](#the-node-object) • Cardinality: ONE_ - -Represents the source node in the relation. - -```json -"source": { - "id": "20|openorgs____::1cb75a3ad756e4c83e455e3e7347643b", - "type": "organization" -} -``` - -### target -_Type: [Node](#the-node-object) • Cardinality: ONE_ - -Represents the target node in the relation. - -```json -"target": { - "id": "10|doajarticles::022409068174087a003647ff46070f7f", - "type": "datasource" -} -``` - -### reltype -_Type: [RelType](#the-reltype-object) • Cardinality: ONE_ - -Represent the semantics of the relation between two nodes of the graph. - -```json -"reltype": { - "name": "provides", - "type": "provision" -} -``` -### provenance -_Type: [Provenance](entities/other#provenance-1) • Cardinality: ONE_ - -Indicates the process that produced (or provided) the information. - -```json -"provenance": { - "provenance": "Harvested", - "trust":"0.900" -} -``` - -### validated -_Type: Boolean • Cardinality: ONE_ - -Indicates weather or not the relation was validated. - -```json -"validated": true -``` - -### validationDate -_Type: String • Cardinality: ONE_ - -Indicates the validation date of the relation - applies only when the validated flag is set to true. - -```json -"validationDate": "2022-09-02" -``` - ---- - -## The `Node` object - -The Node data type contains the minimum information needed to identify a graph node, its identifier and entity type. - - -### id -_Type: String • Cardinality: ONE_ - -OpenAIRE identifier of the node in the graph. - -```json -"id": "10|doajarticles::022409068174087a003647ff46070f7f" -``` - -### type -_Type: String • Cardinality: ONE_ - -Graph node type. - -```json -"type": "datasource" -``` - -## The `RelType` object - -The RelType data type models the semantic of the relationship among two nodes. - -### type -_Type: String • Cardinality: ONE_ - -Relation category, e.g. affiliation, citation, see table Relation typologies. - -```json -"name": "provides" -``` - -### name -_Type: String • Cardinality: ONE_ - -Further specifies the relation semantic, indicating the relation direction, e.g. Cites, isCitedBy. - -```json -"type": "provision" -``` ---- - -## Relationship types - -The following table lists all the possible relation semantics found in the graph dump. - -Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them. - -| # | Source entity type | Target entity type | Relation name / inverse | Provenance | -|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:| -| 1 | [Project](entities/project) | [Result](entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user | -| 2 | [Project](entities/project) | [Organization](entities/organization) | hasParticipant / isParticipant | Harvested | -| 3 | [Project](entities/project) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 4 | [Result](entities/result) | [Result](entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE | -| 5 | [Result](entities/result) | [Result](entities/result) | IsSupplementTo / IsSupplementedBy | Harvested | -| 6 | [Result](entities/result) | [Result](entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | -| 7 | [Result](entities/result) | [Result](entities/result) | IsPartOf / HasPart | Harvested | -| 8 | [Result](entities/result) | [Result](entities/result) | IsDocumentedBy / Documents | Harvested | -| 9 | [Result](entities/result) | [Result](entities/result) | IsObsoletedBy / Obsoletes | Harvested | -| 10 | [Result](entities/result) | [Result](entities/result) | IsSourceOf / IsDerivedFrom | Harvested | -| 11 | [Result](entities/result) | [Result](entities/result) | IsCompiledBy / Compiles | Harvested | -| 12 | [Result](entities/result) | [Result](entities/result) | IsRequiredBy / Requires | Harvested | -| 13 | [Result](entities/result) | [Result](entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE | -| 14 | [Result](entities/result) | [Result](entities/result) | IsReferencedBy / References | Harvested | -| 15 | [Result](entities/result) | [Result](entities/result) | IsReviewedBy / Reviews | Harvested | -| 16 | [Result](entities/result) | [Result](entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested | -| 17 | [Result](entities/result) | [Result](entities/result) | IsVersionOf / HasVersion | Harvested | -| 18 | [Result](entities/result) | [Result](entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested | -| 19 | [Result](entities/result) | [Result](entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested | -| 20 | [Result](entities/result) | [Result](entities/result) | IsContinuedBy / Continues | Harvested | -| 21 | [Result](entities/result) | [Result](entities/result) | IsDescribedBy / Describes | Harvested | -| 22 | [Result](entities/result) | [Organization](entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE | -| 23 | [Result](entities/result) | [Data source](entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE | -| 24 | [Result](entities/result) | [Data source](entities/data-source) | isProvidedBy / provides | Harvested | -| 25 | [Result](entities/result) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | -| 26 | [Organization](entities/organization) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 27 | [Organization](entities/organization) | [Organization](entities/organization) | IsChildOf / IsParentOf | Linked by user | -| 28 | [Data source](entities/data-source) | [Community](entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | -| 29 | [Data source](entities/data-source) | [Organization](entities/organization) | isProvidedBy / provides | Harvested | - diff --git a/versioned_docs/version-5.1.2/data-model/relationships/relationship-object.md b/versioned_docs/version-5.1.2/data-model/relationships/relationship-object.md new file mode 100644 index 0000000..252496d --- /dev/null +++ b/versioned_docs/version-5.1.2/data-model/relationships/relationship-object.md @@ -0,0 +1,120 @@ +--- +title: The Relationship object +--- + +# The `Relationship` object + +A relationship in the Graph is represented with the data type presented in this page, which aims to model a directed edge between two nodes, providing information about its semantics, provenance and validation. + +### source +_Type: [Node](#the-node-object) • Cardinality: ONE_ + +Represents the source node in the relation. + +```json +"source": { + "id": "20|openorgs____::1cb75a3ad756e4c83e455e3e7347643b", + "type": "organization" +} +``` + +### target +_Type: [Node](#the-node-object) • Cardinality: ONE_ + +Represents the target node in the relation. + +```json +"target": { + "id": "10|doajarticles::022409068174087a003647ff46070f7f", + "type": "datasource" +} +``` + +### reltype +_Type: [RelType](#the-reltype-object) • Cardinality: ONE_ + +Represent the semantics of the relation between two nodes of the graph. + +```json +"reltype": { + "name": "provides", + "type": "provision" +} +``` +### provenance +_Type: [Provenance](/data-model/entities/other#provenance-1) • Cardinality: ONE_ + +Indicates the process that produced (or provided) the information. + +```json +"provenance": { + "provenance": "Harvested", + "trust":"0.900" +} +``` + +### validated +_Type: Boolean • Cardinality: ONE_ + +Indicates weather or not the relation was validated. + +```json +"validated": true +``` + +### validationDate +_Type: String • Cardinality: ONE_ + +Indicates the validation date of the relation - applies only when the validated flag is set to true. + +```json +"validationDate": "2022-09-02" +``` + +--- + +## The `Node` object + +The Node data type contains the minimum information needed to identify a graph node, its identifier and entity type. + + +### id +_Type: String • Cardinality: ONE_ + +OpenAIRE identifier of the node in the graph. + +```json +"id": "10|doajarticles::022409068174087a003647ff46070f7f" +``` + +### type +_Type: String • Cardinality: ONE_ + +Graph node type. + +```json +"type": "datasource" +``` + +## The `RelType` object + +The RelType data type models the semantic of the relationship among two nodes. + +### type +_Type: String • Cardinality: ONE_ + +Relation category, e.g. affiliation, citation, see table Relation typologies. + +```json +"name": "provides" +``` + +### name +_Type: String • Cardinality: ONE_ + +Further specifies the relation semantic, indicating the relation direction, e.g. Cites, isCitedBy. + +```json +"type": "provision" +``` +--- \ No newline at end of file diff --git a/versioned_docs/version-5.1.2/data-model/relationships/relationship-types.md b/versioned_docs/version-5.1.2/data-model/relationships/relationship-types.md new file mode 100644 index 0000000..55378b3 --- /dev/null +++ b/versioned_docs/version-5.1.2/data-model/relationships/relationship-types.md @@ -0,0 +1,37 @@ +# Relationship types + +The following table lists all the possible relation semantics found in the graph dump. + +Note: the labels used to specify the semantic of the relationships are (for the large) inherited from the [DataCite metadata kernel](https://schema.datacite.org/meta/kernel-4.4/doc/DataCite-MetadataKernel_v4.4.pdf), which provides a description for them. + +| # | Source entity type | Target entity type | Relation name / inverse | Provenance | +|:--:|:--------------------------------------:|:--------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------:| +| 1 | [Project](/data-model/entities/project) | [Result](/data-model/entities/result) | produces / isProducedBy | Harvested, Inferred by OpenAIRE, Linked by user | +| 2 | [Project](/data-model/entities/project) | [Organization](/data-model/entities/organization) | hasParticipant / isParticipant | Harvested | +| 3 | [Project](/data-model/entities/project) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 4 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsAmongTopNSimilarDocuments / HasAmongTopNSimilarDocuments | Inferred by OpenAIRE | +| 5 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSupplementTo / IsSupplementedBy | Harvested | +| 6 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | +| 7 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPartOf / HasPart | Harvested | +| 8 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDocumentedBy / Documents | Harvested | +| 9 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsObsoletedBy / Obsoletes | Harvested | +| 10 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsSourceOf / IsDerivedFrom | Harvested | +| 11 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCompiledBy / Compiles | Harvested | +| 12 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsRequiredBy / Requires | Harvested | +| 13 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsCitedBy / Cites | Harvested, Inferred by OpenAIRE | +| 14 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReferencedBy / References | Harvested | +| 15 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsReviewedBy / Reviews | Harvested | +| 16 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsOriginalFormOf / IsVariantFormOf | Harvested | +| 17 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsVersionOf / HasVersion | Harvested | +| 18 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsIdenticalTo / IsIdenticalTo | Harvested | +| 19 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsPreviousVersionOf / IsNewVersionOf | Harvested | +| 20 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsContinuedBy / Continues | Harvested | +| 21 | [Result](/data-model/entities/result) | [Result](/data-model/entities/result) | IsDescribedBy / Describes | Harvested | +| 22 | [Result](/data-model/entities/result) | [Organization](/data-model/entities/organization) | hasAuthorInstitution / isAuthorInstitutionOf | Harvested, Inferred by OpenAIRE | +| 23 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isHostedBy / hosts | Harvested, Inferred by OpenAIRE | +| 24 | [Result](/data-model/entities/result) | [Data source](/data-model/entities/data-source) | isProvidedBy / provides | Harvested | +| 25 | [Result](/data-model/entities/result) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Harvested, Inferred by OpenAIRE, Linked by user | +| 26 | [Organization](/data-model/entities/organization) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 27 | [Organization](/data-model/entities/organization) | [Organization](/data-model/entities/organization) | IsChildOf / IsParentOf | Linked by user | +| 28 | [Data source](/data-model/entities/data-source) | [Community](/data-model/entities/community) | IsRelatedTo / IsRelatedTo | Linked by user | +| 29 | [Data source](/data-model/entities/data-source) | [Organization](/data-model/entities/organization) | isProvidedBy / provides | Harvested | diff --git a/versioned_docs/version-5.1.2/graph-production-workflow/merge-by-id.md b/versioned_docs/version-5.1.2/graph-production-workflow/merge-by-id.md index 199500f..72c7ebd 100644 --- a/versioned_docs/version-5.1.2/graph-production-workflow/merge-by-id.md +++ b/versioned_docs/version-5.1.2/graph-production-workflow/merge-by-id.md @@ -12,7 +12,7 @@ This phase is therefore responsible to compensate for such inconsistencies and p a global grouping of every record available in the graph: - entities are grouped by [`id`](../data-model/entities/result#id) -- relations are grouped by [`source`, `target`, `reltype`](../data-model/relationships#the-relationship-object) +- relations are grouped by [`source`, `target`, `reltype`](../data-model/relationships/relationship-object) This ensures that the same record, possibly assigned to different types by different mappings, appears only once in the graph and under a single typing. In case of clashing diff --git a/versioned_docs/version-5.1.2/intro.md b/versioned_docs/version-5.1.2/intro.md index 8f47310..54b32f8 100644 --- a/versioned_docs/version-5.1.2/intro.md +++ b/versioned_docs/version-5.1.2/intro.md @@ -6,7 +6,7 @@ sidebar_position: 1 # Overview -The OpenAIRE Graph (formerly known as the OpenAIRE Research Graph) is one of the largest open scholarly record collections worldwide, key in fostering Open Science and establishing its practices in the daily research activities. +The [OpenAIRE Graph](https://graph.openaire.eu/) (formerly known as the OpenAIRE Research Graph) is one of the largest open scholarly record collections worldwide, key in fostering Open Science and establishing its practices in the daily research activities. Conceived as a public and transparent good, populated out of data sources trusted by scientists, the Graph aims at bringing discovery, monitoring, and assessment of science back in the hands of the scientific community. Imagine a vast collection of research products all linked together, contextualised and openly available. For the past years OpenAIRE has been working to gather this valuable record. It is a massive collection of metadata and links between scientific products such as articles, datasets, software, and other research products, entities like organisations, funders, funding streams, projects, communities, and data sources. diff --git a/versioned_sidebars/version-5.1.2-sidebars.json b/versioned_sidebars/version-5.1.2-sidebars.json index 3188c4d..a4ed96e 100644 --- a/versioned_sidebars/version-5.1.2-sidebars.json +++ b/versioned_sidebars/version-5.1.2-sidebars.json @@ -12,10 +12,6 @@ "id": "data-model/data-model" }, "items": [ - { - "type": "doc", - "id": "data-model/pids-and-identifiers" - }, { "type": "category", "label": "Entities", @@ -46,9 +42,27 @@ } ] }, + { + "type": "category", + "label": "Relationships", + "link": { + "type": "generated-index", + "description": "This section describes the relationships between entities in the OpenAIRE Graph: they way they are modelled as well as the different relationship types currently supported." + }, + "items": [ + { + "type": "doc", + "id": "data-model/relationships/relationship-object" + }, + { + "type": "doc", + "id": "data-model/relationships/relationship-types" + } + ] + }, { "type": "doc", - "id": "data-model/relationships" + "id": "data-model/pids-and-identifiers" } ] },