/
extend.html
549 lines (471 loc) · 31.4 KB
/
extend.html
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
<title>Extend — ParamTools</title>
<link rel="stylesheet" href="../_static/css/index.f658d18f9b420779cfdf24aa0a7e2d77.css">
<link rel="stylesheet"
href="../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinx-book-theme.e7340bb3dbd8dde6db86f25597f54a1b.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.css" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
<link rel="preload" as="script" href="../_static/js/index.d3f166471bb80abb5163.js">
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/togglebutton.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script >var togglebuttonSelector = '.toggle, .admonition.dropdown, .tag_hide_input div.cell_input, .tag_hide-input div.cell_input, .tag_hide_output div.cell_output, .tag_hide-output div.cell_output, .tag_hide_cell.cell, .tag_hide-cell.cell';</script>
<script src="../_static/sphinx-book-theme.7d483ff0a819d6edff12ce0b1ead3928.js"></script>
<script async="async" src="https://unpkg.com/thebelab@latest/lib/index.js"></script>
<script >
const thebe_selector = ".thebe"
const thebe_selector_input = "pre"
const thebe_selector_output = ".output"
</script>
<script async="async" src="../_static/sphinx-thebe.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Extend with Indexing" href="indexing.html" />
<link rel="prev" title="View data" href="viewing-data.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
<div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="../index.html">
<h1 class="site-logo" id="site-title">ParamTools</h1>
</a>
</div><form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search this book..." aria-label="Search this book..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<ul class="nav sidenav_l1">
<li class="toctree-l1">
<a class="reference internal" href="../intro.html">
ParamTools
</a>
</li>
</ul>
<p>
<span class="caption-text">
API
</span>
</p>
<ul class="current nav sidenav_l1">
<li class="toctree-l1">
<a class="reference internal" href="guide.html">
Guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="viewing-data.html">
View data
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
Extend
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="indexing.html">
Extend with Indexing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="custom-adjust.html">
Custom Adjustments
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="custom-types.html">
Custom Types
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="reference.html">
API Reference
</a>
</li>
</ul>
<p>
<span class="caption-text">
Parameters
</span>
</p>
<ul class="nav sidenav_l1">
<li class="toctree-l1">
<a class="reference internal" href="../parameters.html">
Parameters
</a>
</li>
</ul>
</nav> <!-- To handle the deprecated key -->
<div class="navbar_extra_footer">
Powered by <a href="https://jupyterbook.org">Jupyter Book</a>
</div>
</div>
<main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
<div class="topbar container-xl fixed-top">
<div class="topbar-contents row">
<div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
<div class="col pl-md-4 topbar-main">
<button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
title="Toggle navigation" data-toggle="tooltip" data-placement="left">
<i class="fas fa-bars"></i>
<i class="fas fa-arrow-left"></i>
<i class="fas fa-arrow-up"></i>
</button>
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn" aria-label="Download this page"><i
class="fas fa-download"></i></button>
<div class="dropdown-buttons">
<!-- ipynb file if we had a myst markdown file -->
<!-- Download raw file -->
<a class="dropdown-buttons" href="../_sources/api/extend.ipynb"><button type="button"
class="btn btn-secondary topbarbtn" title="Download source file" data-toggle="tooltip"
data-placement="left">.ipynb</button></a>
<!-- Download PDF via print -->
<button type="button" id="download-print" class="btn btn-secondary topbarbtn" title="Print to PDF"
onClick="window.print()" data-toggle="tooltip" data-placement="left">.pdf</button>
</div>
</div>
<!-- Source interaction buttons -->
<!-- Full screen (wrap in <a> to have style consistency -->
<a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
title="Fullscreen mode"><i
class="fas fa-expand"></i></button></a>
<!-- Launch buttons -->
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
aria-label="Launch interactive content"><i class="fas fa-rocket"></i></button>
<div class="dropdown-buttons">
<a class="binder-button" href="https://mybinder.org/v2/gh/PSLmodels/ParamTools/master?urlpath=tree/docs/api/extend.ipynb"><button type="button"
class="btn btn-secondary topbarbtn" title="Launch Binder" data-toggle="tooltip"
data-placement="left"><img class="binder-button-logo"
src="../_static/images/logo_binder.svg"
alt="Interact on binder">Binder</button></a>
</div>
</div>
</div>
<!-- Table of contents -->
<div class="d-none d-md-block col-md-2 bd-toc show">
<div class="tocsection onthispage pt-5 pb-3">
<i class="fas fa-list"></i>
Contents
</div>
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#example">
Example
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#clobber">
Clobber
</a>
</li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#extend-behavior-by-validator">
Extend behavior by validator
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#range">
Range
</a>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#choice">
Choice
</a>
</li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id="main-content" class="row">
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
<div>
<section id="extend">
<h1>Extend<a class="headerlink" href="#extend" title="Permalink to this headline">¶</a></h1>
<p>The values of a parameter can be extended along a specified label. This is helpful when a parameter’s values are the same for different values of a label and there is some inherent order in that label. The extend feature allows you to simply write down the minimum amount of information needed to fill in a parameter’s values and ParamTools will fill in the gaps.</p>
<p>To use the extend feature, set the <code class="docutils literal notranslate"><span class="pre">label_to_extend</span></code> class attribute to the label that should be extended.</p>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>The standard deduction parameter’s values only need to be specified when there is a change in the tax law. For the other years, it does not change (unless its indexed to inflation). It would be annoying to have to manually write out each of its values. Instead, we can more concisely write its values in 2017, its new values in 2018 after the TCJA tax reform was passed, and its values after provisions of the TCJA are phased out in 2026.</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">paramtools</span>
<span class="k">class</span> <span class="nc">TaxParams</span><span class="p">(</span><span class="n">paramtools</span><span class="o">.</span><span class="n">Parameters</span><span class="p">):</span>
<span class="n">defaults</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"schema"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"labels"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"year"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"int"</span><span class="p">,</span>
<span class="s2">"validators"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"min"</span><span class="p">:</span> <span class="mi">2013</span><span class="p">,</span> <span class="s2">"max"</span><span class="p">:</span> <span class="mi">2027</span><span class="p">}}</span>
<span class="p">},</span>
<span class="s2">"marital_status"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"str"</span><span class="p">,</span>
<span class="s2">"validators"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"choice"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"choices"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"single"</span><span class="p">,</span> <span class="s2">"joint"</span><span class="p">]}}</span>
<span class="p">},</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"standard_deduction"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"title"</span><span class="p">:</span> <span class="s2">"Standard deduction amount"</span><span class="p">,</span>
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Amount filing unit can use as a standard deduction."</span><span class="p">,</span>
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"float"</span><span class="p">,</span>
<span class="s2">"value"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2017</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"single"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">6350</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2017</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"joint"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">12700</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2018</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"single"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">12000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2018</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"joint"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">24000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2026</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"single"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">7685</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2026</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"joint"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">15369</span><span class="p">}],</span>
<span class="s2">"validators"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"range"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"max"</span><span class="p">:</span> <span class="mf">9e+99</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">}</span>
<span class="n">label_to_extend</span> <span class="o">=</span> <span class="s2">"year"</span>
<span class="n">array_first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">params</span> <span class="o">=</span> <span class="n">TaxParams</span><span class="p">()</span>
<span class="n">params</span><span class="o">.</span><span class="n">standard_deduction</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>array([[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[12000., 24000.],
[ 7685., 15369.],
[ 7685., 15369.]])
</pre></div>
</div>
</div>
</div>
<p>Adjustments are also extended along <code class="docutils literal notranslate"><span class="pre">label_to_extend</span></code>. In the example below, <code class="docutils literal notranslate"><span class="pre">standard_deduction</span></code> is set to 10,000 in 2017, increased to 15,000 for single tax units in 2020, and increased to 20,000 for joint tax units in 2021:</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">params</span><span class="o">.</span><span class="n">adjust</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">"standard_deduction"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2017</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">10000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2020</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"single"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">15000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2021</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"joint"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">20000</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">)</span>
<span class="n">params</span><span class="o">.</span><span class="n">standard_deduction</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>array([[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[10000., 10000.],
[10000., 10000.],
[10000., 10000.],
[15000., 10000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.]])
</pre></div>
</div>
</div>
</div>
<section id="clobber">
<h3>Clobber<a class="headerlink" href="#clobber" title="Permalink to this headline">¶</a></h3>
<p>In the previous example, the new values <em>clobber</em> the existing values in years after they are specified. By setting <code class="docutils literal notranslate"><span class="pre">clobber</span></code> to <code class="docutils literal notranslate"><span class="pre">False</span></code>, only values that were added automatically will be replaced by the new ones. User defined values such as those in 2026 will not be over-written by the new values:</p>
<div class="cell docutils container">
<div class="cell_input docutils container">
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">params</span> <span class="o">=</span> <span class="n">TaxParams</span><span class="p">()</span>
<span class="n">params</span><span class="o">.</span><span class="n">adjust</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">"standard_deduction"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2017</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">10000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2020</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"single"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">15000</span><span class="p">},</span>
<span class="p">{</span><span class="s2">"year"</span><span class="p">:</span> <span class="mi">2021</span><span class="p">,</span> <span class="s2">"marital_status"</span><span class="p">:</span> <span class="s2">"joint"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">20000</span><span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="n">clobber</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">params</span><span class="o">.</span><span class="n">standard_deduction</span>
</pre></div>
</div>
</div>
<div class="cell_output docutils container">
<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>array([[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[ 6350., 12700.],
[10000., 10000.],
[12000., 24000.],
[12000., 24000.],
[15000., 24000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[15000., 20000.],
[ 7685., 15369.],
[ 7685., 15369.]])
</pre></div>
</div>
</div>
</div>
</section>
</section>
<section id="extend-behavior-by-validator">
<h2>Extend behavior by validator<a class="headerlink" href="#extend-behavior-by-validator" title="Permalink to this headline">¶</a></h2>
<p>ParamTools uses the validator associated with <code class="docutils literal notranslate"><span class="pre">label_to_extend</span></code> to determine how values should be extended by assuming that there is some order among the range of possible values for the label.</p>
<p>Note: You can view the grid of values for any label by inspecting the <code class="docutils literal notranslate"><span class="pre">label_grid</span></code> attribute of a <code class="docutils literal notranslate"><span class="pre">paramtools.Parameters</span></code> derived instance.</p>
<section id="range">
<h3>Range<a class="headerlink" href="#range" title="Permalink to this headline">¶</a></h3>
<p><strong>Type:</strong> <code class="docutils literal notranslate"><span class="pre">int</span></code></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"range"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nt">"max"</span><span class="p">:</span> <span class="mi">5</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><em>Extend values:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">]</span>
</pre></div>
</div>
<p><strong>Type:</strong> <code class="docutils literal notranslate"><span class="pre">float</span></code></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"range"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nt">"max"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="nt">"step"</span><span class="p">:</span> <span class="mf">0.5</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><em>Extend values:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">1.5</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">]</span>
</pre></div>
</div>
<p><strong>Type:</strong> <code class="docutils literal notranslate"><span class="pre">date</span></code></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"range"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"min"</span><span class="p">:</span> <span class="s2">"2019-01-01"</span><span class="p">,</span> <span class="nt">"max"</span><span class="p">:</span> <span class="s2">"2019-01-05"</span><span class="p">,</span> <span class="nt">"step"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"days"</span><span class="p">:</span> <span class="mi">2</span> <span class="p">}</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><em>Extend values:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">(</span><span class="mi">2019</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">(</span><span class="mi">2019</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span>
<span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">(</span><span class="mi">2019</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)]</span>
</pre></div>
</div>
</section>
<section id="choice">
<h3>Choice<a class="headerlink" href="#choice" title="Permalink to this headline">¶</a></h3>
<p><strong>Type:</strong> <code class="docutils literal notranslate"><span class="pre">int</span></code></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"choice"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"choices"</span><span class="p">:</span> <span class="p">[</span><span class="mi">-1</span><span class="p">,</span> <span class="mi">-2</span><span class="p">,</span> <span class="mi">-3</span><span class="p">]</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><em>Extend values:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">3</span><span class="p">]</span>
</pre></div>
</div>
<p><strong>Type:</strong> <code class="docutils literal notranslate"><span class="pre">str</span></code></p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="nt">"choice"</span><span class="p">:</span> <span class="p">{</span> <span class="nt">"choices"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"january"</span><span class="p">,</span> <span class="s2">"february"</span><span class="p">,</span> <span class="s2">"march"</span><span class="p">]</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p><em>Extend values:</em></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="s2">"january"</span><span class="p">,</span> <span class="s2">"february"</span><span class="p">,</span> <span class="s2">"march"</span><span class="p">]</span>
</pre></div>
</div>
</section>
</section>
</section>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
kernelName: "python3",
path: "./api"
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="viewing-data.html" title="previous page">View data</a>
<a class='right-next' id="next-link" href="indexing.html" title="next page">Extend with Indexing</a>
</div>
</div>
</div>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
By Hank Doupe<br/>
© Copyright 2020.<br/>
</p>
</div>
</footer>
</main>
</div>
</div>
<script src="../_static/js/index.d3f166471bb80abb5163.js"></script>
</body>
</html>