{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathvalidate.html
More file actions
271 lines (161 loc) · 10.8 KB
/
Copy pathvalidate.html
File metadata and controls
271 lines (161 loc) · 10.8 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>validate API Reference — probscale 0.2.3 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="top" title="probscale 0.2.3 documentation" href="../index.html"/>
<link rel="up" title="API and Source Reference" href="../api.html"/>
<link rel="prev" title="transforms API Reference" href="transforms.html"/>
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> probscale
</a>
<div class="version">
0.2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/getting_started.html">Getting started with <code class="docutils literal"><span class="pre">mpl-probscale</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/closer_look_at_viz.html">A closer look at probability plots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial/closer_look_at_plot_pos.html">Using different formulations of plotting positions</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API and Source Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="viz.html"><code class="docutils literal"><span class="pre">viz</span></code> API Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="probscale.html"><code class="docutils literal"><span class="pre">probscale</span></code> API Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="formatters.html"><code class="docutils literal"><span class="pre">formatters</span></code> API Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="transforms.html"><code class="docutils literal"><span class="pre">transforms</span></code> API Reference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">validate</span></code> API Reference</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">probscale</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> »</li>
<li><a href="../api.html">API and Source Reference</a> »</li>
<li><code class="docutils literal"><span class="pre">validate</span></code> API Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/validate.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<blockquote id="validate-auto">
<div>The <code class="docutils literal"><span class="pre">validate</span></code> API</div></blockquote>
<div class="section" id="module-probscale.validate">
<span id="validate-api-reference"></span><h1><code class="docutils literal"><span class="pre">validate</span></code> API Reference<a class="headerlink" href="#module-probscale.validate" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="probscale.validate.axes_object">
<code class="descclassname">probscale.validate.</code><code class="descname">axes_object</code><span class="sig-paren">(</span><em>ax</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#axes_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.axes_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if a value if an Axes. If None, a new one is created.
Both the figure and axes are returned (in that order).</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.axis_name">
<code class="descclassname">probscale.validate.</code><code class="descname">axis_name</code><span class="sig-paren">(</span><em>axis</em>, <em>axname</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#axis_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.axis_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks that an axis name is in <code class="docutils literal"><span class="pre">{'x',</span> <span class="pre">'y'}</span></code>. Raises an error on
an invalid value. Returns the lower case verion of valid values.</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.fit_argument">
<code class="descclassname">probscale.validate.</code><code class="descname">fit_argument</code><span class="sig-paren">(</span><em>arg</em>, <em>argname</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#fit_argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.fit_argument" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks that an axis options is in <code class="docutils literal"><span class="pre">{'x',</span> <span class="pre">y',</span> <span class="pre">'both',</span> <span class="pre">None}</span></code>.
Raises an error on an invalid value. Returns the lower case verion
of valid values.</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.axis_type">
<code class="descclassname">probscale.validate.</code><code class="descname">axis_type</code><span class="sig-paren">(</span><em>axtype</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#axis_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.axis_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks that a valid axis type is requested.</p>
<blockquote>
<div><ul class="simple">
<li><em>pp</em> - percentile axis</li>
<li><em>qq</em> - quantile axis</li>
<li><em>prob</em> - probability axis</li>
</ul>
</div></blockquote>
<p>Raises an error on an invalid value. Returns the lower case verion
of valid values.</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.axis_label">
<code class="descclassname">probscale.validate.</code><code class="descname">axis_label</code><span class="sig-paren">(</span><em>label</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#axis_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.axis_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces None with an empty string for axis labels.</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.other_options">
<code class="descclassname">probscale.validate.</code><code class="descname">other_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#other_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.other_options" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces None with an empty dict for plotting options.</p>
</dd></dl>
<dl class="function">
<dt id="probscale.validate.estimator">
<code class="descclassname">probscale.validate.</code><code class="descname">estimator</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/probscale/validate.html#estimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#probscale.validate.estimator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="transforms.html" class="btn btn-neutral" title="transforms API Reference" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2015, Paul Hobson (Geosyntec Consultants).
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.2.3',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
You can’t perform that action at this time.