diff --git a/docs/changelog.md b/docs/changelog.md index 1b6a906..25789d1 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -19,11 +19,12 @@ This section documents all notable changes for each graph version. --- -### v6.1.0 +### v6.0.0 _Start Date: 2023-07-26 • Release Date: 2023-08-16 • Dump release: **yes**_ #### Changed +- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType - BIP! indicators are now serialised as an array; see the updated model [here](/data-model/entities/other#bipindicators) - Crossref dump from June 2023 - ORCID works without a DOI from June 2023 @@ -33,7 +34,8 @@ _Start Date: 2023-07-26 • Release Date: 2023-08-16 • Dump release: **y - BIP! indicators from June 2023 - New Datasources/Services were added, collected from an updated EOSC Service catalogue endpoint -### v6.0.0 + +### v5.2.0 _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **no**_ #### Added @@ -42,7 +44,6 @@ _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **n #### Changed -- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType - Removed the numerical prefix from the OpenAIRE identifiers (```"20|openorgs____::..." --> "openorgs____::..."```) - Dataset file names in the Zenodo depositions changed from `dump` to `dataset` - Crossref dump from May 2023 diff --git a/versioned_docs/version-6.1.0/api/_category_.json b/versioned_docs/version-5.2.0/api/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/api/_category_.json rename to versioned_docs/version-5.2.0/api/_category_.json diff --git a/versioned_docs/version-6.1.0/api/api.md b/versioned_docs/version-5.2.0/api/api.md similarity index 100% rename from versioned_docs/version-6.1.0/api/api.md rename to versioned_docs/version-5.2.0/api/api.md diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-1.png b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-1.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-1.png rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-1.png diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-1.zip b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-1.zip similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-1.zip rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-1.zip diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-2.png b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-2.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-2.png rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-2.png diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-2.zip b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-2.zip similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-2.zip rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-2.zip diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-3.png b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-3.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-3.png rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-3.png diff --git a/versioned_docs/version-6.1.0/assets/badges/openaire-badge-3.zip b/versioned_docs/version-5.2.0/assets/badges/openaire-badge-3.zip similarity index 100% rename from versioned_docs/version-6.1.0/assets/badges/openaire-badge-3.zip rename to versioned_docs/version-5.2.0/assets/badges/openaire-badge-3.zip diff --git a/versioned_docs/version-6.1.0/assets/img/aggregation.png b/versioned_docs/version-5.2.0/assets/img/aggregation.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/aggregation.png rename to versioned_docs/version-5.2.0/assets/img/aggregation.png diff --git a/versioned_docs/version-6.1.0/assets/img/architecture.png b/versioned_docs/version-5.2.0/assets/img/architecture.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/architecture.png rename to versioned_docs/version-5.2.0/assets/img/architecture.png diff --git a/versioned_docs/version-6.1.0/assets/img/data-model-2.png b/versioned_docs/version-5.2.0/assets/img/data-model-2.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/data-model-2.png rename to versioned_docs/version-5.2.0/assets/img/data-model-2.png diff --git a/versioned_docs/version-6.1.0/assets/img/data-model.png b/versioned_docs/version-5.2.0/assets/img/data-model.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/data-model.png rename to versioned_docs/version-5.2.0/assets/img/data-model.png diff --git a/versioned_docs/version-6.1.0/assets/img/decisiontree-dataset-orp.png b/versioned_docs/version-5.2.0/assets/img/decisiontree-dataset-orp.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/decisiontree-dataset-orp.png rename to versioned_docs/version-5.2.0/assets/img/decisiontree-dataset-orp.png diff --git a/versioned_docs/version-6.1.0/assets/img/decisiontree-organization.png b/versioned_docs/version-5.2.0/assets/img/decisiontree-organization.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/decisiontree-organization.png rename to versioned_docs/version-5.2.0/assets/img/decisiontree-organization.png diff --git a/versioned_docs/version-6.1.0/assets/img/decisiontree-publication.png b/versioned_docs/version-5.2.0/assets/img/decisiontree-publication.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/decisiontree-publication.png rename to versioned_docs/version-5.2.0/assets/img/decisiontree-publication.png diff --git a/versioned_docs/version-6.1.0/assets/img/decisiontree-software.png b/versioned_docs/version-5.2.0/assets/img/decisiontree-software.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/decisiontree-software.png rename to versioned_docs/version-5.2.0/assets/img/decisiontree-software.png diff --git a/versioned_docs/version-6.1.0/assets/img/dedup-relation-fixup.png b/versioned_docs/version-5.2.0/assets/img/dedup-relation-fixup.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/dedup-relation-fixup.png rename to versioned_docs/version-5.2.0/assets/img/dedup-relation-fixup.png diff --git a/versioned_docs/version-6.1.0/assets/img/dedup-results.png b/versioned_docs/version-5.2.0/assets/img/dedup-results.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/dedup-results.png rename to versioned_docs/version-5.2.0/assets/img/dedup-results.png diff --git a/versioned_docs/version-6.1.0/assets/img/deduplication-workflow.png b/versioned_docs/version-5.2.0/assets/img/deduplication-workflow.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/deduplication-workflow.png rename to versioned_docs/version-5.2.0/assets/img/deduplication-workflow.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_datasource.png b/versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_datasource.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_datasource.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_datasource.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_selconstraints.png b/versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_selconstraints.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_selconstraints.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_selconstraints.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_subject.png b/versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_subject.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_subject.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_subject.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_zenodo.png b/versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_zenodo.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/bulktagging_zenodo.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/bulktagging_zenodo.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/organization_tree.png b/versioned_docs/version-5.2.0/assets/img/enrichment/organization_tree.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/organization_tree.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/organization_tree.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_affiliationistrepo.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_affiliationistrepo.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_affiliationistrepo.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_affiliationistrepo.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_country.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_country.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_country.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_country.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_orcid.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_orcid.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_orcid.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_orcid.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_organizationsemrel.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_organizationsemrel.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_organizationsemrel.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_organizationsemrel.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttocommunitythroughorganization.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttocommunitythroughorganization.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttocommunitythroughorganization.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttocommunitythroughorganization.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttocommunitythroughsemrel.png diff --git a/versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttoproject.png b/versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttoproject.png similarity index 100% rename from versioned_docs/version-6.1.0/assets/img/enrichment/propagation_resulttoproject.png rename to versioned_docs/version-5.2.0/assets/img/enrichment/propagation_resulttoproject.png diff --git a/versioned_docs/version-6.1.0/changelog.md b/versioned_docs/version-5.2.0/changelog.md similarity index 84% rename from versioned_docs/version-6.1.0/changelog.md rename to versioned_docs/version-5.2.0/changelog.md index 1b6a906..23fd806 100644 --- a/versioned_docs/version-6.1.0/changelog.md +++ b/versioned_docs/version-5.2.0/changelog.md @@ -19,21 +19,7 @@ This section documents all notable changes for each graph version. --- -### v6.1.0 -_Start Date: 2023-07-26 • Release Date: 2023-08-16 • Dump release: **yes**_ - -#### Changed - -- BIP! indicators are now serialised as an array; see the updated model [here](/data-model/entities/other#bipindicators) -- Crossref dump from June 2023 -- ORCID works without a DOI from June 2023 -- Usage counts from June 2023 -- Datacite contents from June 2023 -- OpenCitations relations from January 2023 -- BIP! indicators from June 2023 -- New Datasources/Services were added, collected from an updated EOSC Service catalogue endpoint - -### v6.0.0 +### v5.2.0 _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **no**_ #### Added @@ -42,7 +28,6 @@ _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **n #### Changed -- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType - Removed the numerical prefix from the OpenAIRE identifiers (```"20|openorgs____::..." --> "openorgs____::..."```) - Dataset file names in the Zenodo depositions changed from `dump` to `dataset` - Crossref dump from May 2023 diff --git a/versioned_docs/version-6.1.0/data-model/_category_.json b/versioned_docs/version-5.2.0/data-model/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/data-model/_category_.json rename to versioned_docs/version-5.2.0/data-model/_category_.json diff --git a/versioned_docs/version-6.1.0/data-model/data-model.md b/versioned_docs/version-5.2.0/data-model/data-model.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/data-model.md rename to versioned_docs/version-5.2.0/data-model/data-model.md diff --git a/versioned_docs/version-6.1.0/data-model/entities/_category_.json b/versioned_docs/version-5.2.0/data-model/entities/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/data-model/entities/_category_.json rename to versioned_docs/version-5.2.0/data-model/entities/_category_.json diff --git a/versioned_docs/version-6.1.0/data-model/entities/community.md b/versioned_docs/version-5.2.0/data-model/entities/community.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/entities/community.md rename to versioned_docs/version-5.2.0/data-model/entities/community.md diff --git a/versioned_docs/version-6.1.0/data-model/entities/data-source.md b/versioned_docs/version-5.2.0/data-model/entities/data-source.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/entities/data-source.md rename to versioned_docs/version-5.2.0/data-model/entities/data-source.md diff --git a/versioned_docs/version-6.1.0/data-model/entities/organization.md b/versioned_docs/version-5.2.0/data-model/entities/organization.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/entities/organization.md rename to versioned_docs/version-5.2.0/data-model/entities/organization.md diff --git a/versioned_docs/version-6.1.0/data-model/entities/other.md b/versioned_docs/version-5.2.0/data-model/entities/other.md similarity index 86% rename from versioned_docs/version-6.1.0/data-model/entities/other.md rename to versioned_docs/version-5.2.0/data-model/entities/other.md index a5ddcf1..6e792b3 100644 --- a/versioned_docs/version-6.1.0/data-model/entities/other.md +++ b/versioned_docs/version-5.2.0/data-model/entities/other.md @@ -201,55 +201,6 @@ Scheme of reference for access right code. Currently, always set to COAR access "scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/" ``` -## BipIndicator - -The different impact indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/). - - -### indicator -_Type: String • Cardinality: ONE_ - -The name of indicator; it can be either one of: -* `influence`: it reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). -* `influence_alt`: it is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). -* `popularity`: it reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. -* `popularity_alt`: it is an alternative to the "Popularity" indicator, which also reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. -* `impulse`: it reflects the initial momentum of an article directly after its publication, based on the underlying citation network. - -For more details on how these indicators are calculated, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators). - -```json -"influence": { - "score": "123", - "class": "C2" -} -``` - -### class -_Type: String • Cardinality: ONE_ - -The impact class assigned based on the indicator score. - -To facilitate comprehension, BIP! also offers impact classes for articles, to group together those that have similar impact. The following 5 classes are provided: -* `C1`: Top 0.01% -* `C2`: Top 0.1% -* `C3`: Top 1% -* `C4`: Top 10% -* `C5`: Bottom 90% - -```json -"class": "C2" -``` - -### score -_Type: String • Cardinality: ONE_ - -The actual indicator score. - -```json -"score": "1234" -``` - ## Container This field has information about the conference or journal where the result has been presented or published. @@ -659,41 +610,36 @@ These are indicators computed for a specific OpenAIRE result. Each Indicator object is composed of the following properties: -### bipIndicators -_Type: [BipIndicator](#bipindicator) • Cardinality: MANY_ +### impactMeasures +_Type: [ImpactMeasures](#impactmeasures-1) • Cardinality: ONE_ These impact-based indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), estimate the impact of a result. For details about their calculation, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators). ```json -"bipIndicators": [ - { - "indicator": "influence", +"impactMeasures": { + "influence": { "score": "123", "class": "C2" }, - { - "indicator": "influence_alt", - "score": "456", - "class": "C3" + "influence_alt" : { + "score": "456", + "class": "C3" }, - { - "indicator": "popularity", - "score": "234", - "class": "C1" + "popularity": { + "score": "234", + "class": "C1" }, - { - "indicator": "popularity_alt", - "score": "345", - "class": "C5" + "popularity_alt": { + "score": "345", + "class": "C5" }, - { - "indicator": "impulse", + "impulse": { "score": "987", "class": "C3" } -] +} ``` ### usageCounts @@ -701,8 +647,6 @@ _Type: [UsageCounts](#usagecounts-1) • Cardinality: ONE_ These measures, computed by the [UsageCounts Service](https://usagecounts.openaire.eu/), are based on usage statistics. -Please refer [here](/graph-production-workflow/indicators-ingestion/usage-counts) for more details. - ```json "usageCounts":{ "downloads": "10", @@ -730,6 +674,76 @@ Language label in English. "label": "English" ``` +## ImpactMeasures + +The different impact-based indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/). + +### influence +_Type: [Score](#score) • Cardinality: ONE_ + +This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). +For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#pagerank-pr). + +```json +"influence": { + "score": "123", + "class": "C2" +} +``` + +### influence_alt +_Type: [Score](#score) • Cardinality: ONE_ + +This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). +For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#citation-count-cc). + +```json +"influence_alt" :{ + "score": "456", + "class": "C3" +} +``` + +### popularity +_Type: [Score](#score) • Cardinality: ONE_ + +This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. +For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#attrank). + +```json +"popularity":{ + "score": "234", + "class": "C1" +} + +``` + +### popularity_alt +_Type: [Score](#score) • Cardinality: ONE_ + +This is an alternative to the "Popularity" indicator, which also reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. +For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#ram). + +```json +"popularity_alt":{ + "score": "345", + "class": "C5" +} + +``` + +### impulse +_Type: [Score](#score) • Cardinality: ONE_ + +This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network. +For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#incubation-citation-count-icc). + +```json +"impulse":{ + "score": "987", + "class": "C3" +} +``` ## OrganizationPid @@ -813,6 +827,33 @@ The value expressed in the scheme (i.e. 10.1000/182). "value": "10.21511/bbs.13(3).2018.13" ``` +## Score +The specific score object for each calculated impact measure calculated by [BIP!](https://bip.imsi.athenarc.gr/). + +### score +_Type: String • Cardinality: ONE_ + +The actual indicator score. + +```json +"score": "1234" +``` + +### class +_Type: String • Cardinality: ONE_ + +The impact class assigned based on the indicator score. + +To facilitate comprehension, BIP! also offers impact classes for articles, to group together those that have similar impact. The following 5 classes are provided: +* `C1`: Top 0.01% +* `C2`: Top 0.1% +* `C3`: Top 1% +* `C4`: Top 10% +* `C5`: Bottom 90% + +```json +"class": "C2" +``` ## Subject Represents keywords associated to the result. diff --git a/versioned_docs/version-6.1.0/data-model/entities/project.md b/versioned_docs/version-5.2.0/data-model/entities/project.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/entities/project.md rename to versioned_docs/version-5.2.0/data-model/entities/project.md diff --git a/versioned_docs/version-6.1.0/data-model/entities/result.md b/versioned_docs/version-5.2.0/data-model/entities/result.md similarity index 95% rename from versioned_docs/version-6.1.0/data-model/entities/result.md rename to versioned_docs/version-5.2.0/data-model/entities/result.md index b84e49e..05b9008 100644 --- a/versioned_docs/version-6.1.0/data-model/entities/result.md +++ b/versioned_docs/version-5.2.0/data-model/entities/result.md @@ -184,43 +184,35 @@ Date when the embargo ends and this result turns Open Access. ``` ### indicators -_Type: [Indicator](other#indicator-1) • Cardinality: ONE_ +_Type: [Indicator](other#indicator) • Cardinality: ONE_ The indicators computed for this result; -currently, the following types of indicators are supported: - -* [Impact indicators by BIP!](other#bipindicators) -* [Usage Statistics indicators](other#usagecounts) +currently, the following two types of indicators are supported: [impact indicators](/graph-production-workflow/indicators-ingestion/impact-indicators) and [usage statistics indicators](/graph-production-workflow/indicators-ingestion/usage-counts). ```json "indicators": { - "bipIndicators": [ - { - "indicator": "influence", + "impactMeasures": { + "influence": { "score": "123", "class": "C2" }, - { - "indicator": "influence_alt", + "influence_alt" : { "score": "456", "class": "C3" }, - { - "indicator": "popularity", + "popularity": { "score": "234", "class": "C1" }, - { - "indicator": "popularity_alt", + "popularity_alt": { "score": "345", "class": "C5" }, - { - "indicator": "impulse", + "impulse": { "score": "987", "class": "C3" } - ], + }, "usageCounts": { "downloads": "10", "views": "20" diff --git a/versioned_docs/version-6.1.0/data-model/pids-and-identifiers.md b/versioned_docs/version-5.2.0/data-model/pids-and-identifiers.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/pids-and-identifiers.md rename to versioned_docs/version-5.2.0/data-model/pids-and-identifiers.md diff --git a/versioned_docs/version-6.1.0/data-model/relationships/relationship-object.md b/versioned_docs/version-5.2.0/data-model/relationships/relationship-object.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/relationships/relationship-object.md rename to versioned_docs/version-5.2.0/data-model/relationships/relationship-object.md diff --git a/versioned_docs/version-6.1.0/data-model/relationships/relationship-types.md b/versioned_docs/version-5.2.0/data-model/relationships/relationship-types.md similarity index 100% rename from versioned_docs/version-6.1.0/data-model/relationships/relationship-types.md rename to versioned_docs/version-5.2.0/data-model/relationships/relationship-types.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/cfhb.md b/versioned_docs/version-5.2.0/downloads/alternative-model/cfhb.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/cfhb.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/cfhb.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/communityInstance.md b/versioned_docs/version-5.2.0/downloads/alternative-model/communityInstance.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/communityInstance.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/communityInstance.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/context.md b/versioned_docs/version-5.2.0/downloads/alternative-model/context.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/context.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/context.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/extendedresult.md b/versioned_docs/version-5.2.0/downloads/alternative-model/extendedresult.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/extendedresult.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/extendedresult.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/funder.md b/versioned_docs/version-5.2.0/downloads/alternative-model/funder.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/funder.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/funder.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/project.md b/versioned_docs/version-5.2.0/downloads/alternative-model/project.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/project.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/project.md diff --git a/versioned_docs/version-6.1.0/downloads/alternative-model/validated.md b/versioned_docs/version-5.2.0/downloads/alternative-model/validated.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/alternative-model/validated.md rename to versioned_docs/version-5.2.0/downloads/alternative-model/validated.md diff --git a/versioned_docs/version-6.1.0/downloads/beginners-kit.md b/versioned_docs/version-5.2.0/downloads/beginners-kit.md similarity index 95% rename from versioned_docs/version-6.1.0/downloads/beginners-kit.md rename to versioned_docs/version-5.2.0/downloads/beginners-kit.md index 39421cf..e9f4ae8 100644 --- a/versioned_docs/version-6.1.0/downloads/beginners-kit.md +++ b/versioned_docs/version-5.2.0/downloads/beginners-kit.md @@ -4,9 +4,9 @@ sidebar_position: 2 # Beginner's kit - +::: The large size of the OpenAIRE Graph is a major impediment for beginners to familiarise with the underlying data model and explore its contents. Working with the Graph in its full size typically requires access to a huge distributed computing infrastructure which cannot be easily accessible to everyone. diff --git a/versioned_docs/version-6.1.0/downloads/full-graph.md b/versioned_docs/version-5.2.0/downloads/full-graph.md similarity index 99% rename from versioned_docs/version-6.1.0/downloads/full-graph.md rename to versioned_docs/version-5.2.0/downloads/full-graph.md index e009aed..11e46f1 100644 --- a/versioned_docs/version-6.1.0/downloads/full-graph.md +++ b/versioned_docs/version-5.2.0/downloads/full-graph.md @@ -4,9 +4,9 @@ sidebar_position: 1 # Full graph dump - +::: You can download the full OpenAIRE Graph Dump as well as its schema from the following links: diff --git a/versioned_docs/version-6.1.0/downloads/related-datasets.md b/versioned_docs/version-5.2.0/downloads/related-datasets.md similarity index 100% rename from versioned_docs/version-6.1.0/downloads/related-datasets.md rename to versioned_docs/version-5.2.0/downloads/related-datasets.md diff --git a/versioned_docs/version-6.1.0/downloads/subgraphs.md b/versioned_docs/version-5.2.0/downloads/subgraphs.md similarity index 99% rename from versioned_docs/version-6.1.0/downloads/subgraphs.md rename to versioned_docs/version-5.2.0/downloads/subgraphs.md index 3f6668b..7fd5e97 100644 --- a/versioned_docs/version-6.1.0/downloads/subgraphs.md +++ b/versioned_docs/version-5.2.0/downloads/subgraphs.md @@ -4,9 +4,9 @@ sidebar_position: 3 # Sub-graph dumps - +::: In order to facilitate users, different dumps are available under the Zenodo community called [OpenAIRE Graph](https://zenodo.org/communities/openaire-research-graph). This page lists all alternative dumps currently available. diff --git a/versioned_docs/version-6.1.0/faq.md b/versioned_docs/version-5.2.0/faq.md similarity index 100% rename from versioned_docs/version-6.1.0/faq.md rename to versioned_docs/version-5.2.0/faq.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/_category_.json b/versioned_docs/version-5.2.0/graph-production-workflow/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/_category_.json rename to versioned_docs/version-5.2.0/graph-production-workflow/_category_.json diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/aggregation.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/aggregation.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/aggregation.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/aggregation.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/compatible-sources.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/compatible-sources.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/compatible-sources.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/compatible-sources.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/datacite.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/datacite.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/datacite.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/datacite.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/doiboost.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/doiboost.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/doiboost.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/doiboost.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/ebi.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/ebi.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/ebi.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/ebi.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/pubmed.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/pubmed.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/pubmed.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/pubmed.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/uniprot.md b/versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/uniprot.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/aggregation/non-compatible-sources/uniprot.md rename to versioned_docs/version-5.2.0/graph-production-workflow/aggregation/non-compatible-sources/uniprot.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/cleaning.md b/versioned_docs/version-5.2.0/graph-production-workflow/cleaning.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/cleaning.md rename to versioned_docs/version-5.2.0/graph-production-workflow/cleaning.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduction-and-propagation/bulk-tagging.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduction-and-propagation/bulk-tagging.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduction-and-propagation/bulk-tagging.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduction-and-propagation/bulk-tagging.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduction-and-propagation/propagation.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduction-and-propagation/propagation.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduction-and-propagation/propagation.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduction-and-propagation/propagation.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduplication/_category_.json b/versioned_docs/version-5.2.0/graph-production-workflow/deduplication/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduplication/_category_.json rename to versioned_docs/version-5.2.0/graph-production-workflow/deduplication/_category_.json diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduplication/clustering-functions.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduplication/clustering-functions.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduplication/clustering-functions.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduplication/clustering-functions.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduplication/deduplication.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduplication/deduplication.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduplication/deduplication.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduplication/deduplication.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduplication/organizations.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduplication/organizations.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduplication/organizations.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduplication/organizations.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/deduplication/research-products.md b/versioned_docs/version-5.2.0/graph-production-workflow/deduplication/research-products.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/deduplication/research-products.md rename to versioned_docs/version-5.2.0/graph-production-workflow/deduplication/research-products.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/_category_.json b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/_category_.json similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/_category_.json rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/_category_.json diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/acks.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/acks.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/acks.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/acks.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/affiliation_matching.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/affiliation_matching.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/affiliation_matching.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/affiliation_matching.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/citation_matching.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/citation_matching.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/citation_matching.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/citation_matching.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/cites.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/cites.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/cites.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/cites.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/classifies.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/classifies.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/classifies.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/classifies.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/documents_similarity.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/documents_similarity.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/documents_similarity.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/documents_similarity.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/enrichment-by-mining.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/enrichment-by-mining.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/enrichment-by-mining.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/enrichment-by-mining.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/img.png b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/img.png similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/img.png rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/img.png diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/metadata_extraction.md b/versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/metadata_extraction.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/enrichment-by-mining/metadata_extraction.md rename to versioned_docs/version-5.2.0/graph-production-workflow/enrichment-by-mining/metadata_extraction.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/finalisation.md b/versioned_docs/version-5.2.0/graph-production-workflow/finalisation.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/finalisation.md rename to versioned_docs/version-5.2.0/graph-production-workflow/finalisation.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/graph-production-workflow.md b/versioned_docs/version-5.2.0/graph-production-workflow/graph-production-workflow.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/graph-production-workflow.md rename to versioned_docs/version-5.2.0/graph-production-workflow/graph-production-workflow.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/indexing.md b/versioned_docs/version-5.2.0/graph-production-workflow/indexing.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/indexing.md rename to versioned_docs/version-5.2.0/graph-production-workflow/indexing.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/impact-indicators.md b/versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/impact-indicators.md similarity index 93% rename from versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/impact-indicators.md rename to versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/impact-indicators.md index a1bfdc3..6c90186 100644 --- a/versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/impact-indicators.md +++ b/versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/impact-indicators.md @@ -1,12 +1,12 @@ # Impact indicators -This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [bipIndicators](/data-model/entities/other#bipindicators) property (found under the [indicators](/data-model/entities/result#indicators) property of the result). +This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [impactMeasures](/data-model/entities/other#impactmeasures) property (found under the [indicators](/data-model/entities/result#indicators) property of the result). It should be noted that the impact indicators are being calculated on the level of the research output. Below we explain their main intuition, the way they are calculated, and their most important limitations, in an attempt help avoiding common pitfalls and misuses. -## Citation Count (CC) • influence_alt +## Citation Count (CC) ***Short description:*** This is the most widely used scientific impact indicator, which sums all citations received by each article. @@ -31,7 +31,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## "Incubation" Citation Count (iCC) • impulse +## "Incubation" Citation Count (iCC) ***Short description:*** This measure is essentially a time-restricted version of the citation count, where the time window is distinct for each paper, i.e., @@ -58,7 +58,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) - ## PageRank (PR) • influence + ## PageRank (PR) ***Short description:*** Originally developed to rank Web pages, PageRank has been also widely used to rank publications in citation @@ -97,7 +97,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## RAM • popularity_alt +## RAM ***Short description:*** RAM is essentially a modified Citation Count, where recent citations are considered of higher importance compared to older ones. @@ -131,7 +131,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## AttRank • popularity +## AttRank ***Short description:*** AttRank is a PageRank variant that alleviates its bias against recent publications (i.e., it is tailored to capture popularity). diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/indicators-ingestion.md b/versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/indicators-ingestion.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/indicators-ingestion.md rename to versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/indicators-ingestion.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/usage-counts.md b/versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/usage-counts.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/indicators-ingestion/usage-counts.md rename to versioned_docs/version-5.2.0/graph-production-workflow/indicators-ingestion/usage-counts.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/merge-by-id.md b/versioned_docs/version-5.2.0/graph-production-workflow/merge-by-id.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/merge-by-id.md rename to versioned_docs/version-5.2.0/graph-production-workflow/merge-by-id.md diff --git a/versioned_docs/version-6.1.0/graph-production-workflow/stats.md b/versioned_docs/version-5.2.0/graph-production-workflow/stats.md similarity index 100% rename from versioned_docs/version-6.1.0/graph-production-workflow/stats.md rename to versioned_docs/version-5.2.0/graph-production-workflow/stats.md diff --git a/versioned_docs/version-6.1.0/intro.md b/versioned_docs/version-5.2.0/intro.md similarity index 100% rename from versioned_docs/version-6.1.0/intro.md rename to versioned_docs/version-5.2.0/intro.md diff --git a/versioned_docs/version-6.1.0/license.md b/versioned_docs/version-5.2.0/license.md similarity index 100% rename from versioned_docs/version-6.1.0/license.md rename to versioned_docs/version-5.2.0/license.md diff --git a/versioned_docs/version-6.1.0/publications.md b/versioned_docs/version-5.2.0/publications.md similarity index 100% rename from versioned_docs/version-6.1.0/publications.md rename to versioned_docs/version-5.2.0/publications.md diff --git a/versioned_docs/version-6.0.0/changelog.md b/versioned_docs/version-6.0.0/changelog.md index 62dced9..25789d1 100644 --- a/versioned_docs/version-6.0.0/changelog.md +++ b/versioned_docs/version-6.0.0/changelog.md @@ -20,6 +20,22 @@ This section documents all notable changes for each graph version. --- ### v6.0.0 +_Start Date: 2023-07-26 • Release Date: 2023-08-16 • Dump release: **yes**_ + +#### Changed + +- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType +- BIP! indicators are now serialised as an array; see the updated model [here](/data-model/entities/other#bipindicators) +- Crossref dump from June 2023 +- ORCID works without a DOI from June 2023 +- Usage counts from June 2023 +- Datacite contents from June 2023 +- OpenCitations relations from January 2023 +- BIP! indicators from June 2023 +- New Datasources/Services were added, collected from an updated EOSC Service catalogue endpoint + + +### v5.2.0 _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **no**_ #### Added @@ -28,7 +44,6 @@ _Start Date: 2023-07-03 • Release Date: 2023-07-17 • Dump release: **n #### Changed -- [Relationship data model](/data-model/relationships/relationship-object): flattened properties source, sourceType, target, targetType - Removed the numerical prefix from the OpenAIRE identifiers (```"20|openorgs____::..." --> "openorgs____::..."```) - Dataset file names in the Zenodo depositions changed from `dump` to `dataset` - Crossref dump from May 2023 diff --git a/versioned_docs/version-6.0.0/data-model/entities/other.md b/versioned_docs/version-6.0.0/data-model/entities/other.md index 6e792b3..a5ddcf1 100644 --- a/versioned_docs/version-6.0.0/data-model/entities/other.md +++ b/versioned_docs/version-6.0.0/data-model/entities/other.md @@ -201,6 +201,55 @@ Scheme of reference for access right code. Currently, always set to COAR access "scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/" ``` +## BipIndicator + +The different impact indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/). + + +### indicator +_Type: String • Cardinality: ONE_ + +The name of indicator; it can be either one of: +* `influence`: it reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). +* `influence_alt`: it is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). +* `popularity`: it reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. +* `popularity_alt`: it is an alternative to the "Popularity" indicator, which also reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. +* `impulse`: it reflects the initial momentum of an article directly after its publication, based on the underlying citation network. + +For more details on how these indicators are calculated, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators). + +```json +"influence": { + "score": "123", + "class": "C2" +} +``` + +### class +_Type: String • Cardinality: ONE_ + +The impact class assigned based on the indicator score. + +To facilitate comprehension, BIP! also offers impact classes for articles, to group together those that have similar impact. The following 5 classes are provided: +* `C1`: Top 0.01% +* `C2`: Top 0.1% +* `C3`: Top 1% +* `C4`: Top 10% +* `C5`: Bottom 90% + +```json +"class": "C2" +``` + +### score +_Type: String • Cardinality: ONE_ + +The actual indicator score. + +```json +"score": "1234" +``` + ## Container This field has information about the conference or journal where the result has been presented or published. @@ -610,36 +659,41 @@ These are indicators computed for a specific OpenAIRE result. Each Indicator object is composed of the following properties: -### impactMeasures -_Type: [ImpactMeasures](#impactmeasures-1) • Cardinality: ONE_ +### bipIndicators +_Type: [BipIndicator](#bipindicator) • Cardinality: MANY_ These impact-based indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), estimate the impact of a result. For details about their calculation, please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators). ```json -"impactMeasures": { - "influence": { +"bipIndicators": [ + { + "indicator": "influence", "score": "123", "class": "C2" }, - "influence_alt" : { - "score": "456", - "class": "C3" + { + "indicator": "influence_alt", + "score": "456", + "class": "C3" }, - "popularity": { - "score": "234", - "class": "C1" + { + "indicator": "popularity", + "score": "234", + "class": "C1" }, - "popularity_alt": { - "score": "345", - "class": "C5" + { + "indicator": "popularity_alt", + "score": "345", + "class": "C5" }, - "impulse": { + { + "indicator": "impulse", "score": "987", "class": "C3" } -} +] ``` ### usageCounts @@ -647,6 +701,8 @@ _Type: [UsageCounts](#usagecounts-1) • Cardinality: ONE_ These measures, computed by the [UsageCounts Service](https://usagecounts.openaire.eu/), are based on usage statistics. +Please refer [here](/graph-production-workflow/indicators-ingestion/usage-counts) for more details. + ```json "usageCounts":{ "downloads": "10", @@ -674,76 +730,6 @@ Language label in English. "label": "English" ``` -## ImpactMeasures - -The different impact-based indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/). - -### influence -_Type: [Score](#score) • Cardinality: ONE_ - -This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). -For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#pagerank-pr). - -```json -"influence": { - "score": "123", - "class": "C2" -} -``` - -### influence_alt -_Type: [Score](#score) • Cardinality: ONE_ - -This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically). -For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#citation-count-cc). - -```json -"influence_alt" :{ - "score": "456", - "class": "C3" -} -``` - -### popularity -_Type: [Score](#score) • Cardinality: ONE_ - -This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. -For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#attrank). - -```json -"popularity":{ - "score": "234", - "class": "C1" -} - -``` - -### popularity_alt -_Type: [Score](#score) • Cardinality: ONE_ - -This is an alternative to the "Popularity" indicator, which also reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network. -For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#ram). - -```json -"popularity_alt":{ - "score": "345", - "class": "C5" -} - -``` - -### impulse -_Type: [Score](#score) • Cardinality: ONE_ - -This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network. -For more details please refer [here](/graph-production-workflow/indicators-ingestion/impact-indicators#incubation-citation-count-icc). - -```json -"impulse":{ - "score": "987", - "class": "C3" -} -``` ## OrganizationPid @@ -827,33 +813,6 @@ The value expressed in the scheme (i.e. 10.1000/182). "value": "10.21511/bbs.13(3).2018.13" ``` -## Score -The specific score object for each calculated impact measure calculated by [BIP!](https://bip.imsi.athenarc.gr/). - -### score -_Type: String • Cardinality: ONE_ - -The actual indicator score. - -```json -"score": "1234" -``` - -### class -_Type: String • Cardinality: ONE_ - -The impact class assigned based on the indicator score. - -To facilitate comprehension, BIP! also offers impact classes for articles, to group together those that have similar impact. The following 5 classes are provided: -* `C1`: Top 0.01% -* `C2`: Top 0.1% -* `C3`: Top 1% -* `C4`: Top 10% -* `C5`: Bottom 90% - -```json -"class": "C2" -``` ## Subject Represents keywords associated to the result. diff --git a/versioned_docs/version-6.0.0/data-model/entities/result.md b/versioned_docs/version-6.0.0/data-model/entities/result.md index 05b9008..b84e49e 100644 --- a/versioned_docs/version-6.0.0/data-model/entities/result.md +++ b/versioned_docs/version-6.0.0/data-model/entities/result.md @@ -184,35 +184,43 @@ Date when the embargo ends and this result turns Open Access. ``` ### indicators -_Type: [Indicator](other#indicator) • Cardinality: ONE_ +_Type: [Indicator](other#indicator-1) • Cardinality: ONE_ The indicators computed for this result; -currently, the following two types of indicators are supported: [impact indicators](/graph-production-workflow/indicators-ingestion/impact-indicators) and [usage statistics indicators](/graph-production-workflow/indicators-ingestion/usage-counts). +currently, the following types of indicators are supported: + +* [Impact indicators by BIP!](other#bipindicators) +* [Usage Statistics indicators](other#usagecounts) ```json "indicators": { - "impactMeasures": { - "influence": { + "bipIndicators": [ + { + "indicator": "influence", "score": "123", "class": "C2" }, - "influence_alt" : { + { + "indicator": "influence_alt", "score": "456", "class": "C3" }, - "popularity": { + { + "indicator": "popularity", "score": "234", "class": "C1" }, - "popularity_alt": { + { + "indicator": "popularity_alt", "score": "345", "class": "C5" }, - "impulse": { + { + "indicator": "impulse", "score": "987", "class": "C3" } - }, + ], "usageCounts": { "downloads": "10", "views": "20" diff --git a/versioned_docs/version-6.0.0/downloads/beginners-kit.md b/versioned_docs/version-6.0.0/downloads/beginners-kit.md index e9f4ae8..39421cf 100644 --- a/versioned_docs/version-6.0.0/downloads/beginners-kit.md +++ b/versioned_docs/version-6.0.0/downloads/beginners-kit.md @@ -4,9 +4,9 @@ sidebar_position: 2 # Beginner's kit -:::caution + The large size of the OpenAIRE Graph is a major impediment for beginners to familiarise with the underlying data model and explore its contents. Working with the Graph in its full size typically requires access to a huge distributed computing infrastructure which cannot be easily accessible to everyone. diff --git a/versioned_docs/version-6.0.0/downloads/full-graph.md b/versioned_docs/version-6.0.0/downloads/full-graph.md index 11e46f1..e009aed 100644 --- a/versioned_docs/version-6.0.0/downloads/full-graph.md +++ b/versioned_docs/version-6.0.0/downloads/full-graph.md @@ -4,9 +4,9 @@ sidebar_position: 1 # Full graph dump -:::caution + You can download the full OpenAIRE Graph Dump as well as its schema from the following links: diff --git a/versioned_docs/version-6.0.0/downloads/subgraphs.md b/versioned_docs/version-6.0.0/downloads/subgraphs.md index 7fd5e97..3f6668b 100644 --- a/versioned_docs/version-6.0.0/downloads/subgraphs.md +++ b/versioned_docs/version-6.0.0/downloads/subgraphs.md @@ -4,9 +4,9 @@ sidebar_position: 3 # Sub-graph dumps -:::caution + In order to facilitate users, different dumps are available under the Zenodo community called [OpenAIRE Graph](https://zenodo.org/communities/openaire-research-graph). This page lists all alternative dumps currently available. diff --git a/versioned_docs/version-6.0.0/graph-production-workflow/indicators-ingestion/impact-indicators.md b/versioned_docs/version-6.0.0/graph-production-workflow/indicators-ingestion/impact-indicators.md index 6c90186..a1bfdc3 100644 --- a/versioned_docs/version-6.0.0/graph-production-workflow/indicators-ingestion/impact-indicators.md +++ b/versioned_docs/version-6.0.0/graph-production-workflow/indicators-ingestion/impact-indicators.md @@ -1,12 +1,12 @@ # Impact indicators -This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [impactMeasures](/data-model/entities/other#impactmeasures) property (found under the [indicators](/data-model/entities/result#indicators) property of the result). +This page summarises all calculated impact indicators, provided by [BIP!](https://bip.imsi.athenarc.gr/), which are included in the [bipIndicators](/data-model/entities/other#bipindicators) property (found under the [indicators](/data-model/entities/result#indicators) property of the result). It should be noted that the impact indicators are being calculated on the level of the research output. Below we explain their main intuition, the way they are calculated, and their most important limitations, in an attempt help avoiding common pitfalls and misuses. -## Citation Count (CC) +## Citation Count (CC) • influence_alt ***Short description:*** This is the most widely used scientific impact indicator, which sums all citations received by each article. @@ -31,7 +31,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## "Incubation" Citation Count (iCC) +## "Incubation" Citation Count (iCC) • impulse ***Short description:*** This measure is essentially a time-restricted version of the citation count, where the time window is distinct for each paper, i.e., @@ -58,7 +58,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) - ## PageRank (PR) + ## PageRank (PR) • influence ***Short description:*** Originally developed to rank Web pages, PageRank has been also widely used to rank publications in citation @@ -97,7 +97,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## RAM +## RAM • popularity_alt ***Short description:*** RAM is essentially a modified Citation Count, where recent citations are considered of higher importance compared to older ones. @@ -131,7 +131,7 @@ Also, since some indicators require the publication year for their calculation, ***Authority:*** ATHENA RC • ***License:*** GPL-2.0 • ***Code:*** [BIP! Ranker](https://github.com/athenarc/Bip-Ranker) -## AttRank +## AttRank • popularity ***Short description:*** AttRank is a PageRank variant that alleviates its bias against recent publications (i.e., it is tailored to capture popularity). diff --git a/versioned_sidebars/version-6.1.0-sidebars.json b/versioned_sidebars/version-5.2.0-sidebars.json similarity index 100% rename from versioned_sidebars/version-6.1.0-sidebars.json rename to versioned_sidebars/version-5.2.0-sidebars.json diff --git a/versions.json b/versions.json index 2552162..3f7194c 100644 --- a/versions.json +++ b/versions.json @@ -1,6 +1,6 @@ [ - "6.1.0", "6.0.0", + "5.2.0", "5.1.3", "5.1.2", "5.1.1",