From d96049a3abac0f693cc5f547fa6fd4503a8ed375 Mon Sep 17 00:00:00 2001 From: Alessia Bardi Date: Wed, 23 Nov 2022 14:33:34 +0100 Subject: [PATCH 1/7] ignore intellij project file --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index e005ae6..19f54c8 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,5 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -.idea/ \ No newline at end of file +.idea/ +openaire-graph-docs.iml \ No newline at end of file From 159f50c9effbd81a5d88697e4d069feb9f3d7fb9 Mon Sep 17 00:00:00 2001 From: Alessia Bardi Date: Wed, 14 Dec 2022 19:01:35 +0100 Subject: [PATCH 2/7] simplified some sentences --- docs/data-model/data-model.md | 8 ++++---- docs/data-model/pids-and-identifiers.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/data-model/data-model.md b/docs/data-model/data-model.md index ae9d453..3a43be6 100644 --- a/docs/data-model/data-model.md +++ b/docs/data-model/data-model.md @@ -11,12 +11,12 @@ The latest version of the JSON schema can be found on [Bulk downloads](../downlo The figure above, presents the graph's data model. Its main entities are described in brief below: -* [Results](entities/result) represent the outcomes of research activities. -* [Data Sources](entities/data-source) are the resources used to collect metadata for the graph objects +* [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, responsible for operating data sources or consisting the affiliations of Product creators. -* [Projects](entities/project) are research projects funded by a Funding Stream of a Funder. -* [Communities](entities/community) are groups of people with a common research intent. +* [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) :::note Further reading diff --git a/docs/data-model/pids-and-identifiers.md b/docs/data-model/pids-and-identifiers.md index a3b7cda..5156beb 100644 --- a/docs/data-model/pids-and-identifiers.md +++ b/docs/data-model/pids-and-identifiers.md @@ -1,8 +1,8 @@ # PIDs and identifiers -One of the challenges towards the stability of the contents in the OpenAIRE Graph consists of making its identifiers and records stable over time. -The barriers to this scenario are many, as the Graph keeps a map of data sources that is subject to constant variations: records in repositories vary in content, -original IDs, and PIDs, may disappear or reappear, and the same holds for the repository or the metadata collection it exposes. +Ensuring the stability of the records and their identifiers in the OpenAIRE Graph is a challenge. +Data sources from which OpenAIRE collects metadata records are subject to constant variations: records in repositories vary in content, +original IDs, and PIDs, may disappear or reappear, and the same holds for the data source itself or the metadata collection it exposes. Not only, but the mappings applied to the original contents may also change and improve over time to catch up with the changes in the input records. ## PID Authorities From 489bfef146a64b6f1e1a022130a92e644921c985 Mon Sep 17 00:00:00 2001 From: "miriam.baglioni" Date: Tue, 27 Dec 2022 11:55:54 +0100 Subject: [PATCH 3/7] added the serialization of Indicators at the level of the result. Removed the serialization of measures at the level of the instance --- docs/data-model/entities/other.md | 170 ++++++++++++++++++++++++----- docs/data-model/entities/result.md | 44 ++++++-- 2 files changed, 177 insertions(+), 37 deletions(-) diff --git a/docs/data-model/entities/other.md b/docs/data-model/entities/other.md index cd12f18..ff40560 100644 --- a/docs/data-model/entities/other.md +++ b/docs/data-model/entities/other.md @@ -542,21 +542,6 @@ The license URL. "license": "http://creativecommons.org/licenses/by-nc/4.0" ``` -### measures -_Type: [Measure](#measure) • Cardinality: MANY_ - -The measures computed for this instance (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)). - -```json -"measures": [ - { - "key": "influence", - "value": "6.45335454246e-09" - }, - ... -] -``` - ### pid _Type: [ResultPid](#resultpid) • Cardinality: MANY_ @@ -619,6 +604,51 @@ URLs to the instance. They may link to the actual full-text or to the landing pa ] ``` +## Indicator +The indicators are measures computed for the specific OpenAIRE result + +Each indicator is composed of the following properties: + +### impactMeasures +_Type: [ImpactMeasures](#impactmeasures) • Cardinality: ONE_ + +The measures provided by [BIP! Finder](https://bip.imsi.athenarc.gr/) + +```json +"impactMeasures": { + "influence": { + "score":"123", + "class":"C2" + }, + "influence_alt" :{ + "score":"456", + "class":"C3" + }, + "popularity":{ + "score":"234", + "class":"C1" + }, + "popularity_alt":{ + "score":"345", + "class":"C5" + }, + "impulse":{ + "score":"987", + "class":"C3" + } + } +``` + +### usageCounts +_Type: [UsageCounts](#usagecounts) • Cardinality: ONE_ +The measures computed by usageCounts + +```json +"usageCounts":{ + "downloads":"10", + "views": "20" + } +``` ## Language Represents information for the language of the result @@ -640,31 +670,72 @@ Language label in English. "label": "English" ``` -## Measure -A measure computed for this instance (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)) +## ImpactMeasures +The measures computed for this result by [BIP! Finder](https://bip.imsi.athenarc.gr/) -### key -_Type: String • Cardinality: ONE_ +It is composed by the following properties: -The specified measure. Currently supported one of: -* `influence` (see [PageRank](/data-provision/enrichment/impact-scores#pagerank-pr)) -* `influence_alt` (see [Citation Count](/data-provision/enrichment/impact-scores#citation-count-cc)) -* `popularity` (see [AttRank](/data-provision/enrichment/impact-scores#attrank)) -* `popularity_alt` (see [RAM](/data-provision/enrichment/impact-scores#ram)) -* `impulse` (see ["Incubation" Citation Count](/data-provision/enrichment/impact-scores#incubation-citation-count-icc)) +### influence +_Type: [Score](#score) • Cardinality: ONE_ + +see [PageRank](/data-provision/enrichment/impact-scores#pagerank-pr) ```json -"key": "influence" +"influence": { + "score":"123", + "class":"C2" + } ``` -### value -_Type: String • Cardinality: ONE_ +### influence_alt +_Type: [Score](#score) • Cardinality: ONE_ + +see [Citation Count](/data-provision/enrichment/impact-scores#citation-count-cc) ```json -"value": "6.45335454246e-09" + "influence_alt" :{ + "score":"456", + "class":"C3" + } ``` -The value for that measure. +### popularity +_Type: [Score](#score) • Cardinality: ONE_ + +see [AttRank](/data-provision/enrichment/impact-scores#attrank) + +```json + "popularity":{ + "score":"234", + "class":"C1" + } + +``` + +### popularity_alt +_Type: [Score](#score) • Cardinality: ONE_ + +see [RAM](/data-provision/enrichment/impact-scores#ram) + +```json +"popularity_alt":{ + "score":"345", + "class":"C5" + } + +``` + +### impulse +_Type: [Score](#score) • Cardinality: ONE_ + +see ["Incubation" Citation Count](/data-provision/enrichment/impact-scores#incubation-citation-count-icc) + +```json +"impulse":{ + "score":"987", + "class":"C3" + } +``` ## OrganizationPid @@ -748,6 +819,26 @@ The value expressed in the scheme (i.e. 10.1000/182). "value": "10.21511/bbs.13(3).2018.13" ``` +## Score +The specific score for the Bip!Finder measure. + +### score +_Type: String • Cardinality: ONE_ + +The score computed for the indicator + +```json +"score":"1234" +``` + +### class +_Type: String • Cardinality: _ONE + +The class for the indicator + +```json +"class":"C2" +``` ## Subject Represents keywords associated to the result. @@ -795,3 +886,22 @@ The value for the subject in the selected scheme. When the scheme is 'keyword', ```json "value" : "pyrolysis-oil" ``` + +## UsageCounts +The usage counts indicator computed for this result + +### views +_Type: String • Cardinality: _ONE + +The number of views for this result + +```json +"views":"10" +``` + +### downloads +The number of downloads for this result + +```json +"downloads":"5" +``` \ No newline at end of file diff --git a/docs/data-model/entities/result.md b/docs/data-model/entities/result.md index 72a45e6..bae2dbc 100644 --- a/docs/data-model/entities/result.md +++ b/docs/data-model/entities/result.md @@ -183,6 +183,43 @@ Date when the embargo ends and this result turns Open Access. "embargoenddate": "2017-01-01" ``` +### indicators +_Type: [Indicator](other#indicator) • Cardinality: ONE_ + +The indicators computed for this result (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)). + +```json +"indicators": { + "impactMeasures": { + "influence": { + "score":"123", + "class":"C2" + }, + "influence_alt" :{ + "score":"456", + "class":"C3" + }, + "popularity":{ + "score":"234", + "class":"C1" + }, + "popularity_alt":{ + "score":"345", + "class":"C5" + }, + "impulse":{ + "score":"987", + "class":"C3" + } + }, + "usageCounts":{ + "downloads":"10", + "views": "20" + } +} + +``` + ### instance _Type: [Instance](other#instance) • Cardinality: MANY_ @@ -209,13 +246,6 @@ Specific materialization or version of the result. For example, you can have one "currency": "EUR" }, "license": "http://creativecommons.org/licenses/by-nc/4.0", - "measures":[ - { - "key": "influence", - "value": "6.45335454246e-09" - }, - ... - ], "pid": [ { "scheme": "pmc", From 7bf48ea9768ec3093ffe438a96ddad89ee3e550d Mon Sep 17 00:00:00 2001 From: "miriam.baglioni" Date: Tue, 27 Dec 2022 12:51:52 +0100 Subject: [PATCH 4/7] added new relationships --- docs/data-model/relationships.md | 36 ++++++++++++++++++++++---------- package-lock.json | 2 +- package.json | 2 +- 3 files changed, 27 insertions(+), 13 deletions(-) diff --git a/docs/data-model/relationships.md b/docs/data-model/relationships.md index 8d2bc42..8cd39e2 100644 --- a/docs/data-model/relationships.md +++ b/docs/data-model/relationships.md @@ -130,17 +130,31 @@ The following table lists all the possible relation semantics found in the graph | # | Source entity type | Target entity type | Relation type | Relation name | Inverse relation name | |:--:|:------------------:|:-------------------:|:-------------:|:---------------------------:|:----------------------------:| | 1 | [Project](entities/project) | [Result](entities/result) | outcome | produces | isProducedBy | -| 2 | [Result](entities/result) | [Organization](entities/organization) | affiliation | hasAuthorInstitution | isAuthorInstitutionOf | -| 3 | [Result](entities/result) | [Result](entities/result) | similarity | isAmongTopNSimilarDocuments | HasAmongTopNSimilarDocuments | -| 4 | [Project](entities/project) | [Organization](entities/organization) | participation | isParticipant | hasParticipant | +| 2 | [Project](entities/project) | [Organization](entities/organization) | participation | hasParticipant | isParticipant | +| 3 | [Project](entities/project) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | +| 4 | [Result](entities/result) | [Result](entities/result) | similarity | isAmongTopNSimilarDocuments | HasAmongTopNSimilarDocuments | | 5 | [Result](entities/result) | [Result](entities/result) | supplement | isSupplementTo | isSupplementedBy | | 6 | [Result](entities/result) | [Result](entities/result) | relationship | isRelatedTo | isRelatedTo | -| 7 | [Data source](entities/data-source) | [Organization](entities/organization) | provision | provides | isProvidedBy | -| 8 | [Result](entities/result) | [Data source](entities/data-source) | provision | isHostedBy | hosts | -| 9 | [Result](entities/result) | [Data source](entities/data-source) | provision | isProvidedBy | provides | -| 10 | [Result](entities/result) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | -| 11 | [Organization](entities/organization) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | -| 12 | [Data source](entities/data-source) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | -| 13 | [Project](entities/project) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | - +| 7 | [Result](entities/result) | [Result](entities/result) | relationship | IsPartOf | HasPart | +| 8 | [Result](entities/result) | [Result](entities/result) | relationship | IsDocumentedBy | Documents | +| 9 | [Result](entities/result) | [Result](entities/result) | relationship | IsObsoletedBy | Obsoletes | +| 10 | [Result](entities/result) | [Result](entities/result) | relationship | IsSourceOf | IsDerivedFrom | +| 11 | [Result](entities/result) | [Result](entities/result) | relationship | IsCompiledBy | Compiles | +| 12 | [Result](entities/result) | [Result](entities/result) | relationship | IsRequiredBy | Requires | +| 13 | [Result](entities/result) | [Result](entities/result) | relationship | IsCitedBy | Cites | +| 14 | [Result](entities/result) | [Result](entities/result) | relationship | IsReferencedBy | References | +| 15 | [Result](entities/result) | [Result](entities/result) | relationship | IsReviewedBy | IsVariantFormOf | +| 16 | [Result](entities/result) | [Result](entities/result) | relationship | IsOriginalFormOf | IsCitedBy | +| 17 | [Result](entities/result) | [Result](entities/result) | relationship | IsVersionOf | HasVersion | +| 18 | [Result](entities/result) | [Result](entities/result) | relationship | IsIdenticalTo | IsIdenticalTo | +| 19 | [Result](entities/result) | [Result](entities/result) | relationship | IsPreviousVersionOf | IsNewVersionOf | +| 20 | [Result](entities/result) | [Result](entities/result) | relationship | IsContinuedBy | Continues | +| 21 | [Result](entities/result) | [Result](entities/result) | relationship | IsDescribedBy | Describes | +| 22 | [Result](entities/result) | [Organization](entities/organization) | affiliation | hasAuthorInstitution | isAuthorInstitutionOf | +| 23 | [Result](entities/result) | [Data source](entities/data-source) | provision | isHostedBy | hosts | +| 24 | [Result](entities/result) | [Data source](entities/data-source) | provision | isProvidedBy | provides | +| 25 | [Result](entities/result) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | +| 26 | [Organization](entities/organization) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | +| 27 | [Data source](entities/data-source) | [Community](entities/community) | relationship | isRelatedTo | isRelatedTo | +| 28 | [Data source](entities/data-source) | [Organization](entities/organization) | provision | isProvidedBy | provides | diff --git a/package-lock.json b/package-lock.json index 9745a9c..4a2576f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,7 +22,7 @@ "remark-math": "^3.0.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^2.1.0" + "@docusaurus/module-type-aliases": "^2.2.0" }, "engines": { "node": ">=16.14" diff --git a/package.json b/package.json index 527930d..8afe308 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "remark-math": "^3.0.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^2.1.0" + "@docusaurus/module-type-aliases": "^2.2.0" }, "browserslist": { "production": [ From f170f72d8daba5bae90f34c542dea3568f99bb7e Mon Sep 17 00:00:00 2001 From: "miriam.baglioni" Date: Tue, 27 Dec 2022 12:57:36 +0100 Subject: [PATCH 5/7] indentation for json --- docs/data-model/entities/other.md | 56 +++++++++++++++---------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/data-model/entities/other.md b/docs/data-model/entities/other.md index ff40560..96152ea 100644 --- a/docs/data-model/entities/other.md +++ b/docs/data-model/entities/other.md @@ -616,25 +616,25 @@ The measures provided by [BIP! Finder](https://bip.imsi.athenarc.gr/) ```json "impactMeasures": { - "influence": { - "score":"123", - "class":"C2" + "influence": { + "score":"123", + "class":"C2" }, - "influence_alt" :{ - "score":"456", - "class":"C3" + "influence_alt" :{ + "score":"456", + "class":"C3" }, - "popularity":{ - "score":"234", - "class":"C1" + "popularity":{ + "score":"234", + "class":"C1" }, - "popularity_alt":{ - "score":"345", - "class":"C5" + "popularity_alt":{ + "score":"345", + "class":"C5" }, - "impulse":{ - "score":"987", - "class":"C3" + "impulse":{ + "score":"987", + "class":"C3" } } ``` @@ -645,8 +645,8 @@ The measures computed by usageCounts ```json "usageCounts":{ - "downloads":"10", - "views": "20" + "downloads":"10", + "views": "20" } ``` ## Language @@ -682,8 +682,8 @@ see [PageRank](/data-provision/enrichment/impact-scores#pagerank-pr) ```json "influence": { - "score":"123", - "class":"C2" + "score":"123", + "class":"C2" } ``` @@ -694,8 +694,8 @@ see [Citation Count](/data-provision/enrichment/impact-scores#citation-count-cc) ```json "influence_alt" :{ - "score":"456", - "class":"C3" + "score":"456", + "class":"C3" } ``` @@ -705,9 +705,9 @@ _Type: [Score](#score) • Cardinality: ONE_ see [AttRank](/data-provision/enrichment/impact-scores#attrank) ```json - "popularity":{ - "score":"234", - "class":"C1" +"popularity":{ + "score":"234", + "class":"C1" } ``` @@ -719,8 +719,8 @@ see [RAM](/data-provision/enrichment/impact-scores#ram) ```json "popularity_alt":{ - "score":"345", - "class":"C5" + "score":"345", + "class":"C5" } ``` @@ -732,8 +732,8 @@ see ["Incubation" Citation Count](/data-provision/enrichment/impact-scores#incub ```json "impulse":{ - "score":"987", - "class":"C3" + "score":"987", + "class":"C3" } ``` From ccf3ea15290dca08ba9e7e0c30edeb6f7f67817f Mon Sep 17 00:00:00 2001 From: Serafeim Chatzopoulos Date: Tue, 27 Dec 2022 19:34:46 +0200 Subject: [PATCH 6/7] Add info for impact indicators --- docs/data-model/data-model.md | 4 +- docs/data-model/entities/other.md | 144 ++++++++++++++++------------- docs/data-model/entities/result.md | 38 ++++---- 3 files changed, 102 insertions(+), 84 deletions(-) diff --git a/docs/data-model/data-model.md b/docs/data-model/data-model.md index 4718a5f..8cd3d9f 100644 --- a/docs/data-model/data-model.md +++ b/docs/data-model/data-model.md @@ -12,11 +12,11 @@ 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 +* [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, 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) +* [Communities](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/other.md b/docs/data-model/entities/other.md index 96152ea..e066b5b 100644 --- a/docs/data-model/entities/other.md +++ b/docs/data-model/entities/other.md @@ -605,49 +605,53 @@ URLs to the instance. They may link to the actual full-text or to the landing pa ``` ## Indicator -The indicators are measures computed for the specific OpenAIRE result -Each indicator is composed of the following properties: +These are indicators computed for a specific OpenAIRE result. + +Each Indicator object is composed of the following properties: ### impactMeasures -_Type: [ImpactMeasures](#impactmeasures) • Cardinality: ONE_ +_Type: [ImpactMeasures](#impactmeasures-1) • Cardinality: ONE_ -The measures provided by [BIP! Finder](https://bip.imsi.athenarc.gr/) +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](/data-provision/indicators-ingestion/impact-scores). ```json "impactMeasures": { "influence": { - "score":"123", - "class":"C2" - }, - "influence_alt" :{ - "score":"456", - "class":"C3" - }, - "popularity":{ - "score":"234", - "class":"C1" - }, - "popularity_alt":{ - "score":"345", - "class":"C5" - }, - "impulse":{ - "score":"987", - "class":"C3" - } + "score": "123", + "class": "C2" + }, + "influence_alt" : { + "score": "456", + "class": "C3" + }, + "popularity": { + "score": "234", + "class": "C1" + }, + "popularity_alt": { + "score": "345", + "class": "C5" + }, + "impulse": { + "score": "987", + "class": "C3" } +} ``` ### usageCounts -_Type: [UsageCounts](#usagecounts) • Cardinality: ONE_ -The measures computed by usageCounts +_Type: [UsageCounts](#usagecounts-1) • Cardinality: ONE_ + +These measures, computed by the [UsageCounts Service](https://usagecounts.openaire.eu/), are based on usage statistics. ```json "usageCounts":{ - "downloads":"10", - "views": "20" - } + "downloads": "10", + "views": "20" +} ``` ## Language Represents information for the language of the result @@ -671,70 +675,74 @@ Language label in English. ``` ## ImpactMeasures -The measures computed for this result by [BIP! Finder](https://bip.imsi.athenarc.gr/) -It is composed by the following properties: +The different impact-based indicators as computed by [BIP!](https://bip.imsi.athenarc.gr/). ### influence _Type: [Score](#score) • Cardinality: ONE_ -see [PageRank](/data-provision/enrichment/impact-scores#pagerank-pr) +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](/data-provision/indicators-ingestion/impact-scores#pagerank-pr). ```json "influence": { - "score":"123", - "class":"C2" - } + "score": "123", + "class": "C2" +} ``` ### influence_alt _Type: [Score](#score) • Cardinality: ONE_ -see [Citation Count](/data-provision/enrichment/impact-scores#citation-count-cc) +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](/data-provision/indicators-ingestion/impact-scores#citation-count-cc). ```json - "influence_alt" :{ - "score":"456", - "class":"C3" - } +"influence_alt" :{ + "score": "456", + "class": "C3" +} ``` ### popularity _Type: [Score](#score) • Cardinality: ONE_ -see [AttRank](/data-provision/enrichment/impact-scores#attrank) +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](/data-provision/indicators-ingestion/impact-scores#attrank). ```json "popularity":{ - "score":"234", - "class":"C1" - } + "score": "234", + "class": "C1" +} ``` ### popularity_alt _Type: [Score](#score) • Cardinality: ONE_ -see [RAM](/data-provision/enrichment/impact-scores#ram) +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](/data-provision/indicators-ingestion/impact-scores#ram). ```json "popularity_alt":{ - "score":"345", - "class":"C5" - } + "score": "345", + "class": "C5" +} ``` ### impulse _Type: [Score](#score) • Cardinality: ONE_ -see ["Incubation" Citation Count](/data-provision/enrichment/impact-scores#incubation-citation-count-icc) +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](/data-provision/indicators-ingestion/impact-scores#incubation-citation-count-icc). ```json "impulse":{ - "score":"987", - "class":"C3" - } + "score": "987", + "class": "C3" +} ``` ## OrganizationPid @@ -820,24 +828,31 @@ The value expressed in the scheme (i.e. 10.1000/182). ``` ## Score -The specific score for the Bip!Finder measure. +The specific score object for each calculated impact measure calculated by [BIP!](https://bip.imsi.athenarc.gr/). ### score _Type: String • Cardinality: ONE_ -The score computed for the indicator +The actual indicator score. ```json -"score":"1234" +"score": "1234" ``` ### class -_Type: String • Cardinality: _ONE +_Type: String • Cardinality: ONE_ -The class for the indicator +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" +"class": "C2" ``` ## Subject Represents keywords associated to the result. @@ -888,20 +903,23 @@ The value for the subject in the selected scheme. When the scheme is 'keyword', ``` ## UsageCounts -The usage counts indicator computed for this result + +The usage counts indicator computed for this result. ### views -_Type: String • Cardinality: _ONE +_Type: String • Cardinality: ONE_ -The number of views for this result +The number of views for this result. ```json -"views":"10" +"views": "10" ``` ### downloads -The number of downloads for this result +_Type: String • Cardinality: ONE_ + +The number of downloads for this result. ```json -"downloads":"5" +"downloads": "5" ``` \ No newline at end of file diff --git a/docs/data-model/entities/result.md b/docs/data-model/entities/result.md index bae2dbc..f0abfcc 100644 --- a/docs/data-model/entities/result.md +++ b/docs/data-model/entities/result.md @@ -186,38 +186,38 @@ Date when the embargo ends and this result turns Open Access. ### indicators _Type: [Indicator](other#indicator) • Cardinality: ONE_ -The indicators computed for this result (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)). +The indicators computed for this result; +currently, the following two types of indicators are supported: [impact indicators](/data-provision/indicators-ingestion/impact-scores) and [usage statistics indicators](/data-provision/indicators-ingestion/usage-counts). ```json "indicators": { "impactMeasures": { "influence": { - "score":"123", - "class":"C2" + "score": "123", + "class": "C2" }, - "influence_alt" :{ - "score":"456", - "class":"C3" + "influence_alt" : { + "score": "456", + "class": "C3" }, - "popularity":{ - "score":"234", - "class":"C1" + "popularity": { + "score": "234", + "class": "C1" }, - "popularity_alt":{ - "score":"345", - "class":"C5" + "popularity_alt": { + "score": "345", + "class": "C5" }, - "impulse":{ - "score":"987", - "class":"C3" + "impulse": { + "score": "987", + "class": "C3" } }, - "usageCounts":{ - "downloads":"10", - "views": "20" + "usageCounts": { + "downloads": "10", + "views": "20" } } - ``` ### instance From b943be8ee307533c8f34a43c9f3004b31ee7a3b4 Mon Sep 17 00:00:00 2001 From: Serafeim Chatzopoulos Date: Tue, 27 Dec 2022 21:22:30 +0200 Subject: [PATCH 7/7] Fix links from impact measures page to specific properties/objects in the result --- .env | 4 ++-- docs/data-provision/indicators-ingestion/impact-scores.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.env b/.env index 9ed2036..a8c69cf 100644 --- a/.env +++ b/.env @@ -1,2 +1,2 @@ -URL="http://snf-23385.ok-kno.grnetcloud.net" -BASE_URL="/" +URL="https://graph.openaire.eu" +BASE_URL="/docs" diff --git a/docs/data-provision/indicators-ingestion/impact-scores.md b/docs/data-provision/indicators-ingestion/impact-scores.md index 7754a04..b5d9bcd 100644 --- a/docs/data-provision/indicators-ingestion/impact-scores.md +++ b/docs/data-provision/indicators-ingestion/impact-scores.md @@ -1,7 +1,7 @@ # Impact indicators -This page summarises all calculated impact indicators, which are included into the [measure](/data-model/entities/other#measure) property. -It should be noted that the impact indicators are being calculated both on the level of the research output as well on the level of distinct DOIs. +This page summarises all calculated impact indicators, which are included in the [impactMeasures](/data-model/entities/other#impactmeasures) property which is part of 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.