forked from figshare/Total-Impact
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathabout.php
executable file
·226 lines (163 loc) · 13.7 KB
/
about.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?php
require './bootstrap.php';
#require_once 'FirePHPCore/fb.php';
$config = new Zend_Config_Ini(CONFIG_PATH, ENV);
$couch = new Couch_Client($config->db->dsn, $config->db->name);
$collectionId = "RwIjOc"; #TODO: substitute with a collection with ID of"EXAMPLE_ALL_PLUGINS"
$report = new Models_Reporter($couch, $collectionId);
$res = $report->fetch();
$rendered_about_text = $report->render_about_text();
?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>Total Impact</title>
<link rel="stylesheet" type="text/css" href="./ui/totalimpact.css" />
<script type="text/javascript">
//Google Analytics code
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23384030-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<!-- START wrapper -->
<div id="wrapper">
<!-- START header -->
<div id="header">
<a href="./index.php"><img src="./ui/img/ti_logo.png" alt="total-impact" width='200px' /></a>
</div>
<!-- END header -->
<!-- START instr -->
<div id="instr">
<h2><a>what is total-impact?</a></h2>
<p>Total-impact makes it quick and easy to view the impact of a wide range of research artifacts. It goes beyond traditional measurements of research output -- citations to papers -- to embrace a much broader evidence of use across a wide range of scholarly output types. The system aggregates impact data from many sources and displays it in a single report, which is given a permaurl for dissemination and can be updated any time.
<h2>who is it for?</h2>
<ul>
<li><b>researchers</b> who want to know how many times their work has been downloaded, bookmarked, and blogged
<li><b>research groups</b> who want to look at the broad impact of their work and see who has demonstrated interest
<li><b>funders</b> who want to see what sort of impact they may be missing when only considering citations to papers
<li><b>repositories</b> who want to report on how their research artifacts are being discussed
<li><b>all of us</b> who believe that people should be rewarded when their work (no matter what the format) makes a positive impact (no matter what the venue). Aggregating evidence of impact will facilitate appropriate rewards, thereby encouraging additional openness of useful forms of research output.
</ul>
<h2>how should it be used?</h2>
Total-impact data can be:
<ul>
<li>highlighted as indications of the *minimum* impact a research artifact has made on the community
<li>explored more deeply to see who is citing, bookmarking, and otherwise using your work
<li>run to collect usage information for mention in biosketches
<li>included as a link in CVs
<li>analyzed by downloading detailed metric information
</ul>
<h2>how <em>shouldn’t</em> it be used?</h2>
<p>some of these issues relate to the early-development phase of total-impact, some reflect our early-understanding of altmetrics, and some are just common sense.
<ul>
<li><b>as indication of comprehensive impact</b>
<p>Total-impact is in early development. See <a href="#limitations">limitations</a> and take it all with a grain of salt.
<li><b>for serious comparison</b>
<p>Total-impact is currently better at collecting comprehensive metrics for some artifacts than others, in ways that are not clear in the report. Extreme care should be taken in comparisons. Numbers should be considered minimums. Even more care should be taken in comparing collections of artifacts, since some total-impact is currently better at identifying artifacts identified in some ways than others. Finally, some of these metrics can be easily gamed. This is one reason we believe having many metrics is valuable.
<li><b>as if we knew exactly what it means</b>
<p>The meaning of these metrics are not yet well understood; see <a href="#meaning">section</a> below.
<li><b>as a substitute for personal judgement of quality</b>
<p>Metrics are only one part of the story. Look at the research artifact for yourself and talk about it with informed colleagues.
</ul>
<a name="meaning"><h2>what do these number actually mean?</h2></a>
<p>The short answer is: probably something useful, but we’re not sure what. We believe that dismissing the metrics as “buzz” is short-sited: surely people bookmark and download things for a reason. The long answer, as well as a lot more speculation on the long-term significance of tools like total-impact, can be found in the nascent scholarly literature on “altmetrics.”
<p><a href="http://altmetrics.org/manifesto/">The Altmetrics Manifesto</a> is a good, easily-readable introduction to this literature, while the proceedings of the recent <a href="http://altmetrics.org/workshop2011/">altmetrics11</a> workshop goes into more detail. You can check out the shared <a href="http://www.mendeley.com/groups/586171/alt-metrics/papers/">altmetrics library</a> on Mendeley for more even relevant research. Finally, the poster <a href="http://jasonpriem.com/self-archived/two-altmetrics-tools.pdf">Uncovering impacts: CitedIn and total-impact, two new tools for gathering altmetrics</a>, recently submitted to the 2012 iConference, describes a case study using total-impact to evaluate a set of research papers funded by NESCent; it has some brief statistical analysis and some visualisations of the results.
<h2>what types of research output does it track?</h2>
<ul>
<li>Papers by DOI, PubMed ID, Mendeley UUID
<li>Datasets by Dryad DOI and Genbank/PDB/GEO/ArrayExpress/etc accession number
<li>Slide decks by SlideShare URL
</ul>
We expect to support more artifact types soon!
<h2>what types of metrics does it track?</h2>
<p>Metrics are computed based on the following data sources:</p>
<?php
echo "$rendered_about_text";
?>
<h2>where is the journal impact factor?</h2>
<p>We do not include the Journal Impact Factor (or any similar proxy) on purpose. As has been <a href="https://www.zotero.org/groups/impact_factor_problems/items">repeatedly shown</a>, the Impact Factor is not appropriate for judging the quality of individual research artifacts. Individual article citations reflect much more about how useful papers actually were. Better yet are article-level metrics, as initiated by PLoS, in which we examine traces of impact beyond citation. total-impact broadens this approach to reflect <b>artifact-level metrics</b>, by inclusion of preprints, datasets, presentation slides, and other research output formats.
<h2>where is my other favourite metric?</h2>
<p>Only open ones here, and only a selection of those. we welcome contributions of plugins. Here is the API. Your plugin need not reside on our server: you can host it, if we can call it with our REST interface. Write your own and tell us about it.
<p>You can also check out these similar tools:
<ul>
<li><a href="http://altmetric.com/interface/explorer.html">altmetric.com API demo</a>
<li><a href="http://citedin.org/">CitedIn</a>
<li><a href="http://code.google.com/p/alt-metrics/">PLoS Article-Level Metrics application</a>
<li><a href="http://readermeter.org/">ReaderMeter</a>
<li><a href="http://sciencecard.org/">Science Card</a>
</ul>
<a name="limitations"><h2>what are the current limitations of the system?</h2></a>
<p>Total-impact is in early development and has many limitations:
<h3>Gathering IDs and quick reports sometimes miss artifacts</h3>
<ul>
<li>seeds only first page of the Mendeley profile
<li>misses papers in Mendeley profiles when the paper doesn’t have a ID in the “rft_id” attribute of the html source.
<li>Mendeley groups detail page only shows public groups
<li>seeds only first 100 artifacts from Mendeley groups
<li>doesn’t handle dois for books properly
</ul>
<h3>Artifacts are sometimes missing metrics</h3>
<ul>
<li>doesn’t display metrics with a zero value, though this information is included in raw data for download
<li>sometimes the artifacts were received without sufficient information to use all metrics. For example, the system sometimes can't figure out the DOI from a Mendeley UUID or URL.
</ul>
<h3>Metrics sometimes have values that are too low</h3>
<ul>
<li>some sources have multiple records for a given artifact. Total-impact only identifies one copy and so only reports the impact metrics for that record. It makes no current attempt to aggregate across duplications within a source.
</ul>
<h3>Other</h3>
<ul>
<li>max of 250 artifacts in a report; artifact list that are too long are truncated and a note is displayed on the report.
</ul>
<h2>is this data Open?</h2>
<p>We’d like to make all of the data displayed by total-impact available under CC0. Unfortunately, the terms-of-use of most of the data sources don’t allow that.
<p>An option to restrict the displayed reports to Fully Open metrics — those suitable for commercial use — is coming soon!
<h2>does total-impact have an api?</h2>
<p>yes, kinda. Our plugins do, and you can query the update.php with a series of GET requests. Please don’t overload our servers, and do add an &email=YOUREMAIL tag on so we contact you if necessary based on your usage patterns. This is still very new: don’t hesitate to get in touch to figure it out with us.
<h2>who developed total-impact?</h2>
<p>Concept originally hacked at the <a href="http://www.beyond-impact.org/">Beyond Impact Workshop</a>. <a href="https://github.com/mhahnel/total-impact">Source and contributors</a> on GitHub.
The majority of the development effort on this skunkworks project was done on personal time, plus some discretionary time while funded through <a href="http://dataone.org">DataONE</a> and a UNC Royster Fellowship.
<h2>what have we learned?</h2>
<ul>
<li>the multitude of IDs for an artifact is a bigger problem than we guessed. Even articles that have DOIs often also have urls, PubMed IDs, PubMed Central IDs, Mendeley IDs, etc. There is no one place to find all synonyms, yet the various APIs often only work with a specific one or two ID types. This makes comprehensive impact-gathering time consuming and error-prone.
<li>some data is harder to get than we thought (wordpress stats without requesting consumer key information)
<li>some data is easier to get than we thought (vendors willing to work out special agreements, permit web scraping for particular purposes, etc)
<li>lack of an author-identifier makes us reliant on user-populated systems like Mendeley for tracking author-based work (we need ORCID and we need it now)
<li>API limits like those on PubMed Central (3 request per second) make their data difficult to incorporate in this sort of application
</ul>
<h2>how can I help?</h2>
<ul>
<li><b>can you write code?</b> Dive in! github url:
<li><b>do you have data?</b> If it is already available in some pubic format, let us know so we can add it. If it isn’t, either please open it up or contact us to work out some mutually beneficial way we can work together.
<li><b>do you have money?</b> We need money :) We need to fund future development of the system and are actively looking for appropriate opportunities.
<li><b>do you have ideas?</b> maybe enhancements to total-impact would fit in with a grant you are writing, or you want to make it work extra-well for your institution’s research outputs. we’re interested, please get in touch (see bottom).
<li><b>do you have energy?</b> we need better “see what it does” documentation, better lists of collections, etc. Make some and tell us, please.
<li><b>do you have anger that your favourite data source is missing?</b> After you confirm that it isn’t making its data available for open purposes like this, write to them to ask!
<li><b>can you email, blog, post, tweet, or walk down the hall to tell a friend?</b> See “this is so cool” for your vital role....
</ul>
<h2>this is so cool.</h2>
<p>Thanks! We agree :)
<p>You can help us. We are currently trying to a) win the PLoS/Mendeley Binary Battle because that sounds fun, b) raise funding for future total-impact development, and c) justify spending more time on this ourselves. Buzz and testimonials will help. Tweet your reports. Sign up for Mendeley, add public publications to your profile, and make some public groups. Tweet, blog, send email, and show off total-impact at your next group meeting to help spread the word.
<p>Tell us how cool it is at <a href="http://twitter.com/#!/totalimpactdev">@totalimpactdev</a> (or via email to total-impact@googlegroups.com) so we can consolidate the feedback.
<h2>I have a suggestion!</h2>
<p><b>We want to hear it.</b> Send it to us at <a href="http://twitter.com/#!/totalimpactdev">@totalimpactdev</a> (or via email to total-impact@googlegroups.com). Total-impact development will slow for a bit while we get back to our research-paper-writing day jobs, so we aren’t sure when we’ll have another spurt of time for implementation.... but we want to hear your idea now so we can work on it as soon as we can.
</div>
<!-- END instr -->
<div id="footer">
<table border=0 width=100%><tr>
<td><a href="./about.php">about total-impact</a></td>
<td align="center">Reactions and bugs welcome to <a href="http://twitter.com/#!/totalimpactdev">@totalimpactdev</a></td>
<td align="left"><a class="img" href="http://altmetrics.org" title="an altmetrics project"><img src="./ui/img/altmetrics_logo.png" alt="altmetrics" width="80" style="margin-bottom:5px" /></a></td>
</tr>
</div>
<!-- END footer -->
</body>
</html>