| 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</li> |
| 29 |
<li><a href="package-use.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>Prev Package</li> |
| 39 |
<li>Next Package</li> |
| 40 |
</ul> |
| 41 |
<ul class="navList"> |
| 42 |
<li><a href="../index.html?artificialFastqGenerator/package-summary.html" target="_top">Frames</a></li> |
| 43 |
<li><a href="package-summary.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 |
<a name="skip-navbar_top"> |
| 61 |
<!-- --> |
| 62 |
</a></div> |
| 63 |
<!-- ========= END OF TOP NAVBAR ========= --> |
| 64 |
<div class="header"> |
| 65 |
<h1 title="Package" class="title">Package artificialFastqGenerator</h1> |
| 66 |
</div> |
| 67 |
<div class="contentContainer"> |
| 68 |
<ul class="blockList"> |
| 69 |
<li class="blockList"> |
| 70 |
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| 71 |
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| 72 |
<tr> |
| 73 |
<th class="colFirst" scope="col">Class</th> |
| 74 |
<th class="colLast" scope="col">Description</th> |
| 75 |
</tr> |
| 76 |
<tbody> |
| 77 |
<tr class="altColor"> |
| 78 |
<td class="colFirst"><a href="../artificialFastqGenerator/AbstractRead.html" title="class in artificialFastqGenerator">AbstractRead</a></td> |
| 79 |
<td class="colLast"> </td> |
| 80 |
</tr> |
| 81 |
<tr class="rowColor"> |
| 82 |
<td class="colFirst"><a href="../artificialFastqGenerator/ArtificialFastqGenerationUtils.html" title="class in artificialFastqGenerator">ArtificialFastqGenerationUtils</a></td> |
| 83 |
<td class="colLast"> |
| 84 |
<div class="block">ArtificialFastqGenerationUtils consists exclusively of static utility methods that are used in |
| 85 |
artificial fastq generation.</div> |
| 86 |
</td> |
| 87 |
</tr> |
| 88 |
<tr class="altColor"> |
| 89 |
<td class="colFirst"><a href="../artificialFastqGenerator/ArtificialFastqGenerator.html" title="class in artificialFastqGenerator">ArtificialFastqGenerator</a></td> |
| 90 |
<td class="colLast"> |
| 91 |
<div class="block">An instance of this class can be used to generate artificial FASTQ files from the human reference genome.</div> |
| 92 |
</td> |
| 93 |
</tr> |
| 94 |
<tr class="altColor"> |
| 95 |
<td class="colFirst"><a href="../artificialFastqGenerator/BriefLogFormatter.html" title="class in artificialFastqGenerator">BriefLogFormatter</a></td> |
| 96 |
<td class="colLast"> |
| 97 |
<div class="block">Instances of this class can log messages which consist of the time followed by the record.</div> |
| 98 |
</td> |
| 99 |
</tr> |
| 100 |
<tr class="rowColor"> |
| 101 |
<td class="colFirst"><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html" title="class in artificialFastqGenerator">CoverageStatisticsCalculator</a></td> |
| 102 |
<td class="colLast"> |
| 103 |
<div class="block">Instances of this class calculate regional and overall coverage statistics for nucleobases.</div> |
| 104 |
</td> |
| 105 |
</tr> |
| 106 |
<tr class="altColor"> |
| 107 |
<td class="colFirst"><a href="../artificialFastqGenerator/Genomes.html" title="class in artificialFastqGenerator">Genomes</a></td> |
| 108 |
<td class="colLast"> |
| 109 |
<div class="block">The Genomes class provides facilities for (1) creating a toy genome, (2) getting the start and end strings for a |
| 110 |
chromosome in the human reference genome, (3) analysing and producing summary statistics for the human reference genome.</div> |
| 111 |
</td> |
| 112 |
</tr> |
| 113 |
<tr class="rowColor"> |
| 114 |
<td class="colFirst"><a href="../artificialFastqGenerator/Main.html" title="class in artificialFastqGenerator">Main</a></td> |
| 115 |
<td class="colLast"> |
| 116 |
<div class="block">This class is responsible for checking whether the user's command is valid, |
| 117 |
and if it is, creating instances of the ArtificialFastqGenerator class in order |
| 118 |
to generate fastq files.</div> |
| 119 |
</td> |
| 120 |
</tr> |
| 121 |
<tr class="altColor"> |
| 122 |
<td class="colFirst"><a href="../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a></td> |
| 123 |
<td class="colLast"> |
| 124 |
<div class="block">An instance of the Nucleobase class corresponds to a nucleobase in the human reference genome.</div> |
| 125 |
</td> |
| 126 |
</tr> |
| 127 |
<tr class="rowColor"> |
| 128 |
<td class="colFirst"><a href="../artificialFastqGenerator/NucleobaseAndReadFactory.html" title="class in artificialFastqGenerator">NucleobaseAndReadFactory</a></td> |
| 129 |
<td class="colLast"> |
| 130 |
<div class="block">An instance of this class can be used to create new Nucleobase and Read objects.</div> |
| 131 |
</td> |
| 132 |
</tr> |
| 133 |
<tr class="altColor"> |
| 134 |
<td class="colFirst"><a href="../artificialFastqGenerator/QualityScoreAndErrorGenerator.html" title="class in artificialFastqGenerator">QualityScoreAndErrorGenerator</a></td> |
| 135 |
<td class="colLast"> |
| 136 |
<div class="block">An instance of this class can be used to generate (1) ASCII encodings of Phred quality scores for bases in reads; (2) |
| 137 |
base-call errors.</div> |
| 138 |
</td> |
| 139 |
</tr> |
| 140 |
<tr class="rowColor"> |
| 141 |
<td class="colFirst"><a href="../artificialFastqGenerator/Read.html" title="class in artificialFastqGenerator">Read</a></td> |
| 142 |
<td class="colLast"> |
| 143 |
<div class="block">An instance of this class corresponds to a read in an artificial fastq file.</div> |
| 144 |
</td> |
| 145 |
</tr> |
| 146 |
</tbody> |
| 147 |
</table> |
| 148 |
</li> |
| 149 |
</ul> |
| 150 |
</div> |
| 151 |
<!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 152 |
<div class="bottomNav"><a name="navbar_bottom"> |
| 153 |
<!-- --> |
| 154 |
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| 155 |
<!-- --> |
| 156 |
</a> |
| 157 |
<ul class="navList" title="Navigation"> |
| 158 |
<li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li> |
| 159 |
<li>Class</li> |
| 160 |
<li><a href="package-use.html">Use</a></li> |
| 161 |
<li><a href="package-tree.html">Tree</a></li> |
| 162 |
<li><a href="../deprecated-list.html">Deprecated</a></li> |
| 163 |
<li><a href="../index-files/index-1.html">Index</a></li> |
| 164 |
<li><a href="../help-doc.html">Help</a></li> |
| 165 |
</ul> |
| 166 |
</div> |
| 167 |
<div class="subNav"> |
| 168 |
<ul class="navList"> |
| 169 |
<li>Prev Package</li> |
| 170 |
<li>Next Package</li> |
| 171 |
</ul> |
| 172 |
<ul class="navList"> |
| 173 |
<li><a href="../index.html?artificialFastqGenerator/package-summary.html" target="_top">Frames</a></li> |
| 174 |
<li><a href="package-summary.html" target="_top">No Frames</a></li> |
| 175 |
</ul> |
| 176 |
<ul class="navList" id="allclasses_navbar_bottom"> |
| 177 |
<li><a href="../allclasses-noframe.html">All Classes</a></li> |
| 178 |
</ul> |
| 179 |
<div> |
| 180 |
<script type="text/javascript"><!-- |
| 181 |
allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 182 |
if(window==top) { |
| 183 |
allClassesLink.style.display = "block"; |
| 184 |
} |
| 185 |
else { |
| 186 |
allClassesLink.style.display = "none"; |
| 187 |
} |
| 188 |
//--> |
| 189 |
</script> |
| 190 |
</div> |
| 191 |
<a name="skip-navbar_bottom"> |
| 192 |
<!-- --> |
| 193 |
</a></div> |
| 194 |
<!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 195 |
</body> |
| 196 |
</html> |