bio-samtools 0.2.5 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
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/SAM/Library.html ADDED
@@ -0,0 +1,135 @@
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>Module: Bio::DB::SAM::Library</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>Module</strong></td>
53
+ <td class="class-name-in-header">Bio::DB::SAM::Library</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/library_rb.html">
59
+ lib/bio/db/sam/library.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ </table>
66
+ </div>
67
+ <!-- banner header -->
68
+
69
+ <div id="bodyContent">
70
+
71
+
72
+
73
+ <div id="contextContent">
74
+
75
+
76
+
77
+ </div>
78
+
79
+ <div id="method-list">
80
+ <h3 class="section-bar">Methods</h3>
81
+
82
+ <div class="name-list">
83
+ <a href="#M000006">filename</a>&nbsp;&nbsp;
84
+ </div>
85
+ </div>
86
+
87
+ </div>
88
+
89
+
90
+ <!-- if includes -->
91
+
92
+ <div id="section">
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+ <!-- if method_list -->
102
+ <div id="methods">
103
+ <h3 class="section-bar">Public Instance methods</h3>
104
+
105
+ <div id="method-M000006" class="method-detail">
106
+ <a name="M000006"></a>
107
+
108
+ <div class="method-heading">
109
+ <a href="Library.src/M000006.html" target="Code" class="method-signature"
110
+ onclick="popupCode('Library.src/M000006.html');return false;">
111
+ <span class="method-name">filename</span><span class="method-args">()</span>
112
+ </a>
113
+ </div>
114
+
115
+ <div class="method-description">
116
+ <p>
117
+ Return the path with the file name of the library for the specific
118
+ operating system
119
+ </p>
120
+ </div>
121
+ </div>
122
+
123
+
124
+ </div>
125
+
126
+
127
+ </div>
128
+
129
+
130
+ <div id="validator-badges">
131
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
132
+ </div>
133
+
134
+ </body>
135
+ </html>
data/doc/classes/Bio/DB/SAM/Library.src/M000006.html ADDED
@@ -0,0 +1,28 @@
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>filename (Bio::DB::SAM::Library)</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/library.rb, line 8</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">filename</span>
15
+ <span class="ruby-comment cmt">#TODO refactor this piece of code in all the files</span>
16
+ <span class="ruby-identifier">lib_os</span> = <span class="ruby-keyword kw">case</span> <span class="ruby-constant">RUBY_PLATFORM</span>
17
+ <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/linux/</span>
18
+ <span class="ruby-value str">'so.1'</span>
19
+ <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/darwin/</span>
20
+ <span class="ruby-value str">'1.dylib'</span>
21
+ <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/windows/</span>
22
+ <span class="ruby-value str">'dll'</span>
23
+ <span class="ruby-keyword kw">end</span>
24
+
25
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>)),<span class="ruby-value str">'external'</span>,<span class="ruby-node">&quot;libbam.#{lib_os}&quot;</span>)
26
+ <span class="ruby-keyword kw">end</span></pre>
27
+ </body>
28
+ </html>
data/doc/classes/Bio/DB/SAM/Tools.html ADDED
@@ -0,0 +1,278 @@
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>Module: Bio::DB::SAM::Tools</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>Module</strong></td>
53
+ <td class="class-name-in-header">Bio::DB::SAM::Tools</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/bam_rb.html">
59
+ lib/bio/db/sam/bam.rb
60
+ </a>
61
+ <br />
62
+ <a href="../../../../files/lib/bio/db/sam/faidx_rb.html">
63
+ lib/bio/db/sam/faidx.rb
64
+ </a>
65
+ <br />
66
+ <a href="../../../../files/lib/bio/db/sam/sam_rb.html">
67
+ lib/bio/db/sam/sam.rb
68
+ </a>
69
+ <br />
70
+ </td>
71
+ </tr>
72
+
73
+ </table>
74
+ </div>
75
+ <!-- banner header -->
76
+
77
+ <div id="bodyContent">
78
+
79
+
80
+
81
+ <div id="contextContent">
82
+
83
+
84
+
85
+ </div>
86
+
87
+ <div id="method-list">
88
+ <h3 class="section-bar">Methods</h3>
89
+
90
+ <div class="name-list">
91
+ <a href="#M000007">bam_sort</a>&nbsp;&nbsp;
92
+ </div>
93
+ </div>
94
+
95
+ </div>
96
+
97
+
98
+ <!-- if includes -->
99
+
100
+ <div id="section">
101
+
102
+ <div id="class-list">
103
+ <h3 class="section-bar">Classes and Modules</h3>
104
+
105
+ Class <a href="Tools/Bam1CoreT.html" class="link">Bio::DB::SAM::Tools::Bam1CoreT</a><br />
106
+ Class <a href="Tools/Bam1T.html" class="link">Bio::DB::SAM::Tools::Bam1T</a><br />
107
+ Class <a href="Tools/BamHeaderT.html" class="link">Bio::DB::SAM::Tools::BamHeaderT</a><br />
108
+ Class <a href="Tools/BamPileup1T.html" class="link">Bio::DB::SAM::Tools::BamPileup1T</a><br />
109
+ Class <a href="Tools/SamfileT.html" class="link">Bio::DB::SAM::Tools::SamfileT</a><br />
110
+ Class <a href="Tools/SamfileTX.html" class="link">Bio::DB::SAM::Tools::SamfileTX</a><br />
111
+
112
+ </div>
113
+
114
+ <div id="constants-list">
115
+ <h3 class="section-bar">Constants</h3>
116
+
117
+ <div class="name-list">
118
+ <table summary="Constants">
119
+ <tr class="top-aligned-row context-row">
120
+ <td class="context-item-name">BAM_FPAIRED</td>
121
+ <td>=</td>
122
+ <td class="context-item-value">1</td>
123
+ </tr>
124
+ <tr class="top-aligned-row context-row">
125
+ <td class="context-item-name">BAM_FPROPER_PAIR</td>
126
+ <td>=</td>
127
+ <td class="context-item-value">2</td>
128
+ </tr>
129
+ <tr class="top-aligned-row context-row">
130
+ <td class="context-item-name">BAM_FUNMAP</td>
131
+ <td>=</td>
132
+ <td class="context-item-value">4</td>
133
+ </tr>
134
+ <tr class="top-aligned-row context-row">
135
+ <td class="context-item-name">BAM_FMUNMAP</td>
136
+ <td>=</td>
137
+ <td class="context-item-value">8</td>
138
+ </tr>
139
+ <tr class="top-aligned-row context-row">
140
+ <td class="context-item-name">BAM_FREVERSE</td>
141
+ <td>=</td>
142
+ <td class="context-item-value">16</td>
143
+ </tr>
144
+ <tr class="top-aligned-row context-row">
145
+ <td class="context-item-name">BAM_FMREVERSE</td>
146
+ <td>=</td>
147
+ <td class="context-item-value">32</td>
148
+ </tr>
149
+ <tr class="top-aligned-row context-row">
150
+ <td class="context-item-name">BAM_FREAD1</td>
151
+ <td>=</td>
152
+ <td class="context-item-value">64</td>
153
+ </tr>
154
+ <tr class="top-aligned-row context-row">
155
+ <td class="context-item-name">BAM_FREAD2</td>
156
+ <td>=</td>
157
+ <td class="context-item-value">128</td>
158
+ </tr>
159
+ <tr class="top-aligned-row context-row">
160
+ <td class="context-item-name">BAM_FSECONDARY</td>
161
+ <td>=</td>
162
+ <td class="context-item-value">256</td>
163
+ </tr>
164
+ <tr class="top-aligned-row context-row">
165
+ <td class="context-item-name">BAM_FQCFAIL</td>
166
+ <td>=</td>
167
+ <td class="context-item-value">512</td>
168
+ </tr>
169
+ <tr class="top-aligned-row context-row">
170
+ <td class="context-item-name">BAM_FDUP</td>
171
+ <td>=</td>
172
+ <td class="context-item-value">1024</td>
173
+ </tr>
174
+ <tr class="top-aligned-row context-row">
175
+ <td class="context-item-name">BAM_OFDEC</td>
176
+ <td>=</td>
177
+ <td class="context-item-value">0</td>
178
+ </tr>
179
+ <tr class="top-aligned-row context-row">
180
+ <td class="context-item-name">BAM_OFHEX</td>
181
+ <td>=</td>
182
+ <td class="context-item-value">1</td>
183
+ </tr>
184
+ <tr class="top-aligned-row context-row">
185
+ <td class="context-item-name">BAM_OFSTR</td>
186
+ <td>=</td>
187
+ <td class="context-item-value">2</td>
188
+ </tr>
189
+ <tr class="top-aligned-row context-row">
190
+ <td class="context-item-name">BAM_DEF_MASK</td>
191
+ <td>=</td>
192
+ <td class="context-item-value">(4|256|512|1024)</td>
193
+ </tr>
194
+ <tr class="top-aligned-row context-row">
195
+ <td class="context-item-name">BAM_CIGAR_SHIFT</td>
196
+ <td>=</td>
197
+ <td class="context-item-value">4</td>
198
+ </tr>
199
+ <tr class="top-aligned-row context-row">
200
+ <td class="context-item-name">BAM_CIGAR_MASK</td>
201
+ <td>=</td>
202
+ <td class="context-item-value">((1 &lt;&lt; 4) -1)</td>
203
+ </tr>
204
+ <tr class="top-aligned-row context-row">
205
+ <td class="context-item-name">BAM_CMATCH</td>
206
+ <td>=</td>
207
+ <td class="context-item-value">0</td>
208
+ </tr>
209
+ <tr class="top-aligned-row context-row">
210
+ <td class="context-item-name">BAM_CINS</td>
211
+ <td>=</td>
212
+ <td class="context-item-value">1</td>
213
+ </tr>
214
+ <tr class="top-aligned-row context-row">
215
+ <td class="context-item-name">BAM_CDEL</td>
216
+ <td>=</td>
217
+ <td class="context-item-value">2</td>
218
+ </tr>
219
+ <tr class="top-aligned-row context-row">
220
+ <td class="context-item-name">BAM_CREF_SKIP</td>
221
+ <td>=</td>
222
+ <td class="context-item-value">3</td>
223
+ </tr>
224
+ <tr class="top-aligned-row context-row">
225
+ <td class="context-item-name">BAM_CSOFT_CLIP</td>
226
+ <td>=</td>
227
+ <td class="context-item-value">4</td>
228
+ </tr>
229
+ <tr class="top-aligned-row context-row">
230
+ <td class="context-item-name">BAM_CHARD_CLIP</td>
231
+ <td>=</td>
232
+ <td class="context-item-value">5</td>
233
+ </tr>
234
+ <tr class="top-aligned-row context-row">
235
+ <td class="context-item-name">BAM_CPAD</td>
236
+ <td>=</td>
237
+ <td class="context-item-value">6</td>
238
+ </tr>
239
+ </table>
240
+ </div>
241
+ </div>
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <!-- if method_list -->
249
+ <div id="methods">
250
+ <h3 class="section-bar">Public Class methods</h3>
251
+
252
+ <div id="method-M000007" class="method-detail">
253
+ <a name="M000007"></a>
254
+
255
+ <div class="method-heading">
256
+ <a href="Tools.src/M000007.html" target="Code" class="method-signature"
257
+ onclick="popupCode('Tools.src/M000007.html');return false;">
258
+ <span class="method-name">bam_sort</span><span class="method-args">(bam_filename, bam_output_prefix)</span>
259
+ </a>
260
+ </div>
261
+
262
+ <div class="method-description">
263
+ </div>
264
+ </div>
265
+
266
+
267
+ </div>
268
+
269
+
270
+ </div>
271
+
272
+
273
+ <div id="validator-badges">
274
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
275
+ </div>
276
+
277
+ </body>
278
+ </html>
data/doc/classes/Bio/DB/SAM/Tools.src/M000007.html ADDED
@@ -0,0 +1,20 @@
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>bam_sort (Bio::DB::SAM::Tools)</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/bam.rb, line 172</span>
14
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">bam_sort</span>(<span class="ruby-identifier">bam_filename</span>, <span class="ruby-identifier">bam_output_prefix</span>)
15
+ <span class="ruby-identifier">is_by_name</span> = <span class="ruby-value">0</span>
16
+ <span class="ruby-identifier">max_mem</span> = <span class="ruby-value">500000000</span>
17
+ <span class="ruby-identifier">bam_sort_core</span>(<span class="ruby-identifier">is_by_name</span>, <span class="ruby-identifier">bam_filename</span>, <span class="ruby-identifier">bam_output_prefix</span>, <span class="ruby-identifier">max_mem</span>)
18
+ <span class="ruby-keyword kw">end</span></pre>
19
+ </body>
20
+ </html>