File: core.insert_mutations-module.html

package info (click to toggle)
arden 1.0-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,128 kB
  • sloc: python: 1,555; javascript: 249; sh: 10; makefile: 2
file content (403 lines) | stat: -rw-r--r-- 16,124 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>core.insert_mutations</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ARDEN</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;insert_mutations
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="core.insert_mutations-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module insert_mutations</h1><p class="nomargin-top"></p>
<p>Created 2012 core Script for the generation of the artificial 
  reference genome</p>
  <p>The functions purpose is to to go through a list of positions and find
  balanced mutations which fulfill the demands on the artificial reference 
  genome. Once a initial start positions is randomly selected all possible 
  triplets with hamming distance 1 are generated and looked up in a 
  dictionary which contains all triplet positions in the input genome. If a
  suitable partner is found for the initial mutation the next start 
  positions is chosen randomly. Else: try all other triplets with hamming 
  distance 1 until no one is left. This process can be accelerated by 
  allowing unbalanced mutations, but this will cause differences in the 
  NUC/AA distribution and the AA neighborhood.</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        Sven Giese
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list,list</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="core.insert_mutations-module.html#getMutation" class="summary-sig-name">getMutation</a>(<span class="summary-sig-arg">AA</span>,
        <span class="summary-sig-arg">Codon</span>)</span><br />
      Returns a random mutation for a given AA and its Codon(DNA).</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Char,Char,int</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="core.insert_mutations-module.html#getdifference" class="summary-sig-name">getdifference</a>(<span class="summary-sig-arg">triplet_old</span>,
        <span class="summary-sig-arg">triplet_new</span>)</span><br />
      Given two triplets, returns the differences between them plus the 
      position</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">Bool</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="core.insert_mutations-module.html#isvalidposition" class="summary-sig-name">isvalidposition</a>(<span class="summary-sig-arg">pdic</span>,
        <span class="summary-sig-arg">iprime</span>,
        <span class="summary-sig-arg">distance</span>)</span><br />
      Checks if a position is valid for mutation.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">list</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="core.insert_mutations-module.html#mutate_random" class="summary-sig-name">mutate_random</a>(<span class="summary-sig-arg">DNA</span>,
        <span class="summary-sig-arg">AminoAcid</span>,
        <span class="summary-sig-arg">distance</span>,
        <span class="summary-sig-arg">pdic</span>,
        <span class="summary-sig-arg">rev</span>,
        <span class="summary-sig-arg">header</span>,
        <span class="summary-sig-arg">Random</span>,
        <span class="summary-sig-arg">outputpath</span>)</span><br />
      Mutates a given DNA(AminoAcid) Genomesequence on several positions 
      (distance based on DISTANCE var.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'core'"><code class="variable-quote">'</code><code class="variable-string">core</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getMutation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getMutation</span>(<span class="sig-arg">AA</span>,
        <span class="sig-arg">Codon</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a random mutation for a given AA and its Codon(DNA). The 
  mutation is done in a way which supports the equilibrium of the 
  nucleotide distribution by only regarding hamming distance=1 Codons as 
  possible mutations</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>AA</code></strong> (string) - Single AA.</li>
        <li><strong class="pname"><code>Codon</code></strong> (string) - 3-letter dna code.</li>
    </ul></dd>
    <dt>Returns: list,list</dt>
        <dd>A list of all valid mutations (triplet) and the coresponding AA.</dd>
  </dl>
</td></tr></table>
</div>
<a name="getdifference"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getdifference</span>(<span class="sig-arg">triplet_old</span>,
        <span class="sig-arg">triplet_new</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Given two triplets, returns the differences between them plus the 
  position</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>triplet_old</code></strong> (string) - AA triplet.</li>
        <li><strong class="pname"><code>triplet_new</code></strong> (string) - AA triplet.</li>
    </ul></dd>
    <dt>Returns: Char,Char,int</dt>
        <dd>The new aminoacid, the old aminoacid and the position.</dd>
  </dl>
</td></tr></table>
</div>
<a name="isvalidposition"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">isvalidposition</span>(<span class="sig-arg">pdic</span>,
        <span class="sig-arg">iprime</span>,
        <span class="sig-arg">distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if a position is valid for mutation. It queries all neighboring
  positions (iprime +-distance) to check whether there already was a 
  mutation in pdic</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>pdic</code></strong> (dictionary) - Diciontary containing mutations and start/ stop codons..</li>
        <li><strong class="pname"><code>iprime</code></strong> (int) - Position of the prospective mutation (DNA level)</li>
        <li><strong class="pname"><code>distance</code></strong> (int) - User defined parameter which limits the distance between two 
          mutations.</li>
    </ul></dd>
    <dt>Returns: Bool</dt>
        <dd>Boolean which decides if the position is valid (1= yes,0 = no)</dd>
  </dl>
</td></tr></table>
</div>
<a name="mutate_random"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mutate_random</span>(<span class="sig-arg">DNA</span>,
        <span class="sig-arg">AminoAcid</span>,
        <span class="sig-arg">distance</span>,
        <span class="sig-arg">pdic</span>,
        <span class="sig-arg">rev</span>,
        <span class="sig-arg">header</span>,
        <span class="sig-arg">Random</span>,
        <span class="sig-arg">outputpath</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Mutates a given DNA(AminoAcid) Genomesequence on several positions 
  (distance based on DISTANCE var. If one mutation is done a compareable 
  Triplet is searched to &quot;reverse&quot; the  changes made in AA 
  distribution, N distribution, AA neighborhood</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>DNA</code></strong> (list) - DNA sequence of the reference genome.</li>
        <li><strong class="pname"><code>AminoAcid</code></strong> (list) - AA sequence of the reference genome.</li>
        <li><strong class="pname"><code>rev</code></strong> (Bool) - Boolean which decides if unbalanced mutations are allowed (only 
          initial mutation is performed)</li>
        <li><strong class="pname"><code>pdic</code></strong> (dictionary) - Diciontary containing mutations and start/ stop codons..</li>
        <li><strong class="pname"><code>header</code></strong> (string) - Header for the resulting artificial reference file (fasta 
          format).</li>
        <li><strong class="pname"><code>Random</code></strong> (Bool) - Boolean for choosing on of the mutation modes (linear = 0,random 
          = 1)</li>
        <li><strong class="pname"><code>distance</code></strong> (int) - User defined parameter which limits the distance between two 
          mutations.</li>
    </ul></dd>
    <dt>Returns: list</dt>
        <dd>Artificial reference genome sequence.</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ARDEN</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Mar 13 10:43:16 2013
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>