/usr/share/doc/macsyfinder/html/profile.html is in macsyfinder 1.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Profile API — MacSyFinder 1.0.4 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="HMMReport API" href="HMMReport.html" />
<link rel="prev" title="Gene API" href="gene.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="HMMReport.html" title="HMMReport API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gene.html" title="Gene API"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MacSyFinder documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="profile-api">
<span id="profile"></span><h1>Profile API<a class="headerlink" href="#profile-api" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="implementation.html#profile-implementation"><span class="std std-ref">Profile object</span></a> is used for the search of the gene with Hmmer. A <em>“Profile”</em> must match a HMM protein profile file, which name is based on the profile name. For instance, the <em>gspG</em> gene has the corresponding “gspG.hmm” profile file provided at a dedicated location.</p>
<div class="section" id="profilefactory-api-reference">
<h2>ProfileFactory API reference<a class="headerlink" href="#profilefactory-api-reference" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><span class="target" id="module-macsypy.gene"></span><dl class="class">
<dt id="macsypy.gene.ProfileFactory">
<em class="property">class </em><code class="descclassname">macsypy.gene.</code><code class="descname">ProfileFactory</code><a class="reference internal" href="_modules/macsypy/gene.html#ProfileFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.ProfileFactory" title="Permalink to this definition">¶</a></dt>
<dd><p>Build and store all Profile objects. Profiles must not be instanciated directly.
The profile_factory must be used. The profile_factory ensures there is only one instance
of profile for a given name.
To get a profile, use the method get_profile. If the profile is already cached, this instance is returned.
Otherwise a new profile is built, stored in the profile_factory and then returned.</p>
<dl class="attribute">
<dt id="macsypy.gene.ProfileFactory.__weakref__">
<code class="descname">__weakref__</code><a class="headerlink" href="#macsypy.gene.ProfileFactory.__weakref__" title="Permalink to this definition">¶</a></dt>
<dd><p>list of weak references to the object (if defined)</p>
</dd></dl>
<dl class="method">
<dt id="macsypy.gene.ProfileFactory.get_profile">
<code class="descname">get_profile</code><span class="sig-paren">(</span><em>gene</em>, <em>cfg</em>, <em>profiles_registry</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#ProfileFactory.get_profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.ProfileFactory.get_profile" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>gene</strong> (<a class="reference internal" href="gene.html#macsypy.gene.Gene" title="macsypy.gene.Gene"><code class="xref py py-class docutils literal"><span class="pre">macsypy.gene.Gene</span></code></a> or <a class="reference internal" href="gene.html#macsypy.gene.Homolog" title="macsypy.gene.Homolog"><code class="xref py py-class docutils literal"><span class="pre">macsypy.gene.Homolog</span></code></a> or <a class="reference internal" href="gene.html#macsypy.gene.Analog" title="macsypy.gene.Analog"><code class="xref py py-class docutils literal"><span class="pre">macsypy.gene.Analog</span></code></a> object) – the gene associated to this profile</li>
<li><strong>profiles_registry</strong> (<em>the registry of profiles</em>) – the registry where are stored the path of the profiles</li>
<li><strong>profiles_registry</strong> – <code class="xref py py-class docutils literal"><span class="pre">macsypy.registries.ProfilesRegistry</span></code> instance.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the profile corresponding to the name.
If the profile already exists, return it. Otherwise build it, store it and return it.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#macsypy.gene.Profile" title="macsypy.gene.Profile"><code class="xref py py-class docutils literal"><span class="pre">macsypy.gene.Profile</span></code></a> object</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div></blockquote>
</div>
<div class="section" id="module-macsypy.gene">
<span id="profile-api-reference"></span><h2>Profile API reference<a class="headerlink" href="#module-macsypy.gene" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="macsypy.gene.Profile">
<em class="property">class </em><code class="descclassname">macsypy.gene.</code><code class="descname">Profile</code><span class="sig-paren">(</span><em>gene</em>, <em>cfg</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle a HMM protein profile</p>
<dl class="method">
<dt id="macsypy.gene.Profile.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>gene</em>, <em>cfg</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile.__init__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>gene</strong> – the gene corresponding to this profile</li>
<li><strong>cfg</strong> (<code class="xref py py-class docutils literal"><span class="pre">macsypy.config.Config</span></code> object) – the configuration</li>
<li><strong>path</strong> (<em>string</em>) – the path to the hmm profile.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="macsypy.gene.Profile.__len__">
<code class="descname">__len__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile.__len__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile.__len__" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the length of the HMM protein profile</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="macsypy.gene.Profile.__str__">
<code class="descname">__str__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile.__str__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile.__str__" title="Permalink to this definition">¶</a></dt>
<dd><p>Print the name of the corresponding gene and the path to the HMM profile.</p>
</dd></dl>
<dl class="attribute">
<dt id="macsypy.gene.Profile.__weakref__">
<code class="descname">__weakref__</code><a class="headerlink" href="#macsypy.gene.Profile.__weakref__" title="Permalink to this definition">¶</a></dt>
<dd><p>list of weak references to the object (if defined)</p>
</dd></dl>
<dl class="method">
<dt id="macsypy.gene.Profile._len">
<code class="descname">_len</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile._len"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile._len" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the HMM profile file to get and store the length.
This private method is called at the Profile init.</p>
</dd></dl>
<dl class="method">
<dt id="macsypy.gene.Profile.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/macsypy/gene.html#Profile.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macsypy.gene.Profile.execute" title="Permalink to this definition">¶</a></dt>
<dd><p>Launch the Hmmer search (hmmsearch executable) with this profile</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">an object storing information on th results of the HMM search (HMMReport)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="HMMReport.html#macsypy.report.HMMReport" title="macsypy.report.HMMReport"><code class="xref py py-class docutils literal"><span class="pre">macsypy.report.HMMReport</span></code></a> object</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Profile API</a><ul>
<li><a class="reference internal" href="#profilefactory-api-reference">ProfileFactory API reference</a></li>
<li><a class="reference internal" href="#module-macsypy.gene">Profile API reference</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="gene.html"
title="previous chapter">Gene API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="HMMReport.html"
title="next chapter">HMMReport API</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/profile.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="HMMReport.html" title="HMMReport API"
>next</a> |</li>
<li class="right" >
<a href="gene.html" title="Gene API"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">MacSyFinder documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Sophie Abby, Bertrand Néron.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
|