bio-samtools 0.2.5 → 0.3.0

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.
Files changed (73) hide show
  1. data/README.rdoc +7 -20
  2. data/Rakefile +11 -0
  3. data/VERSION +1 -1
  4. data/bio-samtools.gemspec +67 -1
  5. data/doc/basic_styles.css +31 -0
  6. data/doc/classes/Bio.html +139 -0
  7. data/doc/classes/Bio/DB.html +137 -0
  8. data/doc/classes/Bio/DB/Alignment.html +441 -0
  9. data/doc/classes/Bio/DB/Alignment.src/M000012.html +19 -0
  10. data/doc/classes/Bio/DB/Alignment.src/M000013.html +27 -0
  11. data/doc/classes/Bio/DB/Alignment.src/M000014.html +45 -0
  12. data/doc/classes/Bio/DB/Alignment.src/M000015.html +40 -0
  13. data/doc/classes/Bio/DB/SAM.html +510 -0
  14. data/doc/classes/Bio/DB/SAM/Library.html +135 -0
  15. data/doc/classes/Bio/DB/SAM/Library.src/M000006.html +28 -0
  16. data/doc/classes/Bio/DB/SAM/Tools.html +278 -0
  17. data/doc/classes/Bio/DB/SAM/Tools.src/M000007.html +20 -0
  18. data/doc/classes/Bio/DB/SAM/Tools/Bam1CoreT.html +111 -0
  19. data/doc/classes/Bio/DB/SAM/Tools/Bam1T.html +150 -0
  20. data/doc/classes/Bio/DB/SAM/Tools/Bam1T.src/M000010.html +20 -0
  21. data/doc/classes/Bio/DB/SAM/Tools/BamHeaderT.html +169 -0
  22. data/doc/classes/Bio/DB/SAM/Tools/BamHeaderT.src/M000008.html +19 -0
  23. data/doc/classes/Bio/DB/SAM/Tools/BamHeaderT.src/M000009.html +18 -0
  24. data/doc/classes/Bio/DB/SAM/Tools/BamPileup1T.html +111 -0
  25. data/doc/classes/Bio/DB/SAM/Tools/SamfileT.html +129 -0
  26. data/doc/classes/Bio/DB/SAM/Tools/SamfileTX.html +111 -0
  27. data/doc/classes/Bio/DB/SAMException.html +140 -0
  28. data/doc/classes/Bio/DB/SAMException.src/M000016.html +18 -0
  29. data/doc/classes/Bio/DB/Sam.src/M000017.html +43 -0
  30. data/doc/classes/Bio/DB/Sam.src/M000018.html +42 -0
  31. data/doc/classes/Bio/DB/Sam.src/M000019.html +18 -0
  32. data/doc/classes/Bio/DB/Sam.src/M000020.html +22 -0
  33. data/doc/classes/Bio/DB/Sam.src/M000021.html +19 -0
  34. data/doc/classes/Bio/DB/Sam.src/M000022.html +25 -0
  35. data/doc/classes/Bio/DB/Sam.src/M000023.html +28 -0
  36. data/doc/classes/Bio/DB/Sam.src/M000024.html +28 -0
  37. data/doc/classes/Bio/DB/Sam.src/M000025.html +46 -0
  38. data/doc/classes/Bio/DB/Sam.src/M000026.html +24 -0
  39. data/doc/classes/Bio/DB/Sam.src/M000027.html +19 -0
  40. data/doc/classes/Bio/DB/Sam.src/M000028.html +24 -0
  41. data/doc/classes/Bio/DB/Sam.src/M000029.html +41 -0
  42. data/doc/classes/Bio/DB/Sam.src/M000030.html +31 -0
  43. data/doc/classes/Bio/DB/Sam.src/M000031.html +86 -0
  44. data/doc/classes/Bio/DB/Sam.src/M000032.html +34 -0
  45. data/doc/classes/Bio/DB/Tag.html +160 -0
  46. data/doc/classes/Bio/DB/Tag.src/M000011.html +21 -0
  47. data/doc/classes/LibC.html +105 -0
  48. data/doc/classes/Pileup.html +374 -0
  49. data/doc/classes/Pileup.src/M000001.html +34 -0
  50. data/doc/classes/Pileup.src/M000002.html +21 -0
  51. data/doc/classes/Pileup.src/M000003.html +21 -0
  52. data/doc/classes/Pileup.src/M000004.html +21 -0
  53. data/doc/classes/Pileup.src/M000005.html +31 -0
  54. data/doc/created.rid +1 -0
  55. data/doc/files/lib/bio-samtools_rb.html +109 -0
  56. data/doc/files/lib/bio/db/sam/bam_rb.html +108 -0
  57. data/doc/files/lib/bio/db/sam/faidx_rb.html +108 -0
  58. data/doc/files/lib/bio/db/sam/library_rb.html +101 -0
  59. data/doc/files/lib/bio/db/sam/pileup_rb.html +178 -0
  60. data/doc/files/lib/bio/db/sam/sam_rb.html +113 -0
  61. data/doc/files/lib/bio/db/sam_rb.html +111 -0
  62. data/doc/fr_class_index.html +43 -0
  63. data/doc/fr_file_index.html +33 -0
  64. data/doc/fr_method_index.html +58 -0
  65. data/doc/index.html +24 -0
  66. data/doc/rdoc-style.css +208 -0
  67. data/doc/tutorial.html +165 -0
  68. data/doc/tutorial.pdf +0 -0
  69. data/lib/bio/db/sam.rb +163 -1
  70. data/lib/bio/db/sam/pileup.rb +98 -0
  71. data/test/basictest.rb +14 -0
  72. data/test/pileup.rb +68 -0
  73. metadata +84 -18
data/doc/classes/Bio/DB/Alignment.html ADDED
@@ -0,0 +1,441 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: Bio::DB::Alignment</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">Bio::DB::Alignment</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../files/lib/bio/db/sam_rb.html">
59
+ lib/bio/db/sam.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+
82
+
83
+ </div>
84
+
85
+ <div id="method-list">
86
+ <h3 class="section-bar">Methods</h3>
87
+
88
+ <div class="name-list">
89
+ <a href="#M000013">finalize</a>&nbsp;&nbsp;
90
+ <a href="#M000012">new</a>&nbsp;&nbsp;
91
+ <a href="#M000015">sam=</a>&nbsp;&nbsp;
92
+ <a href="#M000014">set</a>&nbsp;&nbsp;
93
+ </div>
94
+ </div>
95
+
96
+ </div>
97
+
98
+
99
+ <!-- if includes -->
100
+
101
+ <div id="section">
102
+
103
+
104
+
105
+
106
+
107
+ <div id="attribute-list">
108
+ <h3 class="section-bar">Attributes</h3>
109
+
110
+ <div class="name-list">
111
+ <table>
112
+ <tr class="top-aligned-row context-row">
113
+ <td class="context-item-name">al</td>
114
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
115
+ <td class="context-item-desc">
116
+ Attributes from the format
117
+
118
+ </td>
119
+ </tr>
120
+ <tr class="top-aligned-row context-row">
121
+ <td class="context-item-name">calend</td>
122
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
123
+ <td class="context-item-desc">
124
+ Attributes pulled with the C library
125
+
126
+ </td>
127
+ </tr>
128
+ <tr class="top-aligned-row context-row">
129
+ <td class="context-item-name">cigar</td>
130
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
131
+ <td class="context-item-desc">
132
+ Attributes from the format
133
+
134
+ </td>
135
+ </tr>
136
+ <tr class="top-aligned-row context-row">
137
+ <td class="context-item-name">failed_quality</td>
138
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
139
+ <td class="context-item-desc">
140
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
141
+ documentation) query_strand and mate_strand are true if they are forward.
142
+ It is the opposite to the definition in the BAM format for clarity. primary
143
+ is the negation of is_negative from the BAM format
144
+
145
+ </td>
146
+ </tr>
147
+ <tr class="top-aligned-row context-row">
148
+ <td class="context-item-name">first_in_pair</td>
149
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
150
+ <td class="context-item-desc">
151
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
152
+ documentation) query_strand and mate_strand are true if they are forward.
153
+ It is the opposite to the definition in the BAM format for clarity. primary
154
+ is the negation of is_negative from the BAM format
155
+
156
+ </td>
157
+ </tr>
158
+ <tr class="top-aligned-row context-row">
159
+ <td class="context-item-name">flag</td>
160
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
161
+ <td class="context-item-desc">
162
+ Attributes from the format
163
+
164
+ </td>
165
+ </tr>
166
+ <tr class="top-aligned-row context-row">
167
+ <td class="context-item-name">is_duplicate</td>
168
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
169
+ <td class="context-item-desc">
170
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
171
+ documentation) query_strand and mate_strand are true if they are forward.
172
+ It is the opposite to the definition in the BAM format for clarity. primary
173
+ is the negation of is_negative from the BAM format
174
+
175
+ </td>
176
+ </tr>
177
+ <tr class="top-aligned-row context-row">
178
+ <td class="context-item-name">is_mapped</td>
179
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
180
+ <td class="context-item-desc">
181
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
182
+ documentation) query_strand and mate_strand are true if they are forward.
183
+ It is the opposite to the definition in the BAM format for clarity. primary
184
+ is the negation of is_negative from the BAM format
185
+
186
+ </td>
187
+ </tr>
188
+ <tr class="top-aligned-row context-row">
189
+ <td class="context-item-name">is_paired</td>
190
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
191
+ <td class="context-item-desc">
192
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
193
+ documentation) query_strand and mate_strand are true if they are forward.
194
+ It is the opposite to the definition in the BAM format for clarity. primary
195
+ is the negation of is_negative from the BAM format
196
+
197
+ </td>
198
+ </tr>
199
+ <tr class="top-aligned-row context-row">
200
+ <td class="context-item-name">isize</td>
201
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
202
+ <td class="context-item-desc">
203
+ Attributes from the format
204
+
205
+ </td>
206
+ </tr>
207
+ <tr class="top-aligned-row context-row">
208
+ <td class="context-item-name">mapq</td>
209
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
210
+ <td class="context-item-desc">
211
+ Attributes from the format
212
+
213
+ </td>
214
+ </tr>
215
+ <tr class="top-aligned-row context-row">
216
+ <td class="context-item-name">mate_strand</td>
217
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
218
+ <td class="context-item-desc">
219
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
220
+ documentation) query_strand and mate_strand are true if they are forward.
221
+ It is the opposite to the definition in the BAM format for clarity. primary
222
+ is the negation of is_negative from the BAM format
223
+
224
+ </td>
225
+ </tr>
226
+ <tr class="top-aligned-row context-row">
227
+ <td class="context-item-name">mate_unmapped</td>
228
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
229
+ <td class="context-item-desc">
230
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
231
+ documentation) query_strand and mate_strand are true if they are forward.
232
+ It is the opposite to the definition in the BAM format for clarity. primary
233
+ is the negation of is_negative from the BAM format
234
+
235
+ </td>
236
+ </tr>
237
+ <tr class="top-aligned-row context-row">
238
+ <td class="context-item-name">mpos</td>
239
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
240
+ <td class="context-item-desc">
241
+ Attributes from the format
242
+
243
+ </td>
244
+ </tr>
245
+ <tr class="top-aligned-row context-row">
246
+ <td class="context-item-name">mrnm</td>
247
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
248
+ <td class="context-item-desc">
249
+ Attributes from the format
250
+
251
+ </td>
252
+ </tr>
253
+ <tr class="top-aligned-row context-row">
254
+ <td class="context-item-name">pos</td>
255
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
256
+ <td class="context-item-desc">
257
+ Attributes from the format
258
+
259
+ </td>
260
+ </tr>
261
+ <tr class="top-aligned-row context-row">
262
+ <td class="context-item-name">primary</td>
263
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
264
+ <td class="context-item-desc">
265
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
266
+ documentation) query_strand and mate_strand are true if they are forward.
267
+ It is the opposite to the definition in the BAM format for clarity. primary
268
+ is the negation of is_negative from the BAM format
269
+
270
+ </td>
271
+ </tr>
272
+ <tr class="top-aligned-row context-row">
273
+ <td class="context-item-name">qlen</td>
274
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
275
+ <td class="context-item-desc">
276
+ Attributes pulled with the C library
277
+
278
+ </td>
279
+ </tr>
280
+ <tr class="top-aligned-row context-row">
281
+ <td class="context-item-name">qname</td>
282
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
283
+ <td class="context-item-desc">
284
+ Attributes from the format
285
+
286
+ </td>
287
+ </tr>
288
+ <tr class="top-aligned-row context-row">
289
+ <td class="context-item-name">qual</td>
290
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
291
+ <td class="context-item-desc">
292
+ Attributes from the format
293
+
294
+ </td>
295
+ </tr>
296
+ <tr class="top-aligned-row context-row">
297
+ <td class="context-item-name">query_strand</td>
298
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
299
+ <td class="context-item-desc">
300
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
301
+ documentation) query_strand and mate_strand are true if they are forward.
302
+ It is the opposite to the definition in the BAM format for clarity. primary
303
+ is the negation of is_negative from the BAM format
304
+
305
+ </td>
306
+ </tr>
307
+ <tr class="top-aligned-row context-row">
308
+ <td class="context-item-name">query_unmapped</td>
309
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
310
+ <td class="context-item-desc">
311
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
312
+ documentation) query_strand and mate_strand are true if they are forward.
313
+ It is the opposite to the definition in the BAM format for clarity. primary
314
+ is the negation of is_negative from the BAM format
315
+
316
+ </td>
317
+ </tr>
318
+ <tr class="top-aligned-row context-row">
319
+ <td class="context-item-name">rname</td>
320
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
321
+ <td class="context-item-desc">
322
+ Attributes from the format
323
+
324
+ </td>
325
+ </tr>
326
+ <tr class="top-aligned-row context-row">
327
+ <td class="context-item-name">samstr</td>
328
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
329
+ <td class="context-item-desc">
330
+ Attributes from the format
331
+
332
+ </td>
333
+ </tr>
334
+ <tr class="top-aligned-row context-row">
335
+ <td class="context-item-name">second_in_pair</td>
336
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
337
+ <td class="context-item-desc">
338
+ Attrobites frp, the flag field (see chapter 2.2.2 of the sam file
339
+ documentation) query_strand and mate_strand are true if they are forward.
340
+ It is the opposite to the definition in the BAM format for clarity. primary
341
+ is the negation of is_negative from the BAM format
342
+
343
+ </td>
344
+ </tr>
345
+ <tr class="top-aligned-row context-row">
346
+ <td class="context-item-name">seq</td>
347
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
348
+ <td class="context-item-desc">
349
+ Attributes from the format
350
+
351
+ </td>
352
+ </tr>
353
+ <tr class="top-aligned-row context-row">
354
+ <td class="context-item-name">tags</td>
355
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
356
+ <td class="context-item-desc">
357
+ Attributes from the format
358
+
359
+ </td>
360
+ </tr>
361
+ </table>
362
+ </div>
363
+ </div>
364
+
365
+
366
+
367
+ <!-- if method_list -->
368
+ <div id="methods">
369
+ <h3 class="section-bar">Public Class methods</h3>
370
+
371
+ <div id="method-M000013" class="method-detail">
372
+ <a name="M000013"></a>
373
+
374
+ <div class="method-heading">
375
+ <a href="Alignment.src/M000013.html" target="Code" class="method-signature"
376
+ onclick="popupCode('Alignment.src/M000013.html');return false;">
377
+ <span class="method-name">finalize</span><span class="method-args">(object_id)</span>
378
+ </a>
379
+ </div>
380
+
381
+ <div class="method-description">
382
+ </div>
383
+ </div>
384
+
385
+ <div id="method-M000012" class="method-detail">
386
+ <a name="M000012"></a>
387
+
388
+ <div class="method-heading">
389
+ <a href="Alignment.src/M000012.html" target="Code" class="method-signature"
390
+ onclick="popupCode('Alignment.src/M000012.html');return false;">
391
+ <span class="method-name">new</span><span class="method-args">()</span>
392
+ </a>
393
+ </div>
394
+
395
+ <div class="method-description">
396
+ </div>
397
+ </div>
398
+
399
+ <h3 class="section-bar">Public Instance methods</h3>
400
+
401
+ <div id="method-M000015" class="method-detail">
402
+ <a name="M000015"></a>
403
+
404
+ <div class="method-heading">
405
+ <a href="Alignment.src/M000015.html" target="Code" class="method-signature"
406
+ onclick="popupCode('Alignment.src/M000015.html');return false;">
407
+ <span class="method-name">sam=</span><span class="method-args">(sam)</span>
408
+ </a>
409
+ </div>
410
+
411
+ <div class="method-description">
412
+ </div>
413
+ </div>
414
+
415
+ <div id="method-M000014" class="method-detail">
416
+ <a name="M000014"></a>
417
+
418
+ <div class="method-heading">
419
+ <a href="Alignment.src/M000014.html" target="Code" class="method-signature"
420
+ onclick="popupCode('Alignment.src/M000014.html');return false;">
421
+ <span class="method-name">set</span><span class="method-args">(bam_alignment, header)</span>
422
+ </a>
423
+ </div>
424
+
425
+ <div class="method-description">
426
+ </div>
427
+ </div>
428
+
429
+
430
+ </div>
431
+
432
+
433
+ </div>
434
+
435
+
436
+ <div id="validator-badges">
437
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
438
+ </div>
439
+
440
+ </body>
441
+ </html>
data/doc/classes/Bio/DB/Alignment.src/M000012.html ADDED
@@ -0,0 +1,19 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html>
7
+ <head>
8
+ <title>new (Bio::DB::Alignment)</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
11
+ </head>
12
+ <body class="standalone-code">
13
+ <pre><span class="ruby-comment cmt"># File lib/bio/db/sam.rb, line 391</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
15
+ <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-keyword kw">self</span>,
16
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">method</span>(<span class="ruby-identifier">:finalize</span>).<span class="ruby-identifier">to_proc</span>)
17
+ <span class="ruby-keyword kw">end</span></pre>
18
+ </body>
19
+ </html>