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.
@@ -0,0 +1,124 @@
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
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: TODO [RDoc Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="./js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="./js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="./js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="./js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file">
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="project-metadata">
36
+
37
+
38
+ <div id="fileindex-section" class="section project-section">
39
+ <h3 class="section-header">Files</h3>
40
+ <ul>
41
+
42
+ <li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
43
+
44
+ <li class="file"><a href="./TODO.html">TODO</a></li>
45
+
46
+ </ul>
47
+ </div>
48
+
49
+
50
+ <div id="classindex-section" class="section project-section">
51
+ <h3 class="section-header">Class Index
52
+ <span class="search-toggle"><img src="./images/find.png"
53
+ height="16" width="16" alt="[+]"
54
+ title="show/hide quicksearch" /></span></h3>
55
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
56
+ <fieldset>
57
+ <legend>Quicksearch</legend>
58
+ <input type="text" name="quicksearch" value=""
59
+ class="quicksearch-field" />
60
+ </fieldset>
61
+ </form>
62
+
63
+ <ul class="link-list">
64
+
65
+ <li><a href="./Retreval.html">Retreval</a></li>
66
+
67
+ <li><a href="./Retreval/Document.html">Retreval::Document</a></li>
68
+
69
+ <li><a href="./Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
70
+
71
+ <li><a href="./Retreval/Judgement.html">Retreval::Judgement</a></li>
72
+
73
+ <li><a href="./Retreval/Options.html">Retreval::Options</a></li>
74
+
75
+ <li><a href="./Retreval/Query.html">Retreval::Query</a></li>
76
+
77
+ <li><a href="./Retreval/QueryResult.html">Retreval::QueryResult</a></li>
78
+
79
+ <li><a href="./Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
80
+
81
+ <li><a href="./Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
82
+
83
+ <li><a href="./Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
84
+
85
+ <li><a href="./Retreval/Runner.html">Retreval::Runner</a></li>
86
+
87
+ <li><a href="./Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
88
+
89
+ <li><a href="./Retreval/User.html">Retreval::User</a></li>
90
+
91
+ <li><a href="./TestGoldStandard.html">TestGoldStandard</a></li>
92
+
93
+ <li><a href="./TestQueryResult.html">TestQueryResult</a></li>
94
+
95
+ </ul>
96
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
97
+ </div>
98
+
99
+
100
+ </div>
101
+ </div>
102
+
103
+ <div id="documentation">
104
+ <p>
105
+ <a href="TODO.html">TODO</a>
106
+ </p>
107
+ <h4>- Find a suitable plaintext format for retrieval results</h4>
108
+ <ul>
109
+ <li><p>
110
+ Improve performance of some commands
111
+ </p>
112
+ </li>
113
+ </ul>
114
+
115
+ </div>
116
+
117
+ <div id="validator-badges">
118
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
119
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
120
+ Rdoc Generator</a> 1.1.6</small>.</p>
121
+ </div>
122
+ </body>
123
+ </html>
124
+
@@ -0,0 +1,551 @@
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: TestGoldStandard</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="./test/test_gold_standard_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42
+ class="thickbox" title="test/test_gold_standard.rb">test/test_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">Test::Unit::TestCase</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-i-add_test_judgement">#add_test_judgement</a></li>
73
+
74
+ <li><a href="#method-i-test_document">#test_document</a></li>
75
+
76
+ <li><a href="#method-i-test_judgement">#test_judgement</a></li>
77
+
78
+ <li><a href="#method-i-test_kappa_ir_book">#test_kappa_ir_book</a></li>
79
+
80
+ <li><a href="#method-i-test_kappa_wikipedia">#test_kappa_wikipedia</a></li>
81
+
82
+ <li><a href="#method-i-test_query">#test_query</a></li>
83
+
84
+ <li><a href="#method-i-test_relevant">#test_relevant</a></li>
85
+
86
+ <li><a href="#method-i-test_user">#test_user</a></li>
87
+
88
+ </ul>
89
+ </div>
90
+
91
+
92
+ <!-- Included Modules -->
93
+
94
+ </div>
95
+
96
+ <div id="project-metadata">
97
+
98
+
99
+ <div id="fileindex-section" class="section project-section">
100
+ <h3 class="section-header">Files</h3>
101
+ <ul>
102
+
103
+ <li class="file"><a href="./CHANGELOG.html">CHANGELOG</a></li>
104
+
105
+ <li class="file"><a href="./TODO.html">TODO</a></li>
106
+
107
+ </ul>
108
+ </div>
109
+
110
+
111
+ <div id="classindex-section" class="section project-section">
112
+ <h3 class="section-header">Class Index
113
+ <span class="search-toggle"><img src="./images/find.png"
114
+ height="16" width="16" alt="[+]"
115
+ title="show/hide quicksearch" /></span></h3>
116
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
117
+ <fieldset>
118
+ <legend>Quicksearch</legend>
119
+ <input type="text" name="quicksearch" value=""
120
+ class="quicksearch-field" />
121
+ </fieldset>
122
+ </form>
123
+
124
+ <ul class="link-list">
125
+
126
+ <li><a href="./Retreval.html">Retreval</a></li>
127
+
128
+ <li><a href="./Retreval/Document.html">Retreval::Document</a></li>
129
+
130
+ <li><a href="./Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
131
+
132
+ <li><a href="./Retreval/Judgement.html">Retreval::Judgement</a></li>
133
+
134
+ <li><a href="./Retreval/Options.html">Retreval::Options</a></li>
135
+
136
+ <li><a href="./Retreval/Query.html">Retreval::Query</a></li>
137
+
138
+ <li><a href="./Retreval/QueryResult.html">Retreval::QueryResult</a></li>
139
+
140
+ <li><a href="./Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
141
+
142
+ <li><a href="./Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
143
+
144
+ <li><a href="./Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
145
+
146
+ <li><a href="./Retreval/Runner.html">Retreval::Runner</a></li>
147
+
148
+ <li><a href="./Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
149
+
150
+ <li><a href="./Retreval/User.html">Retreval::User</a></li>
151
+
152
+ <li><a href="./TestGoldStandard.html">TestGoldStandard</a></li>
153
+
154
+ <li><a href="./TestQueryResult.html">TestQueryResult</a></li>
155
+
156
+ </ul>
157
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
158
+ </div>
159
+
160
+
161
+ </div>
162
+ </div>
163
+
164
+ <div id="documentation">
165
+ <h1 class="class">TestGoldStandard</h1>
166
+
167
+ <div id="description">
168
+ <p>
169
+ Some basic unit tests for the GoldStandard
170
+ </p>
171
+
172
+ </div>
173
+
174
+ <!-- Constants -->
175
+
176
+
177
+ <!-- Attributes -->
178
+
179
+
180
+ <!-- Methods -->
181
+
182
+ <div id="public-instance-method-details" class="method-section section">
183
+ <h3 class="section-header">Public Instance Methods</h3>
184
+
185
+
186
+ <div id="add-test-judgement-method" class="method-detail ">
187
+ <a name="method-i-add_test_judgement"></a>
188
+
189
+ <div class="method-heading">
190
+
191
+ <span class="method-name">add_test_judgement</span><span
192
+ class="method-args">()</span>
193
+ <span class="method-click-advice">click to toggle source</span>
194
+
195
+ </div>
196
+
197
+ <div class="method-description">
198
+
199
+ <p>
200
+ Adds one test judgement to this test case
201
+ </p>
202
+
203
+
204
+
205
+ <div class="method-source-code"
206
+ id="add-test-judgement-source">
207
+ <pre>
208
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 9</span>
209
+ 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_test_judgement</span>
210
+ 10: <span class="ruby-ivar">@gold_standard</span> = <span class="ruby-constant">Retreval</span><span class="ruby-operator">::</span><span class="ruby-constant">GoldStandard</span>.<span class="ruby-identifier">new</span>
211
+ 11: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;doc1&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;query1&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;John Doe&quot;</span>
212
+ 12: <span class="ruby-keyword kw">end</span></pre>
213
+ </div>
214
+
215
+ </div>
216
+
217
+
218
+
219
+
220
+ </div>
221
+
222
+
223
+ <div id="test-document-method" class="method-detail ">
224
+ <a name="method-i-test_document"></a>
225
+
226
+ <div class="method-heading">
227
+
228
+ <span class="method-name">test_document</span><span
229
+ class="method-args">()</span>
230
+ <span class="method-click-advice">click to toggle source</span>
231
+
232
+ </div>
233
+
234
+ <div class="method-description">
235
+
236
+ <p>
237
+ Tests whether the Document is correctly included
238
+ </p>
239
+
240
+
241
+
242
+ <div class="method-source-code"
243
+ id="test-document-source">
244
+ <pre>
245
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 16</span>
246
+ 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_document</span>
247
+ 17: <span class="ruby-identifier">add_test_judgement</span>
248
+ 18: <span class="ruby-identifier">assert</span>(<span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">contains_document?</span> <span class="ruby-value">:id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;doc1&quot;</span>)
249
+ 19: <span class="ruby-keyword kw">end</span></pre>
250
+ </div>
251
+
252
+ </div>
253
+
254
+
255
+
256
+
257
+ </div>
258
+
259
+
260
+ <div id="test-judgement-method" class="method-detail ">
261
+ <a name="method-i-test_judgement"></a>
262
+
263
+ <div class="method-heading">
264
+
265
+ <span class="method-name">test_judgement</span><span
266
+ class="method-args">()</span>
267
+ <span class="method-click-advice">click to toggle source</span>
268
+
269
+ </div>
270
+
271
+ <div class="method-description">
272
+
273
+ <p>
274
+ Tests whether the Judgement is correctly included
275
+ </p>
276
+
277
+
278
+
279
+ <div class="method-source-code"
280
+ id="test-judgement-source">
281
+ <pre>
282
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 37</span>
283
+ 37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_judgement</span>
284
+ 38: <span class="ruby-identifier">add_test_judgement</span>
285
+ 39: <span class="ruby-identifier">assert</span>(<span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">contains_judgement?</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;doc1&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;query1&quot;</span>)
286
+ 40: <span class="ruby-keyword kw">end</span></pre>
287
+ </div>
288
+
289
+ </div>
290
+
291
+
292
+
293
+
294
+ </div>
295
+
296
+
297
+ <div id="test-kappa-ir-book-method" class="method-detail ">
298
+ <a name="method-i-test_kappa_ir_book"></a>
299
+
300
+ <div class="method-heading">
301
+
302
+ <span class="method-name">test_kappa_ir_book</span><span
303
+ class="method-args">()</span>
304
+ <span class="method-click-advice">click to toggle source</span>
305
+
306
+ </div>
307
+
308
+ <div class="method-description">
309
+
310
+ <p>
311
+ Tests if the kappa measure is calculated correctly. See <a
312
+ href="http://nlp.stanford.edu/IR-book/html/htmledition/assessing-relevance-1.html">nlp.stanford.edu/IR-book/html/htmledition/assessing-relevance-1.html</a>
313
+ for the examples in this test
314
+ </p>
315
+
316
+
317
+
318
+ <div class="method-source-code"
319
+ id="test-kappa-ir-book-source">
320
+ <pre>
321
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 52</span>
322
+ 52: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_kappa_ir_book</span>
323
+ 53:
324
+ 54: <span class="ruby-ivar">@gold_standard</span> = <span class="ruby-constant">Retreval</span><span class="ruby-operator">::</span><span class="ruby-constant">GoldStandard</span>.<span class="ruby-identifier">new</span>
325
+ 55:
326
+ 56: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">300</span>) <span class="ruby-keyword kw">do</span>
327
+ 57: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
328
+ 58: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
329
+ 59: <span class="ruby-keyword kw">end</span>
330
+ 60:
331
+ 61: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">301</span><span class="ruby-operator">..</span><span class="ruby-value">320</span>) <span class="ruby-keyword kw">do</span>
332
+ 62: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
333
+ 63: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
334
+ 64: <span class="ruby-keyword kw">end</span>
335
+ 65:
336
+ 66: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">321</span><span class="ruby-operator">..</span><span class="ruby-value">330</span>) <span class="ruby-keyword kw">do</span>
337
+ 67: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
338
+ 68: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
339
+ 69: <span class="ruby-keyword kw">end</span>
340
+ 70:
341
+ 71: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">331</span><span class="ruby-operator">..</span><span class="ruby-value">400</span>) <span class="ruby-keyword kw">do</span>
342
+ 72: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
343
+ 73: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
344
+ 74: <span class="ruby-keyword kw">end</span>
345
+ 75:
346
+ 76: <span class="ruby-identifier">assert_equal</span>(<span class="ruby-value">0.7759103641456584</span>, <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">kappa</span>, <span class="ruby-value str">&quot;IR Book kappa test failed!&quot;</span>)
347
+ 77: <span class="ruby-keyword kw">end</span></pre>
348
+ </div>
349
+
350
+ </div>
351
+
352
+
353
+
354
+
355
+ </div>
356
+
357
+
358
+ <div id="test-kappa-wikipedia-method" class="method-detail ">
359
+ <a name="method-i-test_kappa_wikipedia"></a>
360
+
361
+ <div class="method-heading">
362
+
363
+ <span class="method-name">test_kappa_wikipedia</span><span
364
+ class="method-args">()</span>
365
+ <span class="method-click-advice">click to toggle source</span>
366
+
367
+ </div>
368
+
369
+ <div class="method-description">
370
+
371
+ <p>
372
+ Tests if the kappa measure is calculated correctly. See <a
373
+ href="http://nlp.stanford.edu/IR-book/html/htmledition/assessing-relevance-1.html">nlp.stanford.edu/IR-book/html/htmledition/assessing-relevance-1.html</a>
374
+ for the examples in this test
375
+ </p>
376
+
377
+
378
+
379
+ <div class="method-source-code"
380
+ id="test-kappa-wikipedia-source">
381
+ <pre>
382
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 83</span>
383
+ 83: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_kappa_wikipedia</span>
384
+ 84:
385
+ 85: <span class="ruby-ivar">@gold_standard</span> = <span class="ruby-constant">Retreval</span><span class="ruby-operator">::</span><span class="ruby-constant">GoldStandard</span>.<span class="ruby-identifier">new</span>
386
+ 86:
387
+ 87: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">20</span>) <span class="ruby-keyword kw">do</span>
388
+ 88: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
389
+ 89: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
390
+ 90: <span class="ruby-keyword kw">end</span>
391
+ 91:
392
+ 92: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">21</span><span class="ruby-operator">..</span><span class="ruby-value">25</span>) <span class="ruby-keyword kw">do</span>
393
+ 93: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
394
+ 94: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
395
+ 95: <span class="ruby-keyword kw">end</span>
396
+ 96:
397
+ 97: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">26</span><span class="ruby-operator">..</span><span class="ruby-value">35</span>) <span class="ruby-keyword kw">do</span>
398
+ 98: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
399
+ 99: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">true</span>
400
+ 100: <span class="ruby-keyword kw">end</span>
401
+ 101:
402
+ 102: <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword kw">in</span> (<span class="ruby-value">36</span><span class="ruby-operator">..</span><span class="ruby-value">50</span>) <span class="ruby-keyword kw">do</span>
403
+ 103: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Alice&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
404
+ 104: <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">add_judgement</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;doc#{i}&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;query#{i}&quot;</span>, <span class="ruby-value">:user</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Bob&quot;</span>, <span class="ruby-value">:relevant</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword kw">false</span>
405
+ 105: <span class="ruby-keyword kw">end</span>
406
+ 106: <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{@gold_standard.kappa}&quot;</span>
407
+ 107: <span class="ruby-identifier">assert_equal</span>(<span class="ruby-value">0.3939393939393937</span>, <span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">kappa</span>, <span class="ruby-value str">&quot;Wikipedia kappa test failed!&quot;</span>)
408
+ 108:
409
+ 109: <span class="ruby-keyword kw">end</span></pre>
410
+ </div>
411
+
412
+ </div>
413
+
414
+
415
+
416
+
417
+ </div>
418
+
419
+
420
+ <div id="test-query-method" class="method-detail ">
421
+ <a name="method-i-test_query"></a>
422
+
423
+ <div class="method-heading">
424
+
425
+ <span class="method-name">test_query</span><span
426
+ class="method-args">()</span>
427
+ <span class="method-click-advice">click to toggle source</span>
428
+
429
+ </div>
430
+
431
+ <div class="method-description">
432
+
433
+ <p>
434
+ Tests whether the Query is correctly included
435
+ </p>
436
+
437
+
438
+
439
+ <div class="method-source-code"
440
+ id="test-query-source">
441
+ <pre>
442
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 23</span>
443
+ 23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_query</span>
444
+ 24: <span class="ruby-identifier">add_test_judgement</span>
445
+ 25: <span class="ruby-identifier">assert</span>(<span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">contains_query?</span> <span class="ruby-value">:querystring</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;query1&quot;</span>)
446
+ 26: <span class="ruby-keyword kw">end</span></pre>
447
+ </div>
448
+
449
+ </div>
450
+
451
+
452
+
453
+
454
+ </div>
455
+
456
+
457
+ <div id="test-relevant-method" class="method-detail ">
458
+ <a name="method-i-test_relevant"></a>
459
+
460
+ <div class="method-heading">
461
+
462
+ <span class="method-name">test_relevant</span><span
463
+ class="method-args">()</span>
464
+ <span class="method-click-advice">click to toggle source</span>
465
+
466
+ </div>
467
+
468
+ <div class="method-description">
469
+
470
+ <p>
471
+ Tests whether the Judgement (i.e. the relevancy) is correctly added
472
+ </p>
473
+
474
+
475
+
476
+ <div class="method-source-code"
477
+ id="test-relevant-source">
478
+ <pre>
479
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 44</span>
480
+ 44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_relevant</span>
481
+ 45: <span class="ruby-identifier">add_test_judgement</span>
482
+ 46: <span class="ruby-identifier">assert</span>(<span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">relevant?</span> <span class="ruby-value">:document</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;doc1&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;query1&quot;</span>)
483
+ 47: <span class="ruby-keyword kw">end</span></pre>
484
+ </div>
485
+
486
+ </div>
487
+
488
+
489
+
490
+
491
+ </div>
492
+
493
+
494
+ <div id="test-user-method" class="method-detail ">
495
+ <a name="method-i-test_user"></a>
496
+
497
+ <div class="method-heading">
498
+
499
+ <span class="method-name">test_user</span><span
500
+ class="method-args">()</span>
501
+ <span class="method-click-advice">click to toggle source</span>
502
+
503
+ </div>
504
+
505
+ <div class="method-description">
506
+
507
+ <p>
508
+ Tests whether the User is correctly included
509
+ </p>
510
+
511
+
512
+
513
+ <div class="method-source-code"
514
+ id="test-user-source">
515
+ <pre>
516
+ <span class="ruby-comment cmt"># File test/test_gold_standard.rb, line 30</span>
517
+ 30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">test_user</span>
518
+ 31: <span class="ruby-identifier">add_test_judgement</span>
519
+ 32: <span class="ruby-identifier">assert</span>(<span class="ruby-ivar">@gold_standard</span>.<span class="ruby-identifier">contains_user?</span> <span class="ruby-value">:id</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;John Doe&quot;</span>)
520
+ 33: <span class="ruby-keyword kw">end</span></pre>
521
+ </div>
522
+
523
+ </div>
524
+
525
+
526
+
527
+
528
+ </div>
529
+
530
+
531
+ </div>
532
+
533
+
534
+ </div>
535
+
536
+
537
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
538
+
539
+ <p>Disabled; run with --debug to generate this.</p>
540
+
541
+ </div>
542
+
543
+ <div id="validator-badges">
544
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
545
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
546
+ Rdoc Generator</a> 1.1.6</small>.</p>
547
+ </div>
548
+
549
+ </body>
550
+ </html>
551
+