/
indexing.html
628 lines (544 loc) · 35.4 KB
/
indexing.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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
<!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 with Indexing — 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="Custom Adjustments" href="custom-adjust.html" />
<link rel="prev" title="Extend" href="extend.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">
<a class="reference internal" href="extend.html">
Extend
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
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/indexing.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/indexing.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="#code-for-getting-tax-calculator-index-rates">
Code for getting Tax-Calculator index rates
</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-with-indexing">
<h1>Extend with Indexing<a class="headerlink" href="#extend-with-indexing" title="Permalink to this headline">¶</a></h1>
<p>ParamTools provides out-of-the-box parameter indexing. This is helpful for projects that have parameters that change at some rate over time. For example, tax parameters like the standard deduction are often indexed to price inflation. So, the value of the standard deduction actually increases every year by 1 or 2% depending on that year’s inflation rate.</p>
<p>The <a class="reference internal" href="extend.html"><span class="doc std std-doc">extend documentation</span></a> may be useful for gaining a better understanding of how ParamTools extends parameter values along <code class="docutils literal notranslate"><span class="pre">label_to_extend</span></code>.</p>
<p>To use the indexing feature:</p>
<ul class="simple">
<li><p>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></li>
<li><p>Set the <code class="docutils literal notranslate"><span class="pre">indexing_rates</span></code> class attribute to a dictionary of inflation rates where the keys correspond to the value of <code class="docutils literal notranslate"><span class="pre">label_to_extend</span></code> and the values are the indexing rates.</p></li>
<li><p>Set the <code class="docutils literal notranslate"><span class="pre">uses_extend_func</span></code> class attribute to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
<li><p>In <code class="docutils literal notranslate"><span class="pre">defaults</span></code> or <code class="docutils literal notranslate"><span class="pre">defaults.json</span></code>, set <code class="docutils literal notranslate"><span class="pre">indexed</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code> for each parameter that needs to be indexed.</p></li>
</ul>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>This is a continuation of the tax parameters example from the <a class="reference internal" href="extend.html"><span class="doc std std-doc">extend documentation</span></a>. The differences are <code class="docutils literal notranslate"><span class="pre">indexed</span></code> is set to <code class="docutils literal notranslate"><span class="pre">True</span></code> for the <code class="docutils literal notranslate"><span class="pre">standard_deducation</span></code> parameter, <code class="docutils literal notranslate"><span class="pre">uses_extend_func</span></code> is set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, and <code class="docutils literal notranslate"><span class="pre">index_rates</span></code> is specified with inflation rates obtained from the open-source tax modeling package, <a class="reference external" href="https://github.com/PSLmodels/Tax-Calculator/">Tax-Calculator</a>, using version 2.5.0.</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="c1"># Set indexed to True to extend standard_deduction with the built-in</span>
<span class="c1"># extension logic.</span>
<span class="s2">"indexed"</span><span class="p">:</span> <span class="kc">True</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">array_first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">label_to_extend</span> <span class="o">=</span> <span class="s2">"year"</span>
<span class="c1"># Activate use of extend_func method.</span>
<span class="n">uses_extend_func</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># inflation rates from Tax-Calculator v2.5.0</span>
<span class="n">index_rates</span> <span class="o">=</span> <span class="p">{</span>
<span class="mi">2013</span><span class="p">:</span> <span class="mf">0.0148</span><span class="p">,</span>
<span class="mi">2014</span><span class="p">:</span> <span class="mf">0.0159</span><span class="p">,</span>
<span class="mi">2015</span><span class="p">:</span> <span class="mf">0.0012</span><span class="p">,</span>
<span class="mi">2016</span><span class="p">:</span> <span class="mf">0.0127</span><span class="p">,</span>
<span class="mi">2017</span><span class="p">:</span> <span class="mf">0.0187</span><span class="p">,</span>
<span class="mi">2018</span><span class="p">:</span> <span class="mf">0.0224</span><span class="p">,</span>
<span class="mi">2019</span><span class="p">:</span> <span class="mf">0.0186</span><span class="p">,</span>
<span class="mi">2020</span><span class="p">:</span> <span class="mf">0.0233</span><span class="p">,</span>
<span class="mi">2021</span><span class="p">:</span> <span class="mf">0.0229</span><span class="p">,</span>
<span class="mi">2022</span><span class="p">:</span> <span class="mf">0.0228</span><span class="p">,</span>
<span class="mi">2023</span><span class="p">:</span> <span class="mf">0.0221</span><span class="p">,</span>
<span class="mi">2024</span><span class="p">:</span> <span class="mf">0.0211</span><span class="p">,</span>
<span class="mi">2025</span><span class="p">:</span> <span class="mf">0.0209</span><span class="p">,</span>
<span class="mi">2026</span><span class="p">:</span> <span class="mf">0.0211</span><span class="p">,</span>
<span class="mi">2027</span><span class="p">:</span> <span class="mf">0.0208</span><span class="p">,</span>
<span class="mi">2028</span><span class="p">:</span> <span class="mf">0.021</span><span class="p">,</span>
<span class="mi">2029</span><span class="p">:</span> <span class="mf">0.021</span>
<span class="p">}</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([[ 6074.92, 12149.84],
[ 6164.83, 12329.66],
[ 6262.85, 12525.7 ],
[ 6270.37, 12540.73],
[ 6350. , 12700. ],
[12000. , 24000. ],
[12268.8 , 24537.6 ],
[12497. , 24994. ],
[12788.18, 25576.36],
[13081.03, 26162.06],
[13379.28, 26758.55],
[13674.96, 27349.91],
[13963.5 , 27926.99],
[ 7685. , 15369. ],
[ 7847.15, 15693.29]])
</pre></div>
</div>
</div>
</div>
<p>Adjustments are also indexed. 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([[ 6074.92, 12149.84],
[ 6164.83, 12329.66],
[ 6262.85, 12525.7 ],
[ 6270.37, 12540.73],
[10000. , 10000. ],
[10187. , 10187. ],
[10415.19, 10415.19],
[15000. , 10608.91],
[15349.5 , 20000. ],
[15701. , 20458. ],
[16058.98, 20924.44],
[16413.88, 21386.87],
[16760.21, 21838.13],
[17110.5 , 22294.55],
[17471.53, 22764.97]])
</pre></div>
</div>
</div>
</div>
<p>All values that are added automatically via the <code class="docutils literal notranslate"><span class="pre">extend</span></code> method are given an <code class="docutils literal notranslate"><span class="pre">_auto</span></code> attribute. You can select them like this:</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">select_eq</span><span class="p">(</span>
<span class="s2">"standard_deduction"</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">_auto</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</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>[OrderedDict([('year', 2013),
('marital_status', 'single'),
('value', 6074.92),
('_auto', True)]),
OrderedDict([('year', 2014),
('marital_status', 'single'),
('value', 6164.83),
('_auto', True)]),
OrderedDict([('year', 2015),
('marital_status', 'single'),
('value', 6262.85),
('_auto', True)]),
OrderedDict([('year', 2016),
('marital_status', 'single'),
('value', 6270.37),
('_auto', True)]),
OrderedDict([('year', 2019),
('marital_status', 'single'),
('value', 12268.8),
('_auto', True)]),
OrderedDict([('year', 2020),
('marital_status', 'single'),
('value', 12497.0),
('_auto', True)]),
OrderedDict([('year', 2021),
('marital_status', 'single'),
('value', 12788.18),
('_auto', True)]),
OrderedDict([('year', 2022),
('marital_status', 'single'),
('value', 13081.03),
('_auto', True)]),
OrderedDict([('year', 2023),
('marital_status', 'single'),
('value', 13379.28),
('_auto', True)]),
OrderedDict([('year', 2024),
('marital_status', 'single'),
('value', 13674.96),
('_auto', True)]),
OrderedDict([('year', 2025),
('marital_status', 'single'),
('value', 13963.5),
('_auto', True)]),
OrderedDict([('year', 2027),
('marital_status', 'single'),
('value', 7847.15),
('_auto', True)]),
OrderedDict([('year', 2013),
('marital_status', 'joint'),
('value', 12149.84),
('_auto', True)]),
OrderedDict([('year', 2014),
('marital_status', 'joint'),
('value', 12329.66),
('_auto', True)]),
OrderedDict([('year', 2015),
('marital_status', 'joint'),
('value', 12525.7),
('_auto', True)]),
OrderedDict([('year', 2016),
('marital_status', 'joint'),
('value', 12540.73),
('_auto', True)]),
OrderedDict([('year', 2019),
('marital_status', 'joint'),
('value', 24537.6),
('_auto', True)]),
OrderedDict([('year', 2020),
('marital_status', 'joint'),
('value', 24994.0),
('_auto', True)]),
OrderedDict([('year', 2021),
('marital_status', 'joint'),
('value', 25576.36),
('_auto', True)]),
OrderedDict([('year', 2022),
('marital_status', 'joint'),
('value', 26162.06),
('_auto', True)]),
OrderedDict([('year', 2023),
('marital_status', 'joint'),
('value', 26758.55),
('_auto', True)]),
OrderedDict([('year', 2024),
('marital_status', 'joint'),
('value', 27349.91),
('_auto', True)]),
OrderedDict([('year', 2025),
('marital_status', 'joint'),
('value', 27926.99),
('_auto', True)]),
OrderedDict([('year', 2027),
('marital_status', 'joint'),
('value', 15693.29),
('_auto', True)])]
</pre></div>
</div>
</div>
</div>
<p>If you want to update the index rates and apply them to your existing values, then all you need to do is remove the values that were added automatically. ParamTools will fill in the missing values using the updated index rates:</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">offset</span> <span class="o">=</span> <span class="mf">0.0025</span>
<span class="k">for</span> <span class="n">year</span><span class="p">,</span> <span class="n">rate</span> <span class="ow">in</span> <span class="n">params</span><span class="o">.</span><span class="n">index_rates</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">params</span><span class="o">.</span><span class="n">index_rates</span><span class="p">[</span><span class="n">year</span><span class="p">]</span> <span class="o">=</span> <span class="n">rate</span> <span class="o">+</span> <span class="n">offset</span>
<span class="n">automatically_added</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">select_eq</span><span class="p">(</span>
<span class="s2">"standard_deduction"</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">_auto</span><span class="o">=</span><span class="kc">True</span>
<span class="p">)</span>
<span class="n">params</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
<span class="p">{</span>
<span class="s2">"standard_deduction"</span><span class="p">:</span> <span class="n">automatically_added</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([[ 6015.22, 12030.41],
[ 6119.28, 12238.54],
[ 6231.87, 12463.73],
[ 6254.93, 12509.85],
[ 6350. , 12700. ],
[12000. , 24000. ],
[12298.8 , 24597.6 ],
[12558.3 , 25116.61],
[12882.3 , 25764.62],
[13209.51, 26419.04],
[13543.71, 27087.44],
[13876.89, 27753.79],
[14204.38, 28408.78],
[ 7685. , 15369. ],
[ 7866.37, 15731.71]])
</pre></div>
</div>
</div>
</div>
<section id="code-for-getting-tax-calculator-index-rates">
<h3>Code for getting Tax-Calculator index rates<a class="headerlink" href="#code-for-getting-tax-calculator-index-rates" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">taxcalc</span>
<span class="n">pol</span> <span class="o">=</span> <span class="n">taxcalc</span><span class="o">.</span><span class="n">Policy</span><span class="p">()</span>
<span class="n">index_rates</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">year</span><span class="p">:</span> <span class="n">value</span>
<span class="k">for</span> <span class="n">year</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">2013</span><span class="p">,</span> <span class="mi">2029</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)),</span> <span class="n">pol</span><span class="o">.</span><span class="n">inflation_rates</span><span class="p">())</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Note that there are some subtle details that are implemented in Tax-Calculator’s indexing logic that are not implemented in this example. Tax-Calculator has a parameter called <code class="docutils literal notranslate"><span class="pre">CPI_offset</span></code> that adjusts inflation rates up or down by a fixed amount. The <code class="docutils literal notranslate"><span class="pre">indexed</span></code> property can also be turned on and off for each parameter. Implementing these nuanced features is left as the proverbial “trivial exercise to the reader.”</p>
</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="extend.html" title="previous page">Extend</a>
<a class='right-next' id="next-link" href="custom-adjust.html" title="next page">Custom Adjustments</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>