schatz
/
openaire-graph-docs
forked from D-Net/openaire-graph-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

Add info for impact indicators

This commit is contained in:
Serafeim Chatzopoulos 2022-12-27 19:34:46 +02:00
parent f170f72d8d
commit ccf3ea1529
3 changed files with 102 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/data-model/data-model.md
View File

@ -12,11 +12,11 @@ The figure above, presents the graph's data model.
Its main entities are described in brief below: Its main entities are described in brief below:
* [Results](entities/result) represent the outcomes (or products) of research activities. * [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, * [Organizations](entities/organization) correspond to companies or research institutions involved in projects,
responsible for operating data sources or consisting the affiliations of Product creators. 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. * [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 :::note Further reading

60
docs/data-model/entities/other.md
View File

@ -605,14 +605,17 @@ URLs to the instance. They may link to the actual full-text or to the landing pa
``` ```
## Indicator ## 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 ### 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 ```json
"impactMeasures": { "impactMeasures": {
@ -640,8 +643,9 @@ The measures provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)
``` ```
### usageCounts ### usageCounts
_Type: [UsageCounts](#usagecounts) • Cardinality: ONE_ _Type: [UsageCounts](#usagecounts-1) • Cardinality: ONE_
The measures computed by usageCounts
These measures, computed by the [UsageCounts Service](https://usagecounts.openaire.eu/), are based on usage statistics.
```json ```json
"usageCounts":{ "usageCounts":{
@ -671,14 +675,14 @@ Language label in English.
``` ```
## ImpactMeasures ## 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 ### influence
_Type: [Score](#score) • Cardinality: ONE_ _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 ```json
"influence": { "influence": {
@ -690,7 +694,8 @@ see [PageRank](/data-provision/enrichment/impact-scores#pagerank-pr)
### influence_alt ### influence_alt
_Type: [Score](#score) • Cardinality: ONE_ _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 ```json
"influence_alt" :{ "influence_alt" :{
@ -702,7 +707,8 @@ see [Citation Count](/data-provision/enrichment/impact-scores#citation-count-cc)
### popularity ### popularity
_Type: [Score](#score) • Cardinality: ONE_ _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 ```json
"popularity":{ "popularity":{
@ -715,7 +721,8 @@ see [AttRank](/data-provision/enrichment/impact-scores#attrank)
### popularity_alt ### popularity_alt
_Type: [Score](#score) • Cardinality: ONE_ _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 ```json
"popularity_alt":{ "popularity_alt":{
@ -728,7 +735,8 @@ see [RAM](/data-provision/enrichment/impact-scores#ram)
### impulse ### impulse
_Type: [Score](#score) • Cardinality: ONE_ _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 ```json
"impulse":{ "impulse":{
@ -820,21 +828,28 @@ The value expressed in the scheme (i.e. 10.1000/182).
``` ```
## Score ## 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 ### score
_Type: String • Cardinality: ONE_ _Type: String • Cardinality: ONE_
The score computed for the indicator The actual indicator score.
```json ```json
"score": "1234" "score": "1234"
``` ```
### class ### 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 ```json
"class": "C2" "class": "C2"
@ -888,19 +903,22 @@ The value for the subject in the selected scheme. When the scheme is 'keyword',
``` ```
## UsageCounts ## UsageCounts
The usage counts indicator computed for this result
The usage counts indicator computed for this result.
### views ### views
_Type: String • Cardinality: _ONE _Type: String • Cardinality: ONE_
The number of views for this result The number of views for this result.
```json ```json
"views": "10" "views": "10"
``` ```
### downloads ### downloads
The number of downloads for this result _Type: String • Cardinality: ONE_
The number of downloads for this result.
```json ```json
"downloads": "5" "downloads": "5"

4
docs/data-model/entities/result.md
View File

@ -186,7 +186,8 @@ Date when the embargo ends and this result turns Open Access.
### indicators ### indicators
_Type: [Indicator](other#indicator) • Cardinality: ONE_ _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 ```json
"indicators": { "indicators": {
@ -217,7 +218,6 @@ The indicators computed for this result (e.g. those provided by [BIP! Finder](ht
"views": "20" "views": "20"
} }
} }
``` ```
### instance ### instance