Debian Codegraph @

doc/artificialFastqGenerator/Genomes.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (version 1.7.0_51) on Wed Oct 01 16:41:56 BST 2014 -->
6 <title>Genomes</title>
7 <meta name="date" content="2014-10-01">
8 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9 </head>
10 <body>
11 <script type="text/javascript"><!--
12 if (location.href.indexOf('is-external=true') == -1) {
13 parent.document.title="Genomes";
14 }
15 //-->
16 </script>
17 <noscript>
18 <div>JavaScript is disabled on your browser.</div>
19 </noscript>
20 <!-- ========= START OF TOP NAVBAR ======= -->
21 <div class="topNav"><a name="navbar_top">
22 <!-- -->
23 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 <!-- -->
25 </a>
26 <ul class="navList" title="Navigation">
27 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
28 <li class="navBarCell1Rev">Class</li>
29 <li><a href="class-use/Genomes.html">Use</a></li>
30 <li><a href="package-tree.html">Tree</a></li>
31 <li><a href="../deprecated-list.html">Deprecated</a></li>
32 <li><a href="../index-files/index-1.html">Index</a></li>
33 <li><a href="../help-doc.html">Help</a></li>
34 </ul>
35 </div>
36 <div class="subNav">
37 <ul class="navList">
38 <li><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
39 <li><a href="../artificialFastqGenerator/Main.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
40 </ul>
41 <ul class="navList">
42 <li><a href="../index.html?artificialFastqGenerator/Genomes.html" target="_top">Frames</a></li>
43 <li><a href="Genomes.html" target="_top">No Frames</a></li>
44 </ul>
45 <ul class="navList" id="allclasses_navbar_top">
46 <li><a href="../allclasses-noframe.html">All Classes</a></li>
47 </ul>
48 <div>
49 <script type="text/javascript"><!--
50 allClassesLink = document.getElementById("allclasses_navbar_top");
51 if(window==top) {
52 allClassesLink.style.display = "block";
53 }
54 else {
55 allClassesLink.style.display = "none";
56 }
57 //-->
58 </script>
59 </div>
60 <div>
61 <ul class="subNavList">
62 <li>Summary:&nbsp;</li>
63 <li>Nested&nbsp;|&nbsp;</li>
64 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
65 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
66 <li><a href="#method_summary">Method</a></li>
67 </ul>
68 <ul class="subNavList">
69 <li>Detail:&nbsp;</li>
70 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
71 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
72 <li><a href="#method_detail">Method</a></li>
73 </ul>
74 </div>
75 <a name="skip-navbar_top">
76 <!-- -->
77 </a></div>
78 <!-- ========= END OF TOP NAVBAR ========= -->
79 <!-- ======== START OF CLASS DATA ======== -->
80 <div class="header">
81 <div class="subTitle">artificialFastqGenerator</div>
82 <h2 title="Class Genomes" class="title">Class Genomes</h2>
83 </div>
84 <div class="contentContainer">
85 <ul class="inheritance">
86 <li>java.lang.Object</li>
87 <li>
88 <ul class="inheritance">
89 <li>artificialFastqGenerator.Genomes</li>
90 </ul>
91 </li>
92 </ul>
93 <div class="description">
94 <ul class="blockList">
95 <li class="blockList">
96 <hr>
97 <br>
98 <pre>public class <span class="strong">Genomes</span>
99 extends java.lang.Object</pre>
100 <div class="block">The Genomes class provides facilities for (1) creating a toy genome, (2) getting the start and end strings for a
101 chromosome in the human reference genome, (3) analysing and producing summary statistics for the human reference genome.
102
103 Copyright (C) 2012 The Institute of Cancer Research (ICR).
104
105 This file is part of ArtificialFastqGenerator v1.0.0.
106
107 ArtificialFastqGenerator is free software: you can redistribute it and/or modify it under the terms of the GNU General
108 Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
109 later version.
110
111 This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty
112 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
113
114 You should have received a copy of the GNU Public License along with this program. If not, see
115 <http://www.gnu.org/licenses/>
116
117 Authour's contact email: [email protected]</div>
118 </li>
119 </ul>
120 </div>
121 <div class="summary">
122 <ul class="blockList">
123 <li class="blockList">
124 <!-- =========== FIELD SUMMARY =========== -->
125 <ul class="blockList">
126 <li class="blockList"><a name="field_summary">
127 <!-- -->
128 </a>
129 <h3>Field Summary</h3>
130 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
131 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
132 <tr>
133 <th class="colFirst" scope="col">Modifier and Type</th>
134 <th class="colLast" scope="col">Field and Description</th>
135 </tr>
136 <tr class="altColor">
137 <td class="colFirst"><code>static java.lang.String</code></td>
138 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome10Str">HRGChromosome10Str</a></strong></code>&nbsp;</td>
139 </tr>
140 <tr class="rowColor">
141 <td class="colFirst"><code>static java.lang.String</code></td>
142 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome11Str">HRGChromosome11Str</a></strong></code>&nbsp;</td>
143 </tr>
144 <tr class="altColor">
145 <td class="colFirst"><code>static java.lang.String</code></td>
146 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome12Str">HRGChromosome12Str</a></strong></code>&nbsp;</td>
147 </tr>
148 <tr class="rowColor">
149 <td class="colFirst"><code>static java.lang.String</code></td>
150 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome13Str">HRGChromosome13Str</a></strong></code>&nbsp;</td>
151 </tr>
152 <tr class="altColor">
153 <td class="colFirst"><code>static java.lang.String</code></td>
154 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome14Str">HRGChromosome14Str</a></strong></code>&nbsp;</td>
155 </tr>
156 <tr class="rowColor">
157 <td class="colFirst"><code>static java.lang.String</code></td>
158 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome15Str">HRGChromosome15Str</a></strong></code>&nbsp;</td>
159 </tr>
160 <tr class="altColor">
161 <td class="colFirst"><code>static java.lang.String</code></td>
162 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome16Str">HRGChromosome16Str</a></strong></code>&nbsp;</td>
163 </tr>
164 <tr class="rowColor">
165 <td class="colFirst"><code>static java.lang.String</code></td>
166 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome17Str">HRGChromosome17Str</a></strong></code>&nbsp;</td>
167 </tr>
168 <tr class="altColor">
169 <td class="colFirst"><code>static java.lang.String</code></td>
170 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome18Str">HRGChromosome18Str</a></strong></code>&nbsp;</td>
171 </tr>
172 <tr class="rowColor">
173 <td class="colFirst"><code>static java.lang.String</code></td>
174 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome19Str">HRGChromosome19Str</a></strong></code>&nbsp;</td>
175 </tr>
176 <tr class="altColor">
177 <td class="colFirst"><code>static java.lang.String</code></td>
178 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome1Str">HRGChromosome1Str</a></strong></code>&nbsp;</td>
179 </tr>
180 <tr class="rowColor">
181 <td class="colFirst"><code>static java.lang.String</code></td>
182 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome20Str">HRGChromosome20Str</a></strong></code>&nbsp;</td>
183 </tr>
184 <tr class="altColor">
185 <td class="colFirst"><code>static java.lang.String</code></td>
186 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome21Str">HRGChromosome21Str</a></strong></code>&nbsp;</td>
187 </tr>
188 <tr class="rowColor">
189 <td class="colFirst"><code>static java.lang.String</code></td>
190 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome22Str">HRGChromosome22Str</a></strong></code>&nbsp;</td>
191 </tr>
192 <tr class="altColor">
193 <td class="colFirst"><code>static java.lang.String</code></td>
194 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome2Str">HRGChromosome2Str</a></strong></code>&nbsp;</td>
195 </tr>
196 <tr class="rowColor">
197 <td class="colFirst"><code>static java.lang.String</code></td>
198 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome3Str">HRGChromosome3Str</a></strong></code>&nbsp;</td>
199 </tr>
200 <tr class="altColor">
201 <td class="colFirst"><code>static java.lang.String</code></td>
202 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome4Str">HRGChromosome4Str</a></strong></code>&nbsp;</td>
203 </tr>
204 <tr class="rowColor">
205 <td class="colFirst"><code>static java.lang.String</code></td>
206 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome5Str">HRGChromosome5Str</a></strong></code>&nbsp;</td>
207 </tr>
208 <tr class="altColor">
209 <td class="colFirst"><code>static java.lang.String</code></td>
210 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome6Str">HRGChromosome6Str</a></strong></code>&nbsp;</td>
211 </tr>
212 <tr class="rowColor">
213 <td class="colFirst"><code>static java.lang.String</code></td>
214 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome7Str">HRGChromosome7Str</a></strong></code>&nbsp;</td>
215 </tr>
216 <tr class="altColor">
217 <td class="colFirst"><code>static java.lang.String</code></td>
218 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome8Str">HRGChromosome8Str</a></strong></code>&nbsp;</td>
219 </tr>
220 <tr class="rowColor">
221 <td class="colFirst"><code>static java.lang.String</code></td>
222 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosome9Str">HRGChromosome9Str</a></strong></code>&nbsp;</td>
223 </tr>
224 <tr class="altColor">
225 <td class="colFirst"><code>static java.lang.String</code></td>
226 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosomeXStr">HRGChromosomeXStr</a></strong></code>&nbsp;</td>
227 </tr>
228 <tr class="rowColor">
229 <td class="colFirst"><code>static java.lang.String</code></td>
230 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#HRGChromosomeYStr">HRGChromosomeYStr</a></strong></code>&nbsp;</td>
231 </tr>
232 <tr class="altColor">
233 <td class="colFirst"><code>static java.util.logging.Logger</code></td>
234 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#logger">logger</a></strong></code>&nbsp;</td>
235 </tr>
236 </table>
237 </li>
238 </ul>
239 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
240 <ul class="blockList">
241 <li class="blockList"><a name="constructor_summary">
242 <!-- -->
243 </a>
244 <h3>Constructor Summary</h3>
245 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
246 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
247 <tr>
248 <th class="colOne" scope="col">Constructor and Description</th>
249 </tr>
250 <tr class="altColor">
251 <td class="colOne"><code><strong><a href="../artificialFastqGenerator/Genomes.html#Genomes()">Genomes</a></strong>()</code>&nbsp;</td>
252 </tr>
253 </table>
254 </li>
255 </ul>
256 <!-- ========== METHOD SUMMARY =========== -->
257 <ul class="blockList">
258 <li class="blockList"><a name="method_summary">
259 <!-- -->
260 </a>
261 <h3>Method Summary</h3>
262 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
263 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
264 <tr>
265 <th class="colFirst" scope="col">Modifier and Type</th>
266 <th class="colLast" scope="col">Method and Description</th>
267 </tr>
268 <tr class="altColor">
269 <td class="colFirst"><code>static void</code></td>
270 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#analyzeHumanReferenceGenome(java.lang.String, java.lang.String, int)">analyzeHumanReferenceGenome</a></strong>(java.lang.String&nbsp;humanReferenceGenomePath,
271 java.lang.String&nbsp;outputPath,
272 int&nbsp;lineDivisor)</code>
273 <div class="block">Conduct an analysis of the human reference genome.</div>
274 </td>
275 </tr>
276 <tr class="rowColor">
277 <td class="colFirst"><code>static java.lang.String[]</code></td>
278 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#createChromosomeArray()">createChromosomeArray</a></strong>()</code>
279 <div class="block">Create an array of chromosome header strings.</div>
280 </td>
281 </tr>
282 <tr class="altColor">
283 <td class="colFirst"><code>static void</code></td>
284 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#generateToyGenome(java.lang.String, int, boolean, int)">generateToyGenome</a></strong>(java.lang.String&nbsp;outFilePath,
285 int&nbsp;length,
286 boolean&nbsp;printChromosomeLines,
287 int&nbsp;chromosomeLineIntervals)</code>
288 <div class="block">Generate a toy genome.</div>
289 </td>
290 </tr>
291 <tr class="rowColor">
292 <td class="colFirst"><code>static java.lang.String[]</code></td>
293 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#getChromosomeStartEndStrs(java.lang.String)">getChromosomeStartEndStrs</a></strong>(java.lang.String&nbsp;chromosomes)</code>
294 <div class="block">Get the human reference genome sequence start and end strings for a set of chromsomes.</div>
295 </td>
296 </tr>
297 <tr class="altColor">
298 <td class="colFirst"><code>static boolean</code></td>
299 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#isNonBase(java.lang.String, java.lang.String)">isNonBase</a></strong>(java.lang.String&nbsp;currentCharStr,
300 java.lang.String&nbsp;previousCharStr)</code>
301 <div class="block">Check whether a human reference sequence file character is a base.</div>
302 </td>
303 </tr>
304 <tr class="rowColor">
305 <td class="colFirst"><code>static java.lang.String</code></td>
306 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/Genomes.html#makeCountProportionsString(double, double, double, double, double, double)">makeCountProportionsString</a></strong>(double&nbsp;ACount,
307 double&nbsp;TCount,
308 double&nbsp;CCount,
309 double&nbsp;GCount,
310 double&nbsp;NCount,
311 double&nbsp;divisor)</code>
312 <div class="block">Make a String containing summary statistics for a region of nucleobases in the human reference sequence file.</div>
313 </td>
314 </tr>
315 </table>
316 <ul class="blockList">
317 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
318 <!-- -->
319 </a>
320 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
321 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
322 </ul>
323 </li>
324 </ul>
325 </li>
326 </ul>
327 </div>
328 <div class="details">
329 <ul class="blockList">
330 <li class="blockList">
331 <!-- ============ FIELD DETAIL =========== -->
332 <ul class="blockList">
333 <li class="blockList"><a name="field_detail">
334 <!-- -->
335 </a>
336 <h3>Field Detail</h3>
337 <a name="HRGChromosome1Str">
338 <!-- -->
339 </a>
340 <ul class="blockList">
341 <li class="blockList">
342 <h4>HRGChromosome1Str</h4>
343 <pre>public static final&nbsp;java.lang.String HRGChromosome1Str</pre>
344 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome1Str">Constant Field Values</a></dd></dl>
345 </li>
346 </ul>
347 <a name="HRGChromosome2Str">
348 <!-- -->
349 </a>
350 <ul class="blockList">
351 <li class="blockList">
352 <h4>HRGChromosome2Str</h4>
353 <pre>public static final&nbsp;java.lang.String HRGChromosome2Str</pre>
354 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome2Str">Constant Field Values</a></dd></dl>
355 </li>
356 </ul>
357 <a name="HRGChromosome3Str">
358 <!-- -->
359 </a>
360 <ul class="blockList">
361 <li class="blockList">
362 <h4>HRGChromosome3Str</h4>
363 <pre>public static final&nbsp;java.lang.String HRGChromosome3Str</pre>
364 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome3Str">Constant Field Values</a></dd></dl>
365 </li>
366 </ul>
367 <a name="HRGChromosome4Str">
368 <!-- -->
369 </a>
370 <ul class="blockList">
371 <li class="blockList">
372 <h4>HRGChromosome4Str</h4>
373 <pre>public static final&nbsp;java.lang.String HRGChromosome4Str</pre>
374 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome4Str">Constant Field Values</a></dd></dl>
375 </li>
376 </ul>
377 <a name="HRGChromosome5Str">
378 <!-- -->
379 </a>
380 <ul class="blockList">
381 <li class="blockList">
382 <h4>HRGChromosome5Str</h4>
383 <pre>public static final&nbsp;java.lang.String HRGChromosome5Str</pre>
384 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome5Str">Constant Field Values</a></dd></dl>
385 </li>
386 </ul>
387 <a name="HRGChromosome6Str">
388 <!-- -->
389 </a>
390 <ul class="blockList">
391 <li class="blockList">
392 <h4>HRGChromosome6Str</h4>
393 <pre>public static final&nbsp;java.lang.String HRGChromosome6Str</pre>
394 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome6Str">Constant Field Values</a></dd></dl>
395 </li>
396 </ul>
397 <a name="HRGChromosome7Str">
398 <!-- -->
399 </a>
400 <ul class="blockList">
401 <li class="blockList">
402 <h4>HRGChromosome7Str</h4>
403 <pre>public static final&nbsp;java.lang.String HRGChromosome7Str</pre>
404 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome7Str">Constant Field Values</a></dd></dl>
405 </li>
406 </ul>
407 <a name="HRGChromosome8Str">
408 <!-- -->
409 </a>
410 <ul class="blockList">
411 <li class="blockList">
412 <h4>HRGChromosome8Str</h4>
413 <pre>public static final&nbsp;java.lang.String HRGChromosome8Str</pre>
414 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome8Str">Constant Field Values</a></dd></dl>
415 </li>
416 </ul>
417 <a name="HRGChromosome9Str">
418 <!-- -->
419 </a>
420 <ul class="blockList">
421 <li class="blockList">
422 <h4>HRGChromosome9Str</h4>
423 <pre>public static final&nbsp;java.lang.String HRGChromosome9Str</pre>
424 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome9Str">Constant Field Values</a></dd></dl>
425 </li>
426 </ul>
427 <a name="HRGChromosome10Str">
428 <!-- -->
429 </a>
430 <ul class="blockList">
431 <li class="blockList">
432 <h4>HRGChromosome10Str</h4>
433 <pre>public static final&nbsp;java.lang.String HRGChromosome10Str</pre>
434 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome10Str">Constant Field Values</a></dd></dl>
435 </li>
436 </ul>
437 <a name="HRGChromosome11Str">
438 <!-- -->
439 </a>
440 <ul class="blockList">
441 <li class="blockList">
442 <h4>HRGChromosome11Str</h4>
443 <pre>public static final&nbsp;java.lang.String HRGChromosome11Str</pre>
444 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome11Str">Constant Field Values</a></dd></dl>
445 </li>
446 </ul>
447 <a name="HRGChromosome12Str">
448 <!-- -->
449 </a>
450 <ul class="blockList">
451 <li class="blockList">
452 <h4>HRGChromosome12Str</h4>
453 <pre>public static final&nbsp;java.lang.String HRGChromosome12Str</pre>
454 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome12Str">Constant Field Values</a></dd></dl>
455 </li>
456 </ul>
457 <a name="HRGChromosome13Str">
458 <!-- -->
459 </a>
460 <ul class="blockList">
461 <li class="blockList">
462 <h4>HRGChromosome13Str</h4>
463 <pre>public static final&nbsp;java.lang.String HRGChromosome13Str</pre>
464 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome13Str">Constant Field Values</a></dd></dl>
465 </li>
466 </ul>
467 <a name="HRGChromosome14Str">
468 <!-- -->
469 </a>
470 <ul class="blockList">
471 <li class="blockList">
472 <h4>HRGChromosome14Str</h4>
473 <pre>public static final&nbsp;java.lang.String HRGChromosome14Str</pre>
474 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome14Str">Constant Field Values</a></dd></dl>
475 </li>
476 </ul>
477 <a name="HRGChromosome15Str">
478 <!-- -->
479 </a>
480 <ul class="blockList">
481 <li class="blockList">
482 <h4>HRGChromosome15Str</h4>
483 <pre>public static final&nbsp;java.lang.String HRGChromosome15Str</pre>
484 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome15Str">Constant Field Values</a></dd></dl>
485 </li>
486 </ul>
487 <a name="HRGChromosome16Str">
488 <!-- -->
489 </a>
490 <ul class="blockList">
491 <li class="blockList">
492 <h4>HRGChromosome16Str</h4>
493 <pre>public static final&nbsp;java.lang.String HRGChromosome16Str</pre>
494 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome16Str">Constant Field Values</a></dd></dl>
495 </li>
496 </ul>
497 <a name="HRGChromosome17Str">
498 <!-- -->
499 </a>
500 <ul class="blockList">
501 <li class="blockList">
502 <h4>HRGChromosome17Str</h4>
503 <pre>public static final&nbsp;java.lang.String HRGChromosome17Str</pre>
504 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome17Str">Constant Field Values</a></dd></dl>
505 </li>
506 </ul>
507 <a name="HRGChromosome18Str">
508 <!-- -->
509 </a>
510 <ul class="blockList">
511 <li class="blockList">
512 <h4>HRGChromosome18Str</h4>
513 <pre>public static final&nbsp;java.lang.String HRGChromosome18Str</pre>
514 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome18Str">Constant Field Values</a></dd></dl>
515 </li>
516 </ul>
517 <a name="HRGChromosome19Str">
518 <!-- -->
519 </a>
520 <ul class="blockList">
521 <li class="blockList">
522 <h4>HRGChromosome19Str</h4>
523 <pre>public static final&nbsp;java.lang.String HRGChromosome19Str</pre>
524 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome19Str">Constant Field Values</a></dd></dl>
525 </li>
526 </ul>
527 <a name="HRGChromosome20Str">
528 <!-- -->
529 </a>
530 <ul class="blockList">
531 <li class="blockList">
532 <h4>HRGChromosome20Str</h4>
533 <pre>public static final&nbsp;java.lang.String HRGChromosome20Str</pre>
534 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome20Str">Constant Field Values</a></dd></dl>
535 </li>
536 </ul>
537 <a name="HRGChromosome21Str">
538 <!-- -->
539 </a>
540 <ul class="blockList">
541 <li class="blockList">
542 <h4>HRGChromosome21Str</h4>
543 <pre>public static final&nbsp;java.lang.String HRGChromosome21Str</pre>
544 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome21Str">Constant Field Values</a></dd></dl>
545 </li>
546 </ul>
547 <a name="HRGChromosome22Str">
548 <!-- -->
549 </a>
550 <ul class="blockList">
551 <li class="blockList">
552 <h4>HRGChromosome22Str</h4>
553 <pre>public static final&nbsp;java.lang.String HRGChromosome22Str</pre>
554 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosome22Str">Constant Field Values</a></dd></dl>
555 </li>
556 </ul>
557 <a name="HRGChromosomeXStr">
558 <!-- -->
559 </a>
560 <ul class="blockList">
561 <li class="blockList">
562 <h4>HRGChromosomeXStr</h4>
563 <pre>public static final&nbsp;java.lang.String HRGChromosomeXStr</pre>
564 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosomeXStr">Constant Field Values</a></dd></dl>
565 </li>
566 </ul>
567 <a name="HRGChromosomeYStr">
568 <!-- -->
569 </a>
570 <ul class="blockList">
571 <li class="blockList">
572 <h4>HRGChromosomeYStr</h4>
573 <pre>public static final&nbsp;java.lang.String HRGChromosomeYStr</pre>
574 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#artificialFastqGenerator.Genomes.HRGChromosomeYStr">Constant Field Values</a></dd></dl>
575 </li>
576 </ul>
577 <a name="logger">
578 <!-- -->
579 </a>
580 <ul class="blockListLast">
581 <li class="blockList">
582 <h4>logger</h4>
583 <pre>public static&nbsp;java.util.logging.Logger logger</pre>
584 </li>
585 </ul>
586 </li>
587 </ul>
588 <!-- ========= CONSTRUCTOR DETAIL ======== -->
589 <ul class="blockList">
590 <li class="blockList"><a name="constructor_detail">
591 <!-- -->
592 </a>
593 <h3>Constructor Detail</h3>
594 <a name="Genomes()">
595 <!-- -->
596 </a>
597 <ul class="blockListLast">
598 <li class="blockList">
599 <h4>Genomes</h4>
600 <pre>public&nbsp;Genomes()</pre>
601 </li>
602 </ul>
603 </li>
604 </ul>
605 <!-- ============ METHOD DETAIL ========== -->
606 <ul class="blockList">
607 <li class="blockList"><a name="method_detail">
608 <!-- -->
609 </a>
610 <h3>Method Detail</h3>
611 <a name="generateToyGenome(java.lang.String, int, boolean, int)">
612 <!-- -->
613 </a>
614 <ul class="blockList">
615 <li class="blockList">
616 <h4>generateToyGenome</h4>
617 <pre>public static&nbsp;void&nbsp;generateToyGenome(java.lang.String&nbsp;outFilePath,
618 int&nbsp;length,
619 boolean&nbsp;printChromosomeLines,
620 int&nbsp;chromosomeLineIntervals)</pre>
621 <div class="block">Generate a toy genome.</div>
622 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>outFilePath</code> - - the path for the outputted toy genome.</dd><dd><code>length</code> - - the number of nucleobases to go into the toy genome.</dd><dd><code>printChromosomeLines</code> - - Whether to write the header lines for each chromosome.</dd><dd><code>chromosomeLineIntervals</code> - - the number of nucleobases to go into each chromosome in the toy genome.</dd></dl>
623 </li>
624 </ul>
625 <a name="createChromosomeArray()">
626 <!-- -->
627 </a>
628 <ul class="blockList">
629 <li class="blockList">
630 <h4>createChromosomeArray</h4>
631 <pre>public static&nbsp;java.lang.String[]&nbsp;createChromosomeArray()</pre>
632 <div class="block">Create an array of chromosome header strings.</div>
633 <dl><dt><span class="strong">Returns:</span></dt><dd>chromosomeStrs - an array of the header strings in the human reference genome for each chromosome.</dd></dl>
634 </li>
635 </ul>
636 <a name="getChromosomeStartEndStrs(java.lang.String)">
637 <!-- -->
638 </a>
639 <ul class="blockList">
640 <li class="blockList">
641 <h4>getChromosomeStartEndStrs</h4>
642 <pre>public static&nbsp;java.lang.String[]&nbsp;getChromosomeStartEndStrs(java.lang.String&nbsp;chromosomes)</pre>
643 <div class="block">Get the human reference genome sequence start and end strings for a set of chromsomes.</div>
644 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chromosomes</code> - - the chromosomes for which we want the start and end strings.</dd>
645 <dt><span class="strong">Returns:</span></dt><dd>chromosomeStartEndStrs - the start and end strings.</dd></dl>
646 </li>
647 </ul>
648 <a name="analyzeHumanReferenceGenome(java.lang.String, java.lang.String, int)">
649 <!-- -->
650 </a>
651 <ul class="blockList">
652 <li class="blockList">
653 <h4>analyzeHumanReferenceGenome</h4>
654 <pre>public static&nbsp;void&nbsp;analyzeHumanReferenceGenome(java.lang.String&nbsp;humanReferenceGenomePath,
655 java.lang.String&nbsp;outputPath,
656 int&nbsp;lineDivisor)</pre>
657 <div class="block">Conduct an analysis of the human reference genome.</div>
658 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>humanReferenceGenomePath</code> - - the path to the human reference genome file.</dd><dd><code>outputPath</code> - - the path for the output.</dd><dd><code>lineDivisor</code> - - the region size in # of nucleobases for which to provide summary statistics.</dd></dl>
659 </li>
660 </ul>
661 <a name="isNonBase(java.lang.String, java.lang.String)">
662 <!-- -->
663 </a>
664 <ul class="blockList">
665 <li class="blockList">
666 <h4>isNonBase</h4>
667 <pre>public static&nbsp;boolean&nbsp;isNonBase(java.lang.String&nbsp;currentCharStr,
668 java.lang.String&nbsp;previousCharStr)</pre>
669 <div class="block">Check whether a human reference sequence file character is a base.</div>
670 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>currentCharStr</code> - - the current human reference sequence file character as a String.</dd><dd><code>previousCharStr</code> - - the previous human reference sequence file character as a String.</dd>
671 <dt><span class="strong">Returns:</span></dt><dd>isNonBase - true if the char is not a base, else false.</dd></dl>
672 </li>
673 </ul>
674 <a name="makeCountProportionsString(double, double, double, double, double, double)">
675 <!-- -->
676 </a>
677 <ul class="blockListLast">
678 <li class="blockList">
679 <h4>makeCountProportionsString</h4>
680 <pre>public static&nbsp;java.lang.String&nbsp;makeCountProportionsString(double&nbsp;ACount,
681 double&nbsp;TCount,
682 double&nbsp;CCount,
683 double&nbsp;GCount,
684 double&nbsp;NCount,
685 double&nbsp;divisor)</pre>
686 <div class="block">Make a String containing summary statistics for a region of nucleobases in the human reference sequence file.</div>
687 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ACount</code> - - number of A nucleobases in the region.</dd><dd><code>TCount</code> - - number of T nucleobases in the region.</dd><dd><code>CCount</code> - - number of C nucleobases in the region.</dd><dd><code>GCount</code> - - number of G nucleobases in the region.</dd><dd><code>NCount</code> - - number of N nucleobases in the region.</dd><dd><code>divisor</code> - - size of the region in number of nucleobases.</dd>
688 <dt><span class="strong">Returns:</span></dt><dd>countProportionsString - the count proportions for the different possible nucleobases in a region in the human
689 reference sequence file.</dd></dl>
690 </li>
691 </ul>
692 </li>
693 </ul>
694 </li>
695 </ul>
696 </div>
697 </div>
698 <!-- ========= END OF CLASS DATA ========= -->
699 <!-- ======= START OF BOTTOM NAVBAR ====== -->
700 <div class="bottomNav"><a name="navbar_bottom">
701 <!-- -->
702 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
703 <!-- -->
704 </a>
705 <ul class="navList" title="Navigation">
706 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
707 <li class="navBarCell1Rev">Class</li>
708 <li><a href="class-use/Genomes.html">Use</a></li>
709 <li><a href="package-tree.html">Tree</a></li>
710 <li><a href="../deprecated-list.html">Deprecated</a></li>
711 <li><a href="../index-files/index-1.html">Index</a></li>
712 <li><a href="../help-doc.html">Help</a></li>
713 </ul>
714 </div>
715 <div class="subNav">
716 <ul class="navList">
717 <li><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
718 <li><a href="../artificialFastqGenerator/Main.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
719 </ul>
720 <ul class="navList">
721 <li><a href="../index.html?artificialFastqGenerator/Genomes.html" target="_top">Frames</a></li>
722 <li><a href="Genomes.html" target="_top">No Frames</a></li>
723 </ul>
724 <ul class="navList" id="allclasses_navbar_bottom">
725 <li><a href="../allclasses-noframe.html">All Classes</a></li>
726 </ul>
727 <div>
728 <script type="text/javascript"><!--
729 allClassesLink = document.getElementById("allclasses_navbar_bottom");
730 if(window==top) {
731 allClassesLink.style.display = "block";
732 }
733 else {
734 allClassesLink.style.display = "none";
735 }
736 //-->
737 </script>
738 </div>
739 <div>
740 <ul class="subNavList">
741 <li>Summary:&nbsp;</li>
742 <li>Nested&nbsp;|&nbsp;</li>
743 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
744 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
745 <li><a href="#method_summary">Method</a></li>
746 </ul>
747 <ul class="subNavList">
748 <li>Detail:&nbsp;</li>
749 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
750 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
751 <li><a href="#method_detail">Method</a></li>
752 </ul>
753 </div>
754 <a name="skip-navbar_bottom">
755 <!-- -->
756 </a></div>
757 <!-- ======== END OF BOTTOM NAVBAR ======= -->
758 </body>
759 </html>