| 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>ArtificialFastqGenerator</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="ArtificialFastqGenerator"; |
| 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/ArtificialFastqGenerator.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/ArtificialFastqGenerationUtils.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li> |
| 39 |
<li><a href="../artificialFastqGenerator/ArtificialFastqGenerator.BabyRead.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/ArtificialFastqGenerator.html" target="_top">Frames</a></li> |
| 43 |
<li><a href="ArtificialFastqGenerator.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: </li> |
| 63 |
<li><a href="#nested_class_summary">Nested</a> | </li> |
| 64 |
<li>Field | </li> |
| 65 |
<li><a href="#constructor_summary">Constr</a> | </li> |
| 66 |
<li><a href="#method_summary">Method</a></li> |
| 67 |
</ul> |
| 68 |
<ul class="subNavList"> |
| 69 |
<li>Detail: </li> |
| 70 |
<li>Field | </li> |
| 71 |
<li><a href="#constructor_detail">Constr</a> | </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 ArtificialFastqGenerator" class="title">Class ArtificialFastqGenerator</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.ArtificialFastqGenerator</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">ArtificialFastqGenerator</span> |
| 99 |
extends java.lang.Object</pre> |
| 100 |
<div class="block">An instance of this class can be used to generate artificial FASTQ files from the human reference genome. |
| 101 |
|
| 102 |
Copyright (C) 2012 The Institute of Cancer Research (ICR). |
| 103 |
|
| 104 |
This file is part of ArtificialFastqGenerator v1.0.0. |
| 105 |
|
| 106 |
ArtificialFastqGenerator is free software: you can redistribute it and/or modify it under the terms of the GNU General |
| 107 |
Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any |
| 108 |
later version. |
| 109 |
|
| 110 |
This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty |
| 111 |
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
| 112 |
|
| 113 |
You should have received a copy of the GNU Public License along with this program. If not, see |
| 114 |
<http://www.gnu.org/licenses/> |
| 115 |
|
| 116 |
Authour's contact email: [email protected]</div> |
| 117 |
</li> |
| 118 |
</ul> |
| 119 |
</div> |
| 120 |
<div class="summary"> |
| 121 |
<ul class="blockList"> |
| 122 |
<li class="blockList"> |
| 123 |
<!-- ======== NESTED CLASS SUMMARY ======== --> |
| 124 |
<ul class="blockList"> |
| 125 |
<li class="blockList"><a name="nested_class_summary"> |
| 126 |
<!-- --> |
| 127 |
</a> |
| 128 |
<h3>Nested Class Summary</h3> |
| 129 |
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| 130 |
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| 131 |
<tr> |
| 132 |
<th class="colFirst" scope="col">Modifier and Type</th> |
| 133 |
<th class="colLast" scope="col">Class and Description</th> |
| 134 |
</tr> |
| 135 |
<tr class="altColor"> |
| 136 |
<td class="colFirst"><code>class </code></td> |
| 137 |
<td class="colLast"><code><strong><a href="../artificialFastqGenerator/ArtificialFastqGenerator.BabyRead.html" title="class in artificialFastqGenerator">ArtificialFastqGenerator.BabyRead</a></strong></code> |
| 138 |
<div class="block">A sequence of nucleobases which may be used to create a read.</div> |
| 139 |
</td> |
| 140 |
</tr> |
| 141 |
</table> |
| 142 |
</li> |
| 143 |
</ul> |
| 144 |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| 145 |
<ul class="blockList"> |
| 146 |
<li class="blockList"><a name="constructor_summary"> |
| 147 |
<!-- --> |
| 148 |
</a> |
| 149 |
<h3>Constructor Summary</h3> |
| 150 |
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| 151 |
<caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| 152 |
<tr> |
| 153 |
<th class="colOne" scope="col">Constructor and Description</th> |
| 154 |
</tr> |
| 155 |
<tr class="altColor"> |
| 156 |
<td class="colOne"><code><strong><a href="../artificialFastqGenerator/ArtificialFastqGenerator.html#ArtificialFastqGenerator()">ArtificialFastqGenerator</a></strong>()</code> </td> |
| 157 |
</tr> |
| 158 |
</table> |
| 159 |
</li> |
| 160 |
</ul> |
| 161 |
<!-- ========== METHOD SUMMARY =========== --> |
| 162 |
<ul class="blockList"> |
| 163 |
<li class="blockList"><a name="method_summary"> |
| 164 |
<!-- --> |
| 165 |
</a> |
| 166 |
<h3>Method Summary</h3> |
| 167 |
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| 168 |
<caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| 169 |
<tr> |
| 170 |
<th class="colFirst" scope="col">Modifier and Type</th> |
| 171 |
<th class="colLast" scope="col">Method and Description</th> |
| 172 |
</tr> |
| 173 |
<tr class="altColor"> |
| 174 |
<td class="colFirst"><code>void</code></td> |
| 175 |
<td class="colLast"><code><strong><a href="../artificialFastqGenerator/ArtificialFastqGenerator.html#generateArtificialFastqs(java.lang.String)">generateArtificialFastqs</a></strong>(java.lang.String referenceGenomePath)</code> |
| 176 |
<div class="block">Main method for generating FASTQ files.</div> |
| 177 |
</td> |
| 178 |
</tr> |
| 179 |
</table> |
| 180 |
<ul class="blockList"> |
| 181 |
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| 182 |
<!-- --> |
| 183 |
</a> |
| 184 |
<h3>Methods inherited from class java.lang.Object</h3> |
| 185 |
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| 186 |
</ul> |
| 187 |
</li> |
| 188 |
</ul> |
| 189 |
</li> |
| 190 |
</ul> |
| 191 |
</div> |
| 192 |
<div class="details"> |
| 193 |
<ul class="blockList"> |
| 194 |
<li class="blockList"> |
| 195 |
<!-- ========= CONSTRUCTOR DETAIL ======== --> |
| 196 |
<ul class="blockList"> |
| 197 |
<li class="blockList"><a name="constructor_detail"> |
| 198 |
<!-- --> |
| 199 |
</a> |
| 200 |
<h3>Constructor Detail</h3> |
| 201 |
<a name="ArtificialFastqGenerator()"> |
| 202 |
<!-- --> |
| 203 |
</a> |
| 204 |
<ul class="blockListLast"> |
| 205 |
<li class="blockList"> |
| 206 |
<h4>ArtificialFastqGenerator</h4> |
| 207 |
<pre>public ArtificialFastqGenerator()</pre> |
| 208 |
</li> |
| 209 |
</ul> |
| 210 |
</li> |
| 211 |
</ul> |
| 212 |
<!-- ============ METHOD DETAIL ========== --> |
| 213 |
<ul class="blockList"> |
| 214 |
<li class="blockList"><a name="method_detail"> |
| 215 |
<!-- --> |
| 216 |
</a> |
| 217 |
<h3>Method Detail</h3> |
| 218 |
<a name="generateArtificialFastqs(java.lang.String)"> |
| 219 |
<!-- --> |
| 220 |
</a> |
| 221 |
<ul class="blockListLast"> |
| 222 |
<li class="blockList"> |
| 223 |
<h4>generateArtificialFastqs</h4> |
| 224 |
<pre>public void generateArtificialFastqs(java.lang.String referenceGenomePath)</pre> |
| 225 |
<div class="block">Main method for generating FASTQ files.</div> |
| 226 |
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>referenceGenomePath</code> - </dd></dl> |
| 227 |
</li> |
| 228 |
</ul> |
| 229 |
</li> |
| 230 |
</ul> |
| 231 |
</li> |
| 232 |
</ul> |
| 233 |
</div> |
| 234 |
</div> |
| 235 |
<!-- ========= END OF CLASS DATA ========= --> |
| 236 |
<!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 237 |
<div class="bottomNav"><a name="navbar_bottom"> |
| 238 |
<!-- --> |
| 239 |
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| 240 |
<!-- --> |
| 241 |
</a> |
| 242 |
<ul class="navList" title="Navigation"> |
| 243 |
<li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li> |
| 244 |
<li class="navBarCell1Rev">Class</li> |
| 245 |
<li><a href="class-use/ArtificialFastqGenerator.html">Use</a></li> |
| 246 |
<li><a href="package-tree.html">Tree</a></li> |
| 247 |
<li><a href="../deprecated-list.html">Deprecated</a></li> |
| 248 |
<li><a href="../index-files/index-1.html">Index</a></li> |
| 249 |
<li><a href="../help-doc.html">Help</a></li> |
| 250 |
</ul> |
| 251 |
</div> |
| 252 |
<div class="subNav"> |
| 253 |
<ul class="navList"> |
| 254 |
<li><a href="../artificialFastqGenerator/ArtificialFastqGenerationUtils.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li> |
| 255 |
<li><a href="../artificialFastqGenerator/ArtificialFastqGenerator.BabyRead.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li> |
| 256 |
</ul> |
| 257 |
<ul class="navList"> |
| 258 |
<li><a href="../index.html?artificialFastqGenerator/ArtificialFastqGenerator.html" target="_top">Frames</a></li> |
| 259 |
<li><a href="ArtificialFastqGenerator.html" target="_top">No Frames</a></li> |
| 260 |
</ul> |
| 261 |
<ul class="navList" id="allclasses_navbar_bottom"> |
| 262 |
<li><a href="../allclasses-noframe.html">All Classes</a></li> |
| 263 |
</ul> |
| 264 |
<div> |
| 265 |
<script type="text/javascript"><!-- |
| 266 |
allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 267 |
if(window==top) { |
| 268 |
allClassesLink.style.display = "block"; |
| 269 |
} |
| 270 |
else { |
| 271 |
allClassesLink.style.display = "none"; |
| 272 |
} |
| 273 |
//--> |
| 274 |
</script> |
| 275 |
</div> |
| 276 |
<div> |
| 277 |
<ul class="subNavList"> |
| 278 |
<li>Summary: </li> |
| 279 |
<li><a href="#nested_class_summary">Nested</a> | </li> |
| 280 |
<li>Field | </li> |
| 281 |
<li><a href="#constructor_summary">Constr</a> | </li> |
| 282 |
<li><a href="#method_summary">Method</a></li> |
| 283 |
</ul> |
| 284 |
<ul class="subNavList"> |
| 285 |
<li>Detail: </li> |
| 286 |
<li>Field | </li> |
| 287 |
<li><a href="#constructor_detail">Constr</a> | </li> |
| 288 |
<li><a href="#method_detail">Method</a></li> |
| 289 |
</ul> |
| 290 |
</div> |
| 291 |
<a name="skip-navbar_bottom"> |
| 292 |
<!-- --> |
| 293 |
</a></div> |
| 294 |
<!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 295 |
</body> |
| 296 |
</html> |