IRStats2 - Revision history

Ejo1f20: /* Embedding Stats on Abstract Pages */

2024-02-05T11:22:25Z

Embedding Stats on Abstract Pages

← Older revision		Revision as of 11:22, 5 February 2024
Line 95:		Line 95:
	Edit the EPrint Summary Page citation file (this can be done from the command line or the configuration editor) and add the following phrase near the bottom:		Edit the EPrint Summary Page citation file (this can be done from the command line or the configuration editor) and add the following phrase near the bottom:

	<epc:phrase ref="lib/irstats2:embedded:summary_page:eprint:downloads"/>		<epc:phrase ref="lib/irstats2:embedded:summary_page:eprint:downloads">
			<epc:param name="eprintid"><epc:print expr="eprintid"/></epc:param>
			</epc:phrase>

	Then restart apache and regenerate the abstract pages.		Then restart apache and regenerate the abstract pages.

Drn@ecs.soton.ac.uk: Added some quote marks around potential values for context options in tables.

2021-09-14T09:06:15Z

Added some quote marks around potential values for context options in tables.

← Older revision		Revision as of 09:06, 14 September 2021
Line 389:		Line 389:

	Context options:		Context options:
	- irs2report: What type of report/data do you want to display (e.g. most_popular_eprints, most_popular_authors~~, etc.~~)		- irs2report: What type of report/data do you want to display (e.g. "most_popular_eprints", "most_popular_authors")
	- range: What date range show this report cover (e.g. _ALL_ is across all dates, 1y is the last year 1m is the last month, etc.)		- range: What date range show this report cover (e.g. "_ALL_" is across all dates, "1y" is the last year "1m" is the last month, etc.)
	- datatype: What type of data is being displayed (e.g. downloads, views~~, etc.~~)		- datatype: What type of data is being displayed (e.g. "downloads", "views")
	- set_name: A set on which to filter (e.g. authors, type, divisions, subjects, eprintid)		- set_name: A set on which to filter (e.g. "authors", "type", "divisions", "subjects", "eprintid")
	- set_value: A value in the set on which to filterm (e.g for an author the hash of their name such as c6edf1ce30d927a9a005e4b272ead4b4 for a division or subject, their subject ID, for eprint type, its type ID)		- set_value: A value in the set on which to filterm (e.g for an author the hash of their name such as "c6edf1ce30d927a9a005e4b272ead4b4" for a division or subject, their subject ID, for eprint type, its type ID)

	Table options:		Table options:

Drn@ecs.soton.ac.uk: Added additional required context options for graphs

2021-09-14T09:04:17Z

Added additional required context options for graphs

← Older revision		Revision as of 09:04, 14 September 2021
Line 352:		Line 352:
	<pre>		<pre>
	<!--		<!--
	This will basically insert the downloads graph into the "mygraph" div element. Note that it's using the supplied		This will basically insert the downloads graph into the "mygraph" div element. Note that it's using the supplied "irstats2_googlegraph" CSS class.
	"irstats2_googlegraph" CSS class.
			Context options:
			- irs2report: What type of report/data do you want to display (e.g. "main", "deposits", "requests")
			- range: What date range show this report cover (e.g. "_ALL_" is across all dates, "1y" is the last year "1m" is the last month, etc.)
			- datatype: What type of data is being displayed (e.g. "downloads", "views", "deposits", "countries")
			- datafilter: What attribute on which to filter the data (e.g. "archive")
			- set_name: A set on which to filter (e.g. "authors", "type", "divisions", "subjects", "eprintid")
			- set_value: A value in the set on which to filterm (e.g for an author the hash of their name such as "c6edf1ce30d927a9a005e4b272ead4b4" for a division or subject, their subject ID, for eprint type, its type ID)

	Graph options:		Graph options:
	- graph_type: either "column" or "area"		- graph_type: either "column" or "area"
	- show_average: either 1 or 0 - displays the average graph		- show_average: either 1 or 0 - displays the average graph'
	- date_resolution: either "year", "month" or "day" - groups data by year, month or day (be careful: selecting day may generate LOTS of data points)		- date_resolution: either "year", "month" or "day" - groups data by year, month or day (be careful: selecting day may generate LOTS of data points)
	-->		-->
Line 366:		Line 373:
	document.observe("dom:loaded",function(){		document.observe("dom:loaded",function(){
	new EPJS_Stats_GoogleGraph( {		new EPJS_Stats_GoogleGraph( {
	'context': { 'datatype': 'downloads' },		'context': {'irs2report': 'main', 'range': '_ALL_', 'datatype': 'downloads'},
	'options': { 'graph_type': 'column', 'container_id': 'mygraph', 'view': 'Google::Graph', 'show_average': '1', 'date_resolution': 'month' }		'options': { 'graph_type': 'column', 'container_id': 'mygraph', 'view': 'Google::Graph', 'show_average': '1', 'date_resolution': 'month' }
	});		});

Drn@ecs.soton.ac.uk: Added additional required context options for tables

2021-09-14T08:31:37Z

Added additional required context options for tables

← Older revision		Revision as of 08:31, 14 September 2021
Line 381:		Line 381:
	"irstats2_table" CSS class.		"irstats2_table" CSS class.

			Context options:
			- irs2report: What type of report/data do you want to display (e.g. most_popular_eprints, most_popular_authors, etc.)
			- range: What date range show this report cover (e.g. _ALL_ is across all dates, 1y is the last year 1m is the last month, etc.)
			- datatype: What type of data is being displayed (e.g. downloads, views, etc.)
			- set_name: A set on which to filter (e.g. authors, type, divisions, subjects, eprintid)
			- set_value: A value in the set on which to filterm (e.g for an author the hash of their name such as c6edf1ce30d927a9a005e4b272ead4b4 for a division or subject, their subject ID, for eprint type, its type ID)

	Table options:		Table options:
	- top: the top "thing" to display - similar to the "grouping" parameter when using scripts		- top: the top "thing" to display - similar to the "grouping" parameter when using scripts
Line 395:		Line 402:

	new EPJS_Stats_Table( {		new EPJS_Stats_Table( {
	'context': { 'datatype': 'downloads' },		'context': { 'irs2report': 'most_popular_eprints', 'range': '_ALL_', 'datatype': 'downloads'},
	'options': { 'container_id': 'mytable', 'top': 'eprint', 'view': 'Table', 'limit': '5' }		'options': { 'container_id': 'mytable', 'top': 'eprint', 'view': 'Table', 'limit': '5' }
	} );		} );

Drn@ecs.soton.ac.uk: /* Dependencies */

2020-06-20T08:26:21Z

Dependencies

← Older revision		Revision as of 08:26, 20 June 2020
Line 41:		Line 41:

	==Dependencies==		==Dependencies==
	* Geo::IP or Geo::IP::PurePerl		* Geo::IP or Geo::IP::PurePerl
	* Date::Calc		* Date::Calc

Drn@ecs.soton.ac.uk: /* CPAN */

2020-06-20T08:26:04Z

CPAN

← Older revision		Revision as of 08:26, 20 June 2020
Line 53:		Line 53:

	=== CPAN ===		=== CPAN ===
	cpan Geo::IP Date::Calc		cpan Geo::IP Date::Calc

	==EPrints 3.3 and 3.4==		==EPrints 3.3 and 3.4==

Drn@ecs.soton.ac.uk at 08:14, 20 June 2020

2020-06-20T08:14:23Z

← Older revision		Revision as of 08:14, 20 June 2020
Line 69:		Line 69:
	*[https://github.com/eprints/eprints/issues/130 Fix auto-completers]		*[https://github.com/eprints/eprints/issues/130 Fix auto-completers]

	===EPrints 3.2.x===		==EPrints 3.2.x==
	See [[IRStats2/EPrints 3.2]]		See [[IRStats2/EPrints 3.2]]

Drn@ecs.soton.ac.uk at 08:13, 20 June 2020

2020-06-20T08:13:13Z

← Older revision		Revision as of 08:13, 20 June 2020
Line 56:		Line 56:

	==EPrints 3.3 and 3.4==		==EPrints 3.3 and 3.4==
	IRStats2 can be installed directly via the Bazaar on EPrints 3.3.		IRStats2 can be installed directly via the Bazaar on EPrints 3.3 and 3.4.

	===EPrints 3.3.11 onwards===		===EPrints 3.3.11 (inc. 3.4.x) onwards===
	Installing IRStats2 from the Bazaar is all you need to do. It is recommend that you restart Apache after doing so.		Installing IRStats2 from the Bazaar is all you need to do. It is recommend that you restart Apache after doing so.

Drn@ecs.soton.ac.uk: Updated page to mention EPrints 3.4. Tidied up changes since 1.0. Moved instructions for EPrints 3.2 out to own page. Improved dependency installation instructions.

2020-06-20T08:12:14Z

Updated page to mention EPrints 3.4. Tidied up changes since 1.0. Moved instructions for EPrints 3.2 out to own page. Improved dependency installation instructions.

← Older revision		Revision as of 08:12, 20 June 2020
Line 3:		Line 3:
	[[Category:Plugins]]		[[Category:Plugins]]
	[[Category:Bazaar_Package]]		[[Category:Bazaar_Package]]
			[[Category:Eprints3.4]]
	[[Category:Eprints3.3]]		[[Category:Eprints3.3]]
	~~[[Category:Eprints3.2]]~~

	=What is IRStats2?=		=What is IRStats2?=
	IRStats2 is a statistical framework for EPrints - It comes with some cool default tools and reports and it can also be customised to, for instance, add new metrics or data sets. It has a Javascript API to include stats on any pages you want.		IRStats2 is a statistical framework for EPrints - It comes with some cool default tools and reports and it can also be customised to, for instance, add new metrics or data sets. It has a Javascript API to include stats on any pages you want.

	IRStats2 is developed against EPrints 3.3 but it was written to also work on EPrints 3.2. ~~Older versions of~~ EPrints ~~are, however, not~~ supported.		IRStats2 is developed against EPrints 3.4 and 3.3 but it was written to also work on EPrints 3.2. However, as EPrints 3.2 is no longer supported there is likewise no support for running IRStats2 on EPrints 3.2.

	=What's new in version 1.1?=		=What's new in version 1.1?=
Line 18:		Line 18:
	==Changes in 1.1, since 1.0.x==		==Changes in 1.1, since 1.0.x==

	~~Updates:~~		=== Features ===
			* IP based robot filtering and default values
			* Adding an option to only show live items in the stats

	*Feature: IP based robot filtering and default values		=== Improvements ===
	*~~Feature: Adding an option to only show live items in the stats~~		* Avoid using experimental perl code.(i.e. ~~ )
	*Enhancement: Avoid using experimental perl code.(i.e. ~~ )		* Restructure to make epm deployment easier
	*~~Enhancement: restructure~~ to make epm deployment easier		* Tooltip help text for KeyFigures
	*~~Enhancement: tooltip~~ help text for KeyFigures		* Optimisation for InnoDB
	*~~Enhancement:~~ Optimisation for ~~innodb~~		* CSV, JSON, XML saves file as instead of open directly in the browser
	*~~Enhancement:~~ CSV, JSON, XML saves file as instead of open directly in the browser		* Added missing libraries check (Date::Calc and Geo::IP) on bazaar installation page. resolves [https://github.com/eprints/irstats2/issues/10 #10]
	~~Enhancement:~~ Added missing libraries check (Date::Calc and Geo::IP) on bazaar installation page. resolves #10		* %IGNORE_LIST of words (stopwords) are very few and only in "en"
	*~~Bugfix: Stats::View::google::Graph lose first statistics #69~~		* Add support for transactions
	*~~Bugfix~~ for ~~Browser identification issue #66. Browser ID should be further improved~~

	~~Merged pull requests:~~		=== Bug Fixes ===
			* Stats::View::google::Graph lose first statistics [https://github.com/eprints/irstats2/issues/69 #69]
	*~~Enhancement~~: ~~%IGNORE_LIST of words (stopwords) are very few and only in "en"~~		* Browser identification issue [https://github.com/eprints/irstats2/issues/66 #66]
	*~~Enhancement~~: ~~Add support for transactions~~		* The title of Screen::IRStats2::Report should not change according to report you chose
	*~~Bugfix:~~ The title of Screen::IRStats2::Report should not change according to report you chose		* Avoid XSS vulnerability in some CGI output
	*~~Bugfix:~~ Avoid XSS vulnerability in some CGI output

	=Installation=		=Installation=

	==Dependencies==		==Dependencies==
	*Geo::IP or Geo::IP::PurePerl		* Geo::IP or Geo::IP::PurePerl
	*Date::Calc		* Date::Calc

	Both can usually be installed via your Linux package managers (apt-get, yum, ...) or via CPAN.		Both can usually be installed via your Linux package managers (apt-get, yum, ...) or via CPAN.

	~~e.g. in~~ Debian/Ubuntu:		=== Debian/Ubuntu ===
	~~<pre>~~		apt-get install libgeo-ip-perl libdate-calc-perl
	apt-get install libgeo-ip-perl libdate-calc-perl
	</~~pre>~~		=== RedHat/CentOS/Fedora ===
			yum install perl-Geo-IP perl-Date-Calce

			=== CPAN ===
			cpan Geo::IP Date::Calc

	==EPrints 3.3==		==EPrints 3.3 and 3.4==
	IRStats2 can be installed directly via the Bazaar on EPrints 3.3.		IRStats2 can be installed directly via the Bazaar on EPrints 3.3.

	===EPrints 3.3.11 onwards===		===EPrints 3.3.11 onwards===
	Installing IRStats2 from the Bazaar is all you need to do. It is recommend that you restart Apache after doing so.		Installing IRStats2 from the Bazaar is all you need to do. It is recommend that you restart Apache after doing so.


	===EPrints 3.3.1 to 3.3.10===		===EPrints 3.3.1 to 3.3.10===
Line 66:		Line 69:
	*[https://github.com/eprints/eprints/issues/130 Fix auto-completers]		*[https://github.com/eprints/eprints/issues/130 Fix auto-completers]

	==EPrints 3.2.x==		===EPrints 3.2.x===
	On EPrints 3.2 you will have to manually copy the required files to your EPrints installation path. It is a low-risk operation since IRStats2 is a true add-on to EPrints and it does not interact with the core software. You may want to back-up your EPrints files and your database but again, this should not be necessary.		See [[IRStats2/EPrints 3.2]]

	~~1. Get the files from GitHub or by following this [link https://github.com/eprints/irstats2/tarball/master~~] ~~[tar.gz]~~
	~~2. Copy the modules and various configuration files to your local archive:~~

	~~<pre>~~
	~~cp bin/* /opt/eprints3/archives/bin/~~
	~~cp cfg/* /opt/eprints3/archives/cfg/~~
	~~cp cgi/* /opt/eprints3/archives/cgi/~~

	~~(create the bin and cgi directories if they don't exist).~~
	~~</pre>~~

	~~3. Test everything is OK:~~

	~~<pre>~~
	~~/opt/eprints3/bin/epadmin test~~
	~~</pre>~~

	~~4. Add in the <head> sections of your template files (usually located in /opt/eprints3/archives//cfg/lang/en/templates/) the following:~~

	~~<pre>~~
	~~<script type="text/javascript" src="http://www.google.com/jsapi">// <!-- No script --></script>~~
	~~<script type="text/javascript">~~
	~~google.load("visualization", "1", {packages:["corechart", "geochart"~~]~~});~~
	~~</script>~~
	~~</pre>~~

	~~5. Restart the web server~~

	==Processing==		==Processing==

Th.lauke@arcor.de: categories added, typos corrected

2019-08-08T17:04:53Z

categories added, typos corrected

← Older revision		Revision as of 17:04, 8 August 2019
Line 1:		Line 1:
			[[Category:API]]
	[[Category:IRStats]]		[[Category:IRStats]]
	[[Category:Plugins]]		[[Category:Plugins]]
			[[Category:Bazaar_Package]]
	[[Category:Eprints3.3]]		[[Category:Eprints3.3]]
	[[Category:Eprints3.2]]		[[Category:Eprints3.2]]
Line 25:		Line 27:
	*Enhancement: Optimisation for innodb		*Enhancement: Optimisation for innodb
	*Enhancement: CSV, JSON, XML saves file as instead of open directly in the browser		*Enhancement: CSV, JSON, XML saves file as instead of open directly in the browser
	Enhancement: Added missing libraries check (Date::Calc and Geo::IP) on ~~bazzar~~ installation page. resolves #10		Enhancement: Added missing libraries check (Date::Calc and Geo::IP) on bazaar installation page. resolves #10
	*Bugfix: Stats::View::google::Graph lose first statistics #69		*Bugfix: Stats::View::google::Graph lose first statistics #69
	*Bugfix for Browser identification issue #66. Browser ID should be further improved		*Bugfix for Browser identification issue #66. Browser ID should be further improved
Line 71:		Line 73:

	<pre>		<pre>
	cp bin/* /opt/eprints3/archives//bin/		cp bin/* /opt/eprints3/archives/bin/
	cp cfg/* /opt/eprints3/archives//cfg/		cp cfg/* /opt/eprints3/archives/cfg/
	cp cgi/* /opt/eprints3/archives//cgi/		cp cgi/* /opt/eprints3/archives/cgi/

	(create the bin and cgi directories if they don't exist).		(create the bin and cgi directories if they don't exist).
Line 125:		Line 127:
	This section details how to configure IRStats2 and mostly relates to the file cfg/cfg.d/z_irstats2.pl.		This section details how to configure IRStats2 and mostly relates to the file cfg/cfg.d/z_irstats2.pl.

	It is recommended that you edit your changes in a separate file (eg. zz_irstats2_local.pl - must be loaded AFTER z_irstats2.pl) as this will make Bazaar updates easier to apply.		It is recommended that you edit your changes in a separate file (e.g. zz_irstats2_local.pl - must be loaded AFTER z_irstats2.pl) as this will make Bazaar updates easier to apply.

	==Datasets/Datatypes==		==Datasets/Datatypes==
Line 170:		Line 172:
	*'''name''': (optional - default to 'field') - the name of the set		*'''name''': (optional - default to 'field') - the name of the set
	*'''field''': the "eprint" field to use to generate set values		*'''field''': the "eprint" field to use to generate set values
	*'''groupings''': (optional - default to []) - an ARRAY of set names to use as groupings. A new grouping, ~~withing~~ a set, fills in the statement: "I want to be able to see Top Y per set". For instance for the set 'divisions' and the grouping 'authors': "I want to be able to see Top Authors per Divisions".		*'''groupings''': (optional - default to []) - an ARRAY of set names to use as groupings. A new grouping, within a set, fills in the statement: "I want to be able to see Top Y per set". For instance for the set 'divisions' and the grouping 'authors': "I want to be able to see Top Authors per Divisions".
	*'''anon''': (optional - default to ) - whether to make the set values anonymous (and hex MD5 is used instead). This is particularly useful when using authors' ID which is usually their email address (and you don't want to make these public).		*'''anon''': (optional - default to ) - whether to make the set values anonymous (and hex MD5 is used instead). This is particularly useful when using authors' ID which is usually their email address (and you don't want to make these public).
	*'''use_ids''': For compound fields only (especially for creators). Tell IRStats2 to use the "id" part to generate distinct set values. This is more accurate that using the "name" part only.		*'''use_ids''': For compound fields only (especially for creators). Tell IRStats2 to use the "id" part to generate distinct set values. This is more accurate that using the "name" part only.
Line 235:		Line 237:

	===Datatype===		===Datatype===
	Datatype refers to which data to provide with IRStats2 able to process any of data on your repository. The typical use of IRStats2 is however for usage statistics so this is the main dataset, but data on deposits, open access, full text (etc) are also processed. Some repositories even include data from ~~scopus~~ (citation counts).		Datatype refers to which data to provide with IRStats2 able to process any of data on your repository. The typical use of IRStats2 is however for usage statistics so this is the main dataset, but data on deposits, open access, full text (etc) are also processed. Some repositories even include data from Scopus (citation counts).

	Main datatypes:		Main datatypes:
Line 245:		Line 247:
	*doc_format: MIME type of full-texts		*doc_format: MIME type of full-texts
	*history: analysis of the "history" dataset - this provides information on when publications were created, edited, made live, deleted etc.		*history: analysis of the "history" dataset - this provides information on when publications were created, edited, made live, deleted etc.
	*referrer: information on how site visitors got to the repository (eg. from Google, internal uni pages, etc)		*referrer: information on how site visitors got to the repository (e.g. from Google, internal uni pages, etc)
	*search_terms: if coming from a search site (or the internal EPrints search) which words were used to get to the ~~publicaiton~~		*search_terms: if coming from a search site (or the internal EPrints search) which words were used to get to the publication
	*browser: which browser visitors used on the repository		*browser: which browser visitors used on the repository

Line 255:		Line 257:
	You can also restrict by dates or by a range. By default, all the stats are returned without any dates restrictions.		You can also restrict by dates or by a range. By default, all the stats are returned without any dates restrictions.

	Dates can be set as YYYYMMDD or YYYY-MM-DD or YYYY/MM/DD (eg. 20170101, 2017-11-04 etc). Dates is a hash containing two keys: from and to (either may be omitted to say: from that particular date, or up to that particular date).		Dates can be set as YYYYMMDD or YYYY-MM-DD or YYYY/MM/DD (e.g. 20170101, 2017-11-04 etc). Dates is a hash containing two keys: from and to (either may be omitted to say: from that particular date, or up to that particular date).

	Ranges follow a %d%c format and the upper limit is "now" or "today", for instance:		Ranges follow a %d%c format and the upper limit is "now" or "today", for instance:
Line 408:		Line 410:
	- limit: the max number of items to retrieve		- limit: the max number of items to retrieve
	- show_count: 1 or 0 - display the counts or not		- show_count: 1 or 0 - display the counts or not
	- show_order: 1 or 0 - display the ordering (1,2,3...) or not		- show_order: 1 or 0 - display the ordering (1,2,3 ...) or not
	- show_more: 1 or 0 - shows the "show more" options or not (to retrieve more results)		- show_more: 1 or 0 - shows the "show more" options or not (to retrieve more results)
	- human_display: 1 or 0 - separate 1000 with a comma (as done in English): 10000 becomes 10,000		- human_display: 1 or 0 - separate 1000 with a comma (as done in English): 10000 becomes 10,000
Line 727:		Line 729:
	/EPRINTS_ROOT/lib/plugins/EPrints/Plugin/Stats/Processor/Access/Country.pm		/EPRINTS_ROOT/lib/plugins/EPrints/Plugin/Stats/Processor/Access/Country.pm

	...and replace the line:		... and replace the line:

	$self->{geoip} = $pkg->new( $dat_file );		$self->{geoip} = $pkg->new( $dat_file );

	...with...		... with ...

	$self->{geoip} = $pkg->open( $dat_file );		$self->{geoip} = $pkg->open( $dat_file );