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