retreval 0.1 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/TODO +1 -1
- data/doc/CHANGELOG.html +124 -0
- data/doc/Retreval.html +212 -0
- data/doc/Retreval/Document.html +297 -0
- data/doc/Retreval/GoldStandard.html +1013 -0
- data/doc/Retreval/Judgement.html +353 -0
- data/doc/Retreval/Options.html +406 -0
- data/doc/Retreval/Query.html +296 -0
- data/doc/Retreval/QueryResult.html +746 -0
- data/doc/Retreval/QueryResultSet.html +429 -0
- data/doc/Retreval/RankedQueryResult.html +556 -0
- data/doc/Retreval/ResultDocument.html +253 -0
- data/doc/Retreval/Runner.html +506 -0
- data/doc/Retreval/UnrankedQueryResult.html +278 -0
- data/doc/Retreval/User.html +354 -0
- data/doc/TODO.html +124 -0
- data/doc/TestGoldStandard.html +551 -0
- data/doc/TestQueryResult.html +606 -0
- data/doc/bin/retreval.html +54 -0
- data/doc/created.rid +10 -0
- data/doc/index.html +218 -0
- data/doc/lib/retreval/gold_standard_rb.html +52 -0
- data/doc/lib/retreval/options_rb.html +56 -0
- data/doc/lib/retreval/query_result_rb.html +54 -0
- data/doc/lib/retreval/runner_rb.html +56 -0
- data/doc/rdoc.css +706 -0
- data/doc/test/test_gold_standard_rb.html +56 -0
- data/doc/test/test_query_result_rb.html +58 -0
- data/lib/retreval/gold_standard.rb +6 -9
- data/lib/retreval/query_result.rb +5 -2
- data/retreval.gemspec +1 -1
- metadata +29 -2
|
@@ -0,0 +1,353 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Class: Retreval::Judgement</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="../js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="../js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="../js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="../js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="class">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="../index.html">Home</a>
|
|
29
|
+
<a href="../index.html#classes">Classes</a>
|
|
30
|
+
<a href="../index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="file-metadata">
|
|
36
|
+
<div id="file-list-section" class="section">
|
|
37
|
+
<h3 class="section-header">In Files</h3>
|
|
38
|
+
<div class="section-body">
|
|
39
|
+
<ul>
|
|
40
|
+
|
|
41
|
+
<li><a href="../lib/retreval/gold_standard_rb.html?TB_iframe=true&height=550&width=785"
|
|
42
|
+
class="thickbox" title="lib/retreval/gold_standard.rb">lib/retreval/gold_standard.rb</a></li>
|
|
43
|
+
|
|
44
|
+
</ul>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="class-metadata">
|
|
52
|
+
|
|
53
|
+
<!-- Parent Class -->
|
|
54
|
+
|
|
55
|
+
<div id="parent-class-section" class="section">
|
|
56
|
+
<h3 class="section-header">Parent</h3>
|
|
57
|
+
|
|
58
|
+
<p class="link">Object</p>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<!-- Namespace Contents -->
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<!-- Method Quickref -->
|
|
67
|
+
|
|
68
|
+
<div id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
<ul class="link-list">
|
|
71
|
+
|
|
72
|
+
<li><a href="#method-c-new">::new</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="#method-i-%3D%3D">#==</a></li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<!-- Included Modules -->
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
|
|
84
|
+
<div id="project-metadata">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<div id="fileindex-section" class="section project-section">
|
|
88
|
+
<h3 class="section-header">Files</h3>
|
|
89
|
+
<ul>
|
|
90
|
+
|
|
91
|
+
<li class="file"><a href="../CHANGELOG.html">CHANGELOG</a></li>
|
|
92
|
+
|
|
93
|
+
<li class="file"><a href="../TODO.html">TODO</a></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div id="classindex-section" class="section project-section">
|
|
100
|
+
<h3 class="section-header">Class Index
|
|
101
|
+
<span class="search-toggle"><img src="../images/find.png"
|
|
102
|
+
height="16" width="16" alt="[+]"
|
|
103
|
+
title="show/hide quicksearch" /></span></h3>
|
|
104
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
105
|
+
<fieldset>
|
|
106
|
+
<legend>Quicksearch</legend>
|
|
107
|
+
<input type="text" name="quicksearch" value=""
|
|
108
|
+
class="quicksearch-field" />
|
|
109
|
+
</fieldset>
|
|
110
|
+
</form>
|
|
111
|
+
|
|
112
|
+
<ul class="link-list">
|
|
113
|
+
|
|
114
|
+
<li><a href="../Retreval.html">Retreval</a></li>
|
|
115
|
+
|
|
116
|
+
<li><a href="../Retreval/Document.html">Retreval::Document</a></li>
|
|
117
|
+
|
|
118
|
+
<li><a href="../Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
119
|
+
|
|
120
|
+
<li><a href="../Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
121
|
+
|
|
122
|
+
<li><a href="../Retreval/Options.html">Retreval::Options</a></li>
|
|
123
|
+
|
|
124
|
+
<li><a href="../Retreval/Query.html">Retreval::Query</a></li>
|
|
125
|
+
|
|
126
|
+
<li><a href="../Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
127
|
+
|
|
128
|
+
<li><a href="../Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
129
|
+
|
|
130
|
+
<li><a href="../Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
131
|
+
|
|
132
|
+
<li><a href="../Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
133
|
+
|
|
134
|
+
<li><a href="../Retreval/Runner.html">Retreval::Runner</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="../Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="../Retreval/User.html">Retreval::User</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="../TestGoldStandard.html">TestGoldStandard</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="../TestQueryResult.html">TestQueryResult</a></li>
|
|
143
|
+
|
|
144
|
+
</ul>
|
|
145
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</div>
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
<div id="documentation">
|
|
153
|
+
<h1 class="class">Retreval::Judgement</h1>
|
|
154
|
+
|
|
155
|
+
<div id="description">
|
|
156
|
+
<p>
|
|
157
|
+
A <a href="Judgement.html">Judgement</a> references one query and one
|
|
158
|
+
document as being relevant to each other or not. It also keeps track of the
|
|
159
|
+
<a href="User.html">User</a> who created the <a
|
|
160
|
+
href="Judgement.html">Judgement</a>, if necessary.
|
|
161
|
+
</p>
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<!-- Constants -->
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<!-- Attributes -->
|
|
169
|
+
|
|
170
|
+
<div id="attribute-method-details" class="method-section section">
|
|
171
|
+
<h3 class="section-header">Attributes</h3>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<div id="relevant-attribute-method" class="method-detail">
|
|
175
|
+
<a name="relevant"></a>
|
|
176
|
+
|
|
177
|
+
<div class="method-heading attribute-method-heading">
|
|
178
|
+
<span class="method-name">relevant</span><span
|
|
179
|
+
class="attribute-access-type">[R]</span>
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
<div class="method-description">
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
<div id="document-attribute-method" class="method-detail">
|
|
190
|
+
<a name="document"></a>
|
|
191
|
+
|
|
192
|
+
<div class="method-heading attribute-method-heading">
|
|
193
|
+
<span class="method-name">document</span><span
|
|
194
|
+
class="attribute-access-type">[R]</span>
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
<div class="method-description">
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
<div id="query-attribute-method" class="method-detail">
|
|
205
|
+
<a name="query"></a>
|
|
206
|
+
|
|
207
|
+
<div class="method-heading attribute-method-heading">
|
|
208
|
+
<span class="method-name">query</span><span
|
|
209
|
+
class="attribute-access-type">[R]</span>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
<div class="method-description">
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
</div>
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
<div id="user-attribute-method" class="method-detail">
|
|
220
|
+
<a name="user"></a>
|
|
221
|
+
|
|
222
|
+
<div class="method-heading attribute-method-heading">
|
|
223
|
+
<span class="method-name">user</span><span
|
|
224
|
+
class="attribute-access-type">[R]</span>
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
<div class="method-description">
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</div>
|
|
232
|
+
</div>
|
|
233
|
+
|
|
234
|
+
</div>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<!-- Methods -->
|
|
238
|
+
|
|
239
|
+
<div id="public-class-method-details" class="method-section section">
|
|
240
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<div id="new-method" class="method-detail ">
|
|
244
|
+
<a name="method-c-new"></a>
|
|
245
|
+
|
|
246
|
+
<div class="method-heading">
|
|
247
|
+
|
|
248
|
+
<span class="method-name">new</span><span
|
|
249
|
+
class="method-args">(args)</span>
|
|
250
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
251
|
+
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
<div class="method-description">
|
|
255
|
+
|
|
256
|
+
<p>
|
|
257
|
+
Creates a new <a href="Judgement.html">Judgement</a> that belongs to a <a
|
|
258
|
+
href="Query.html">Query</a>, a <a href="Document.html">Document</a>, and
|
|
259
|
+
optionally to a <a href="User.html">User</a> Called by (note the usage of
|
|
260
|
+
IDs, not objects):
|
|
261
|
+
</p>
|
|
262
|
+
<pre>
|
|
263
|
+
Judgement.new :document => my_doc_id, :user => my_user_id, :query => query_string, :relevant => true</pre>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<div class="method-source-code"
|
|
268
|
+
id="new-source">
|
|
269
|
+
<pre>
|
|
270
|
+
<span class="ruby-comment cmt"># File lib/retreval/gold_standard.rb, line 376</span>
|
|
271
|
+
376: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>)
|
|
272
|
+
377: <span class="ruby-ivar">@relevant</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:relevant</span>]
|
|
273
|
+
378: <span class="ruby-ivar">@document</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:document</span>]
|
|
274
|
+
379: <span class="ruby-ivar">@query</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:query</span>]
|
|
275
|
+
380: <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:user</span>]
|
|
276
|
+
381: <span class="ruby-keyword kw">end</span></pre>
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</div>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
<div id="public-instance-method-details" class="method-section section">
|
|
290
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<div id="--method" class="method-detail ">
|
|
294
|
+
<a name="method-i-%3D%3D"></a>
|
|
295
|
+
|
|
296
|
+
<div class="method-heading">
|
|
297
|
+
|
|
298
|
+
<span class="method-name">==</span><span
|
|
299
|
+
class="method-args">(judgement)</span>
|
|
300
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
|
|
304
|
+
<div class="method-description">
|
|
305
|
+
|
|
306
|
+
<p>
|
|
307
|
+
A <a href="Judgement.html">Judgement</a> is considered equal to another
|
|
308
|
+
when they are for the same <a href="Query.html">Query</a> or <a
|
|
309
|
+
href="Document.html">Document</a>. This comparison happens regardless of
|
|
310
|
+
the user, so it is easier to generate “unique” Judgements or
|
|
311
|
+
calculate the kappa measure.
|
|
312
|
+
</p>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<div class="method-source-code"
|
|
317
|
+
id="--source">
|
|
318
|
+
<pre>
|
|
319
|
+
<span class="ruby-comment cmt"># File lib/retreval/gold_standard.rb, line 387</span>
|
|
320
|
+
387: <span class="ruby-keyword kw">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">judgement</span>)
|
|
321
|
+
388: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">document</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">judgement</span>.<span class="ruby-identifier">document</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">query</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">judgement</span>.<span class="ruby-identifier">query</span>
|
|
322
|
+
389: <span class="ruby-keyword kw">end</span></pre>
|
|
323
|
+
</div>
|
|
324
|
+
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</div>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
340
|
+
|
|
341
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
342
|
+
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
<div id="validator-badges">
|
|
346
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
347
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
348
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
</body>
|
|
352
|
+
</html>
|
|
353
|
+
|
|
@@ -0,0 +1,406 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
3
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
4
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
5
|
+
<head>
|
|
6
|
+
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
|
|
7
|
+
|
|
8
|
+
<title>Class: Retreval::Options</title>
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
|
|
11
|
+
|
|
12
|
+
<script src="../js/jquery.js" type="text/javascript"
|
|
13
|
+
charset="utf-8"></script>
|
|
14
|
+
<script src="../js/thickbox-compressed.js" type="text/javascript"
|
|
15
|
+
charset="utf-8"></script>
|
|
16
|
+
<script src="../js/quicksearch.js" type="text/javascript"
|
|
17
|
+
charset="utf-8"></script>
|
|
18
|
+
<script src="../js/darkfish.js" type="text/javascript"
|
|
19
|
+
charset="utf-8"></script>
|
|
20
|
+
|
|
21
|
+
</head>
|
|
22
|
+
<body class="class">
|
|
23
|
+
|
|
24
|
+
<div id="metadata">
|
|
25
|
+
<div id="home-metadata">
|
|
26
|
+
<div id="home-section" class="section">
|
|
27
|
+
<h3 class="section-header">
|
|
28
|
+
<a href="../index.html">Home</a>
|
|
29
|
+
<a href="../index.html#classes">Classes</a>
|
|
30
|
+
<a href="../index.html#methods">Methods</a>
|
|
31
|
+
</h3>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="file-metadata">
|
|
36
|
+
<div id="file-list-section" class="section">
|
|
37
|
+
<h3 class="section-header">In Files</h3>
|
|
38
|
+
<div class="section-body">
|
|
39
|
+
<ul>
|
|
40
|
+
|
|
41
|
+
<li><a href="../lib/retreval/options_rb.html?TB_iframe=true&height=550&width=785"
|
|
42
|
+
class="thickbox" title="lib/retreval/options.rb">lib/retreval/options.rb</a></li>
|
|
43
|
+
|
|
44
|
+
</ul>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="class-metadata">
|
|
52
|
+
|
|
53
|
+
<!-- Parent Class -->
|
|
54
|
+
|
|
55
|
+
<div id="parent-class-section" class="section">
|
|
56
|
+
<h3 class="section-header">Parent</h3>
|
|
57
|
+
|
|
58
|
+
<p class="link">Object</p>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<!-- Namespace Contents -->
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
<!-- Method Quickref -->
|
|
67
|
+
|
|
68
|
+
<div id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
<ul class="link-list">
|
|
71
|
+
|
|
72
|
+
<li><a href="#method-c-new">::new</a></li>
|
|
73
|
+
|
|
74
|
+
<li><a href="#method-i-parse">#parse</a></li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<!-- Included Modules -->
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
|
|
84
|
+
<div id="project-metadata">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<div id="fileindex-section" class="section project-section">
|
|
88
|
+
<h3 class="section-header">Files</h3>
|
|
89
|
+
<ul>
|
|
90
|
+
|
|
91
|
+
<li class="file"><a href="../CHANGELOG.html">CHANGELOG</a></li>
|
|
92
|
+
|
|
93
|
+
<li class="file"><a href="../TODO.html">TODO</a></li>
|
|
94
|
+
|
|
95
|
+
</ul>
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div id="classindex-section" class="section project-section">
|
|
100
|
+
<h3 class="section-header">Class Index
|
|
101
|
+
<span class="search-toggle"><img src="../images/find.png"
|
|
102
|
+
height="16" width="16" alt="[+]"
|
|
103
|
+
title="show/hide quicksearch" /></span></h3>
|
|
104
|
+
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
|
|
105
|
+
<fieldset>
|
|
106
|
+
<legend>Quicksearch</legend>
|
|
107
|
+
<input type="text" name="quicksearch" value=""
|
|
108
|
+
class="quicksearch-field" />
|
|
109
|
+
</fieldset>
|
|
110
|
+
</form>
|
|
111
|
+
|
|
112
|
+
<ul class="link-list">
|
|
113
|
+
|
|
114
|
+
<li><a href="../Retreval.html">Retreval</a></li>
|
|
115
|
+
|
|
116
|
+
<li><a href="../Retreval/Document.html">Retreval::Document</a></li>
|
|
117
|
+
|
|
118
|
+
<li><a href="../Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
|
|
119
|
+
|
|
120
|
+
<li><a href="../Retreval/Judgement.html">Retreval::Judgement</a></li>
|
|
121
|
+
|
|
122
|
+
<li><a href="../Retreval/Options.html">Retreval::Options</a></li>
|
|
123
|
+
|
|
124
|
+
<li><a href="../Retreval/Query.html">Retreval::Query</a></li>
|
|
125
|
+
|
|
126
|
+
<li><a href="../Retreval/QueryResult.html">Retreval::QueryResult</a></li>
|
|
127
|
+
|
|
128
|
+
<li><a href="../Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
|
|
129
|
+
|
|
130
|
+
<li><a href="../Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
|
|
131
|
+
|
|
132
|
+
<li><a href="../Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
|
|
133
|
+
|
|
134
|
+
<li><a href="../Retreval/Runner.html">Retreval::Runner</a></li>
|
|
135
|
+
|
|
136
|
+
<li><a href="../Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
|
|
137
|
+
|
|
138
|
+
<li><a href="../Retreval/User.html">Retreval::User</a></li>
|
|
139
|
+
|
|
140
|
+
<li><a href="../TestGoldStandard.html">TestGoldStandard</a></li>
|
|
141
|
+
|
|
142
|
+
<li><a href="../TestQueryResult.html">TestQueryResult</a></li>
|
|
143
|
+
|
|
144
|
+
</ul>
|
|
145
|
+
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
</div>
|
|
150
|
+
</div>
|
|
151
|
+
|
|
152
|
+
<div id="documentation">
|
|
153
|
+
<h1 class="class">Retreval::Options</h1>
|
|
154
|
+
|
|
155
|
+
<div id="description">
|
|
156
|
+
<p>
|
|
157
|
+
Some options that can be passed when the script is run from the commandline
|
|
158
|
+
</p>
|
|
159
|
+
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
<!-- Constants -->
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<!-- Attributes -->
|
|
166
|
+
|
|
167
|
+
<div id="attribute-method-details" class="method-section section">
|
|
168
|
+
<h3 class="section-header">Attributes</h3>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div id="query-result-set-file-attribute-method" class="method-detail">
|
|
172
|
+
<a name="query_result_set_file"></a>
|
|
173
|
+
|
|
174
|
+
<a name="query_result_set_file="></a>
|
|
175
|
+
|
|
176
|
+
<div class="method-heading attribute-method-heading">
|
|
177
|
+
<span class="method-name">query_result_set_file</span><span
|
|
178
|
+
class="attribute-access-type">[RW]</span>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
<div class="method-description">
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
|
|
188
|
+
<div id="gold-standard-file-attribute-method" class="method-detail">
|
|
189
|
+
<a name="gold_standard_file"></a>
|
|
190
|
+
|
|
191
|
+
<a name="gold_standard_file="></a>
|
|
192
|
+
|
|
193
|
+
<div class="method-heading attribute-method-heading">
|
|
194
|
+
<span class="method-name">gold_standard_file</span><span
|
|
195
|
+
class="attribute-access-type">[RW]</span>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
<div class="method-description">
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
<div id="format-attribute-method" class="method-detail">
|
|
206
|
+
<a name="format"></a>
|
|
207
|
+
|
|
208
|
+
<a name="format="></a>
|
|
209
|
+
|
|
210
|
+
<div class="method-heading attribute-method-heading">
|
|
211
|
+
<span class="method-name">format</span><span
|
|
212
|
+
class="attribute-access-type">[RW]</span>
|
|
213
|
+
</div>
|
|
214
|
+
|
|
215
|
+
<div class="method-description">
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
<div id="interactive-attribute-method" class="method-detail">
|
|
223
|
+
<a name="interactive"></a>
|
|
224
|
+
|
|
225
|
+
<a name="interactive="></a>
|
|
226
|
+
|
|
227
|
+
<div class="method-heading attribute-method-heading">
|
|
228
|
+
<span class="method-name">interactive</span><span
|
|
229
|
+
class="attribute-access-type">[RW]</span>
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
<div class="method-description">
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</div>
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
<div id="output-attribute-method" class="method-detail">
|
|
240
|
+
<a name="output"></a>
|
|
241
|
+
|
|
242
|
+
<a name="output="></a>
|
|
243
|
+
|
|
244
|
+
<div class="method-heading attribute-method-heading">
|
|
245
|
+
<span class="method-name">output</span><span
|
|
246
|
+
class="attribute-access-type">[RW]</span>
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
<div class="method-description">
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</div>
|
|
254
|
+
</div>
|
|
255
|
+
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<!-- Methods -->
|
|
260
|
+
|
|
261
|
+
<div id="public-class-method-details" class="method-section section">
|
|
262
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<div id="new-method" class="method-detail ">
|
|
266
|
+
<a name="method-c-new"></a>
|
|
267
|
+
|
|
268
|
+
<div class="method-heading">
|
|
269
|
+
|
|
270
|
+
<span class="method-name">new</span><span
|
|
271
|
+
class="method-args">(args)</span>
|
|
272
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
273
|
+
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
<div class="method-description">
|
|
277
|
+
|
|
278
|
+
<p>
|
|
279
|
+
Just initialize the OptionParser and try to parse the arguments
|
|
280
|
+
</p>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<div class="method-source-code"
|
|
285
|
+
id="new-source">
|
|
286
|
+
<pre>
|
|
287
|
+
<span class="ruby-comment cmt"># File lib/retreval/options.rb, line 12</span>
|
|
288
|
+
12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>)
|
|
289
|
+
13: <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">args</span>)
|
|
290
|
+
14: <span class="ruby-keyword kw">end</span></pre>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
</div>
|
|
302
|
+
|
|
303
|
+
<div id="private-instance-method-details" class="method-section section">
|
|
304
|
+
<h3 class="section-header">Private Instance Methods</h3>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<div id="parse-method" class="method-detail ">
|
|
308
|
+
<a name="method-i-parse"></a>
|
|
309
|
+
|
|
310
|
+
<div class="method-heading">
|
|
311
|
+
|
|
312
|
+
<span class="method-name">parse</span><span
|
|
313
|
+
class="method-args">(args)</span>
|
|
314
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
315
|
+
|
|
316
|
+
</div>
|
|
317
|
+
|
|
318
|
+
<div class="method-description">
|
|
319
|
+
|
|
320
|
+
<p>
|
|
321
|
+
Parse the arguments that were passed
|
|
322
|
+
</p>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<div class="method-source-code"
|
|
327
|
+
id="parse-source">
|
|
328
|
+
<pre>
|
|
329
|
+
<span class="ruby-comment cmt"># File lib/retreval/options.rb, line 19</span>
|
|
330
|
+
19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">args</span>)
|
|
331
|
+
20: <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
|
|
332
|
+
21: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-value str">"Usage: retreval [options]"</span>
|
|
333
|
+
22: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">"Mandatory options (choose one):"</span>
|
|
334
|
+
23:
|
|
335
|
+
24: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-l"</span>, <span class="ruby-value str">"--load <gold-standard-file>"</span>, <span class="ruby-value str">"Load the gold standard from this file"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
|
|
336
|
+
25: <span class="ruby-ivar">@gold_standard_file</span> = <span class="ruby-identifier">file</span>
|
|
337
|
+
26: <span class="ruby-keyword kw">end</span>
|
|
338
|
+
27:
|
|
339
|
+
28: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-q"</span>, <span class="ruby-value str">"--queries <query-results-file>"</span>, <span class="ruby-value str">"Load the query result set from this file"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
|
|
340
|
+
29: <span class="ruby-ivar">@query_result_set_file</span> = <span class="ruby-identifier">file</span>
|
|
341
|
+
30: <span class="ruby-keyword kw">end</span>
|
|
342
|
+
31:
|
|
343
|
+
32: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-f"</span>, <span class="ruby-value str">"--format <format>"</span>, <span class="ruby-value str">"Use this data format when parsing files. Can be one of <yaml|plain>"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
|
|
344
|
+
33: <span class="ruby-ivar">@format</span> = <span class="ruby-identifier">format</span>
|
|
345
|
+
34: <span class="ruby-keyword kw">end</span>
|
|
346
|
+
35:
|
|
347
|
+
36: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-o"</span>, <span class="ruby-value str">"--output <output-file-prefix>"</span>, <span class="ruby-value str">"Use this prefix for creating output files, default is 'output'."</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
|
|
348
|
+
37: <span class="ruby-ivar">@output</span> = <span class="ruby-identifier">file</span>
|
|
349
|
+
38: <span class="ruby-keyword kw">end</span>
|
|
350
|
+
39:
|
|
351
|
+
40: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">"Common options:"</span>
|
|
352
|
+
41:
|
|
353
|
+
42: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"-v"</span>, <span class="ruby-value str">"--verbose"</span>, <span class="ruby-value str">"Verbose (debug) mode"</span>) <span class="ruby-keyword kw">do</span>
|
|
354
|
+
43: <span class="ruby-identifier">$verbose</span> = <span class="ruby-keyword kw">true</span>
|
|
355
|
+
44: <span class="ruby-keyword kw">end</span>
|
|
356
|
+
45:
|
|
357
|
+
46: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"-h"</span>, <span class="ruby-value str">"--help"</span>, <span class="ruby-value str">"Show this message"</span>) <span class="ruby-keyword kw">do</span>
|
|
358
|
+
47: <span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>
|
|
359
|
+
48: <span class="ruby-identifier">exit</span>
|
|
360
|
+
49: <span class="ruby-keyword kw">end</span>
|
|
361
|
+
50:
|
|
362
|
+
51: <span class="ruby-keyword kw">begin</span>
|
|
363
|
+
52: <span class="ruby-identifier">args</span> = [<span class="ruby-value str">"-h"</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
|
|
364
|
+
53: <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-identifier">args</span>)
|
|
365
|
+
54:
|
|
366
|
+
55: <span class="ruby-comment cmt"># Make some default assumptions</span>
|
|
367
|
+
56: <span class="ruby-ivar">@output</span> = <span class="ruby-value str">"output"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@output</span>.<span class="ruby-identifier">nil?</span>
|
|
368
|
+
57:
|
|
369
|
+
58: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
|
370
|
+
59: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>, <span class="ruby-value str">"\n"</span>, <span class="ruby-identifier">opts</span>
|
|
371
|
+
60: <span class="ruby-identifier">exit</span>(<span class="ruby-value">1</span>)
|
|
372
|
+
61: <span class="ruby-keyword kw">end</span>
|
|
373
|
+
62:
|
|
374
|
+
63: <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># opts</span>
|
|
375
|
+
64: <span class="ruby-keyword kw">end</span></pre>
|
|
376
|
+
</div>
|
|
377
|
+
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</div>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<div id="rdoc-debugging-section-dump" class="debugging-section">
|
|
393
|
+
|
|
394
|
+
<p>Disabled; run with --debug to generate this.</p>
|
|
395
|
+
|
|
396
|
+
</div>
|
|
397
|
+
|
|
398
|
+
<div id="validator-badges">
|
|
399
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
400
|
+
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
|
401
|
+
Rdoc Generator</a> 1.1.6</small>.</p>
|
|
402
|
+
</div>
|
|
403
|
+
|
|
404
|
+
</body>
|
|
405
|
+
</html>
|
|
406
|
+
|