Mercurial > repos > yating-l > hac

comparison doc/_build/html/code.html @ 0:0bca8a6364a7 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/Yating-L/hubarchivecreator-test commit 48b59e91e2dcc2e97735ee35d587960cbfbce932-dirty
author yating-l
date Wed, 21 Dec 2016 17:21:18 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:0bca8a6364a7
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
9 <title>Auto Generated Documentation &#8212; HubArchiveCreator 2.3 documentation</title>
10
11 <link rel="stylesheet" href="_static/classic.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: './',
17 VERSION: '2.3',
18 COLLAPSE_INDEX: false,
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27 <link rel="index" title="Index" href="genindex.html" />
28 <link rel="search" title="Search" href="search.html" />
29 <link rel="top" title="HubArchiveCreator 2.3 documentation" href="index.html" />
30 <link rel="prev" title="Welcome to HubArchiveCreator’s documentation!" href="index.html" />
31 </head>
32 <body role="document">
33 <div class="related" role="navigation" aria-label="related navigation">
34 <h3>Navigation</h3>
35 <ul>
36 <li class="right" style="margin-right: 10px">
37 <a href="genindex.html" title="General Index"
38 accesskey="I">index</a></li>
39 <li class="right" >
40 <a href="py-modindex.html" title="Python Module Index"
41 >modules</a> |</li>
42 <li class="right" >
43 <a href="index.html" title="Welcome to HubArchiveCreator’s documentation!"
44 accesskey="P">previous</a> |</li>
45 <li class="nav-item nav-item-0"><a href="index.html">HubArchiveCreator 2.3 documentation</a> &#187;</li>
46 </ul>
47 </div>
48
49 <div class="document">
50 <div class="documentwrapper">
51 <div class="bodywrapper">
52 <div class="body" role="main">
53
54 <div class="section" id="module-hubArchiveCreator">
55 <span id="auto-generated-documentation"></span><h1>Auto Generated Documentation<a class="headerlink" href="#module-hubArchiveCreator" title="Permalink to this headline">¶</a></h1>
56 <p>This Galaxy tool permits to prepare your files to be ready for
57 Assembly Hub visualization.
58 Program test arguments:
59 hubArchiveCreator.py -g test-data/augustusDbia3.gff3 -f test-data/dbia3.fa -d . -u ./tools -o output.html</p>
60 <dl class="function">
61 <dt id="hubArchiveCreator.configure_logger_dev">
62 <code class="descclassname">hubArchiveCreator.</code><code class="descname">configure_logger_dev</code><span class="sig-paren">(</span><em>log_stdout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#configure_logger_dev"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.configure_logger_dev" title="Permalink to this definition">¶</a></dt>
63 <dd><dl class="docutils">
64 <dt>Dev Logger is defined as following:</dt>
65 <dd><ul class="first last simple">
66 <li>Dev needs to have WARN, ERROR and CRITICAL but well formatted / without traceback, in stdout</li>
67 <li>Still access to full, brute and traceback in stderr for errors</li>
68 <li>And further access to debug if needed</li>
69 </ul>
70 </dd>
71 </dl>
72 </dd></dl>
73
74 <dl class="function">
75 <dt id="hubArchiveCreator.configure_logger_stderr">
76 <code class="descclassname">hubArchiveCreator.</code><code class="descname">configure_logger_stderr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#configure_logger_stderr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.configure_logger_stderr" title="Permalink to this definition">¶</a></dt>
77 <dd><p>Configure what should be logged in stderr</p>
78 </dd></dl>
79
80 <dl class="function">
81 <dt id="hubArchiveCreator.configure_logger_user">
82 <code class="descclassname">hubArchiveCreator.</code><code class="descname">configure_logger_user</code><span class="sig-paren">(</span><em>log_stdout=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#configure_logger_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.configure_logger_user" title="Permalink to this definition">¶</a></dt>
83 <dd><dl class="docutils">
84 <dt>User Logger is defined as following:</dt>
85 <dd><ul class="first last">
86 <li><dl class="first docutils">
87 <dt>User needs to have WARN, ERROR and CRITICAL but well formatted / without traceback</dt>
88 <dd><p class="first last">in STDOUT</p>
89 </dd>
90 </dl>
91 </li>
92 <li><dl class="first docutils">
93 <dt>Still access to full, brute and traceback for errors</dt>
94 <dd><p class="first last">in STDERR</p>
95 </dd>
96 </dl>
97 </li>
98 <li><dl class="first docutils">
99 <dt>And further access to debug if needed</dt>
100 <dd><p class="first last">in .log</p>
101 </dd>
102 </dl>
103 </li>
104 </ul>
105 </dd>
106 </dl>
107 </dd></dl>
108
109 <dl class="function">
110 <dt id="hubArchiveCreator.create_ordered_datatype_objects">
111 <code class="descclassname">hubArchiveCreator.</code><code class="descname">create_ordered_datatype_objects</code><span class="sig-paren">(</span><em>ExtensionClass</em>, <em>array_inputs</em>, <em>inputs_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#create_ordered_datatype_objects"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.create_ordered_datatype_objects" title="Permalink to this definition">¶</a></dt>
112 <dd><p>Function which executes the creation all the necessary files / folders for a special Datatype, for TrackHub
113 and update the dictionary of datatype</p>
114 <table class="docutils field-list" frame="void" rules="none">
115 <col class="field-name" />
116 <col class="field-body" />
117 <tbody valign="top">
118 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
119 <li><strong>ExtensionClass</strong> (<em>Datatype</em>) &#8211; </li>
120 <li><strong>array_inputs</strong> (<em>list[string]</em>) &#8211; </li>
121 <li><strong>inputs_data</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; </li>
122 </ul>
123 </td>
124 </tr>
125 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a></p>
126 </td>
127 </tr>
128 </tbody>
129 </table>
130 </dd></dl>
131
132 <dl class="function">
133 <dt id="hubArchiveCreator.sanitize_name_input">
134 <code class="descclassname">hubArchiveCreator.</code><code class="descname">sanitize_name_input</code><span class="sig-paren">(</span><em>string_to_sanitize</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#sanitize_name_input"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.sanitize_name_input" title="Permalink to this definition">¶</a></dt>
135 <dd><p>Sanitize the string passed in parameter by replacing &#8216;/&#8217; and &#8216; &#8216; by &#8216;_&#8217;</p>
136 <table class="docutils field-list" frame="void" rules="none">
137 <col class="field-name" />
138 <col class="field-body" />
139 <tbody valign="top">
140 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string_to_sanitize</strong> &#8211; </td>
141 </tr>
142 </tbody>
143 </table>
144 <p>:return :</p>
145 <table class="docutils field-list" frame="void" rules="none">
146 <col class="field-name" />
147 <col class="field-body" />
148 <tbody valign="top">
149 <tr class="field-odd field"><th class="field-name">Example:</th><td class="field-body"></td>
150 </tr>
151 </tbody>
152 </table>
153 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">sanitize_name_input</span><span class="p">(</span><span class="s1">&#39;this/is an//example&#39;</span><span class="p">)</span>
154 <span class="go">this_is_an__example</span>
155 </pre></div>
156 </div>
157 </dd></dl>
158
159 <dl class="function">
160 <dt id="hubArchiveCreator.sanitize_name_inputs">
161 <code class="descclassname">hubArchiveCreator.</code><code class="descname">sanitize_name_inputs</code><span class="sig-paren">(</span><em>inputs_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/hubArchiveCreator.html#sanitize_name_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#hubArchiveCreator.sanitize_name_inputs" title="Permalink to this definition">¶</a></dt>
162 <dd><p>Sanitize value of the keys &#8220;name&#8221; of the dictionary passed in parameter.</p>
163 <p>Because sometimes output from Galaxy, or even just file name, from user inputs, have spaces.
164 Also, it can contain &#8216;/&#8217; character and could break the use of os.path function.</p>
165 <table class="docutils field-list" frame="void" rules="none">
166 <col class="field-name" />
167 <col class="field-body" />
168 <tbody valign="top">
169 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>inputs_data</strong> &#8211; dict[string, dict[string, string]]</td>
170 </tr>
171 </tbody>
172 </table>
173 </dd></dl>
174
175 </div>
176
177
178 </div>
179 </div>
180 </div>
181 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
182 <div class="sphinxsidebarwrapper">
183 <h4>Previous topic</h4>
184 <p class="topless"><a href="index.html"
185 title="previous chapter">Welcome to HubArchiveCreator&#8217;s documentation!</a></p>
186 <div role="note" aria-label="source link">
187 <h3>This Page</h3>
188 <ul class="this-page-menu">
189 <li><a href="_sources/code.txt"
190 rel="nofollow">Show Source</a></li>
191 </ul>
192 </div>
193 <div id="searchbox" style="display: none" role="search">
194 <h3>Quick search</h3>
195 <form class="search" action="search.html" method="get">
196 <div><input type="text" name="q" /></div>
197 <div><input type="submit" value="Go" /></div>
198 <input type="hidden" name="check_keywords" value="yes" />
199 <input type="hidden" name="area" value="default" />
200 </form>
201 </div>
202 <script type="text/javascript">$('#searchbox').show(0);</script>
203 </div>
204 </div>
205 <div class="clearer"></div>
206 </div>
207 <div class="related" role="navigation" aria-label="related navigation">
208 <h3>Navigation</h3>
209 <ul>
210 <li class="right" style="margin-right: 10px">
211 <a href="genindex.html" title="General Index"
212 >index</a></li>
213 <li class="right" >
214 <a href="py-modindex.html" title="Python Module Index"
215 >modules</a> |</li>
216 <li class="right" >
217 <a href="index.html" title="Welcome to HubArchiveCreator’s documentation!"
218 >previous</a> |</li>
219 <li class="nav-item nav-item-0"><a href="index.html">HubArchiveCreator 2.3 documentation</a> &#187;</li>
220 </ul>
221 </div>
222 <div class="footer" role="contentinfo">
223 &#169; Copyright 2016, Remi Marenco.
224 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
225 </div>
226 </body>
227 </html>