Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 763d6289e1351f2d34257ce697a3ccb7 > files > 1293

biopython-doc-1.47-2mdv2008.1.x86_64.rpm

<?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>Bio.Restriction._Update.RestrictionCompiler</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>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Bio-module.html">Package&nbsp;Bio</a> ::
        <a href="Bio.Restriction-module.html">Package&nbsp;Restriction</a> ::
        <a href="Bio.Restriction._Update-module.html">Package&nbsp;_Update</a> ::
        Module&nbsp;RestrictionCompiler
      </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="Bio.Restriction._Update.RestrictionCompiler-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module RestrictionCompiler</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html">source&nbsp;code</a></span></p>
<pre class="literalblock">
Convert a serie of Rebase files into a Restriction_Dictionary.py module.

The Rebase files are in the emboss format :

    emboss_e.###    -&gt; contains informations about the restriction sites.
    emboss_r.###    -&gt; contains general informations about the enzymes.
    emboss_s.###    -&gt; contains informations about the suppliers.
    
### is a 3 digit number. The first digit is the year and the two last the month.

</pre>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         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 href="Bio.Restriction._Update.RestrictionCompiler.OverhangError-class.html" class="summary-name">OverhangError</a><br />
      Exception for dealing with overhang.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler.newenzyme-class.html" class="summary-name">newenzyme</a><br />
      construct the attributes of the enzyme corresponding to 'name'.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler.TypeCompiler-class.html" class="summary-name">TypeCompiler</a><br />
      Build the different types possible for Restriction Enzymes
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler.DictionaryBuilder-class.html" class="summary-name">DictionaryBuilder</a>
    </td>
  </tr>
</table>
<!-- ==================== 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">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.Restriction._Update.RestrictionCompiler-module.html#BaseExpand" class="summary-sig-name">BaseExpand</a>(<span class="summary-sig-arg">base</span>)</span><br />
      given a degenerated base, returns its meaning in IUPAC alphabet.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#BaseExpand">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.Restriction._Update.RestrictionCompiler-module.html#regex" class="summary-sig-name">regex</a>(<span class="summary-sig-arg">site</span>)</span><br />
      Construct a regular expression from a DNA sequence.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#regex">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="Antiparallel"></a><span class="summary-sig-name">Antiparallel</span>(<span class="summary-sig-arg">sequence</span>)</span><br />
      returns a string which represents the reverse complementary strand of
      a DNA sequence.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#Antiparallel">source&nbsp;code</a></span>
            
          </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="Bio.Restriction._Update.RestrictionCompiler-module.html#is_palindrom" class="summary-sig-name">is_palindrom</a>(<span class="summary-sig-arg">sequence</span>)</span><br />
      True is the sequence is a palindrom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#is_palindrom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="LocalTime"></a><span class="summary-sig-name">LocalTime</span>()</span><br />
      LocalTime calculate the extension for emboss file for the current 
      year and month.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#LocalTime">source&nbsp;code</a></span>
            
          </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="DNA"></a><span class="summary-name">DNA</span> = <code title="Seq">Seq</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler-module.html#dna_alphabet" class="summary-name">dna_alphabet</a> = <code title="{'A': 'A', 'C': 'C', 'G': 'G', 'T': 'T', 'R': 'AG', 'Y': 'CT', 'W': 'A\
T', 'S': 'CG', 'M': 'AC', 'K': 'GT', 'H': 'ACT', 'B': 'CGT', 'V': 'ACG\
', 'D': 'AGT', 'N': 'ACGT', 'a': 'a', 'c': 'c', 'g': 'g', 't': 't', 'r\
': 'ag', 'y': 'ct', 'w': 'at', 's': 'cg', 'm': 'ac', 'k': 'gt', 'h': '\
act', 'b': 'cgt', 'v': 'acg', 'd': 'agt', 'n': 'acgt'}">{'A': 'A', 'C': 'C', 'G': 'G', 'T': 'T', 'R': '<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler-module.html#complement_alphabet" class="summary-name">complement_alphabet</a> = <code title="{'A': 'T', 'T': 'A', 'C': 'G', 'G': 'C', 'R': 'Y', 'Y': 'R', 'W': 'W',\
 'S': 'S', 'M': 'K', 'K': 'M', 'H': 'D', 'D': 'H', 'B': 'V', 'V': 'B',\
 'N': 'N', 'a': 't', 'c': 'g', 'g': 'c', 't': 'a', 'r': 'y', 'y': 'r',\
 'w': 'w', 's': 's', 'm': 'k', 'k': 'm', 'h': 'd', 'd': 'h', 'b': 'v',\
 'v': 'b', 'n': 'n'}">{'A': 'T', 'T': 'A', 'C': 'G', 'G': 'C',<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="enzymedict"></a><span class="summary-name">enzymedict</span> = <code title="{}">{}</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="suppliersdict"></a><span class="summary-name">suppliersdict</span> = <code title="{}">{}</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="classdict"></a><span class="summary-name">classdict</span> = <code title="{}">{}</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="typedict"></a><span class="summary-name">typedict</span> = <code title="{}">{}</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Bio.Restriction._Update.RestrictionCompiler-module.html#start" class="summary-name">start</a> = <code title="'\n\
#!/usr/bin/env python\n\
#\n\
#      Restriction Analysis Libraries.\n\
#      Copyright (C) 2004. Frederic Sohm.\n\
#\n\
# This code is part of the Biopython distribution and governed by its\\
n\
...">'<code class="variable-ellipsis">...</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="BaseExpand"></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">BaseExpand</span>(<span class="sig-arg">base</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#BaseExpand">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
given a degenerated base, returns its meaning in IUPAC alphabet.

i.e:
    b= 'A' -&gt; 'A'
    b= 'N' -&gt; 'ACGT'
    etc...

</pre>
  <dl class="fields">
    <dt>Returns: string</dt>
  </dl>
</td></tr></table>
</div>
<a name="regex"></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">regex</span>(<span class="sig-arg">site</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#regex">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Construct a regular expression from a DNA sequence.
i.e. :
    site = 'ABCGN'   -&gt; 'A[CGT]CG.'

</pre>
  <dl class="fields">
    <dt>Returns: string</dt>
  </dl>
</td></tr></table>
</div>
<a name="is_palindrom"></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">is_palindrom</span>(<span class="sig-arg">sequence</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.Restriction._Update.RestrictionCompiler-pysrc.html#is_palindrom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>True is the sequence is a palindrom. sequence is a DNA object.</p>
  <dl class="fields">
    <dt>Returns: bool</dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></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">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="dna_alphabet"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">dna_alphabet</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{'A': 'A', 'C': 'C', 'G': 'G', 'T': 'T', 'R': 'AG', 'Y': 'CT', 'W': 'A<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
T', 'S': 'CG', 'M': 'AC', 'K': 'GT', 'H': 'ACT', 'B': 'CGT', 'V': 'ACG<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
', 'D': 'AGT', 'N': 'ACGT', 'a': 'a', 'c': 'c', 'g': 'g', 't': 't', 'r<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
': 'ag', 'y': 'ct', 'w': 'at', 's': 'cg', 'm': 'ac', 'k': 'gt', 'h': '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
act', 'b': 'cgt', 'v': 'acg', 'd': 'agt', 'n': 'acgt'}
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="complement_alphabet"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">complement_alphabet</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{'A': 'T', 'T': 'A', 'C': 'G', 'G': 'C', 'R': 'Y', 'Y': 'R', 'W': 'W',<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 'S': 'S', 'M': 'K', 'K': 'M', 'H': 'D', 'D': 'H', 'B': 'V', 'V': 'B',<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 'N': 'N', 'a': 't', 'c': 'g', 'g': 'c', 't': 'a', 'r': 'y', 'y': 'r',<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 'w': 'w', 's': 's', 'm': 'k', 'k': 'm', 'h': 'd', 'd': 'h', 'b': 'v',<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 'v': 'b', 'n': 'n'}
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="start"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">start</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
'\n\
#!/usr/bin/env python\n\
#\n\
#      Restriction Analysis Libraries.\n\
#      Copyright (C) 2004. Frederic Sohm.\n\
#\n\
# This code is part of the Biopython distribution and governed by its\<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
n\
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</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>

      <th class="navbar" width="100%"></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 Mon Sep 15 09:26:25 2008
    </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>