Page History

Metrics infrastructure

The system allows to store via JAVA API metrics about any object in the table cris_metrics

...

it is possible to limit the script to a specific metric using the option -s with the name assigned to the plugin

Usage statistics as metrics

• org.dspace.app.cris.statistics.plugin.StatsViewIndicatorsPlugin

Defining a spring bean that instance such class the usage statistics for the entity specified by the resourceTypeId field are "converted" in metrics with metrictype view and download

<bean class="org.dspace.app.cris.statistics.plugin.StatsViewIndicatorsPlugin" name="ItemStatsViewIndicatorsPlugin">
   		<property name="name" value="ItemStatsViewIndicatorsPlugin"/>
   		<property name="resourceTypeId" value="2"/>
</bean>

Content statistics as metrics

...

Tip
This feature has been introduced in DSpace-CRIS 5.6

• org.dspace.app.cris.statistics.plugin.IndicatorCountBuilder<ACO>
• org.dspace.app.cris.statistics.plugin.IndicatorMetadataSumBuilder<ACO>

...

The following scripts are used to query the external bibliometric databases:

PubMed Central

org.dspace.app.cris.metrics.pmc.script.RetrieveCitationInPMC

Scopus

org.dspace.app.cris.metrics.scopus.script.ScriptRetrieveCitation

Web of Science

org.dspace.app.cris.metrics.wos.script.ScriptRetrieveCitation

all the scripts accept the following parameter

• -t <time-in-seconds> to exclude from the processing the publications that were already checked in the database by less than the value specified in seconds. -t 604800 mean 7 days
• -x <number-of-publication> to limit the number of processed publications to maximum n
• -q <solr-query> to limit the set of publications to the ones matching the SOLR query (useful for testing and precise check/refresh)

Derivative metrics

The system is able to use existent metrics to build derivative metrics aggregating the information to an upper level as for example the total number of citation received by all the researcher's publications. This is the publication citation count metric aggregated to the researcher level. Other than aggregation it is possible to calculate average, maximum, minimum, standard deviation, variation in a week and month and also sum different metrics together.

• org.dspace.app.cris.statistics.plugin.StatsAggregateIndicatorsPlugin

<bean class="org.dspace.app.cris.statistics.plugin.StatsAggregateIndicatorsPlugin" name="RPStatsAggregatorPUBMEDIndicatorsPlugin">
   		<property name="name" value="RPStatsAggregatorPUBMEDIndicatorsPlugin"/>
   		<property name="type" value="pubmed"/>
   		<property name="crisEntityClazz" value="org.dspace.app.cris.model.ResearcherPage"/>
   		<property name="crisEntityTypeId" value="9"/>
</bean>

the above example compute the sum of all the pubmed (citation counts) metric on publication for a specific researcher. By default the author_authority solr field is used to retrieve all the items related to a researcher but the used field can be configured as property of the spring bean and a filter query defined to limit the set of publications used (for example to the ones published in the last 5 years)

• org.dspace.app.cris.statistics.plugin.StatsPercentileIndicatorsPlugin

<bean class="org.dspace.app.cris.statistics.plugin.StatsPercentileIndicatorsPlugin" name="PercentileViewIndicatorsPlugin">
   		<property name="name" value="PercentileViewIndicatorsPlugin"/>
   		<property name="metrics" value="view"/>
   		<property name="fq">
   			<list>
   				<value>search.resourcetype:2</value>
   			</list>
   		</property>
</bean>

the above example compute the position of the object compared to the other object for a specific metric in percentage so to be used to state the percentile of the object for the metric. For example if a publication is the 10th over 100 publication using the number of view this mean that the view percentile is 10/100 = 0,1

• org.dspace.app.cris.statistics.plugin.StatsPeriodIndicatorsPlugin

   	<bean class="org.dspace.app.cris.statistics.plugin.StatsPeriodIndicatorsPlugin" name="ItemStatsPeriodWeekPUBMEDIndicatorsPlugin">
   		<property name="name" value="ItemStatsPeriodWeekPUBMEDIndicatorsPlugin"/>
   		<property name="type" value="pubmed"/>
   		<property name="frequency" value="_last1"/>
   	</bean>

the above example compute the variation (increment or decrements) of the pubmed metric (type) over one week (frequency = _last1, use _last2 for one month)

...