Rename WIDOW to SURVIVING_SPOUSE filing status (PolicyEngine#4130)

* updates * updates * Rename `WIDOW` to `SURVIVING_SPOUSE` filing status Fixes PolicyEngine#4094 * updates to 'hi' * updates * updates * updates * Co-authored-by: Pavel Makarchuk <[email protected]> * updates * fixed errors * revert some changes * revert minor * Update policyengine_us/variables/household/demographic/tax_unit/filing_status.py --------- Co-authored-by: PavelMakarchuk <[email protected]> Co-authored-by: Max Ghenis <[email protected]>
daphnehanse11 · Apr 2, 2024 · 1dc9003 · 1dc9003
1 parent dbe2554
commit 1dc9003
Show file tree

Hide file tree

Showing 396 changed files with 648 additions and 506 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -143,11 +143,11 @@ One common breakdown is to break down by **`filing_status`**. If you decided to
 
 * `SINGLE`
 * `SEPARATE`
-* `WIDOW`
+* `SURVIVING_SPOUSE`
 * `HEAD_OF_HOUSEHOLD`
 * `JOINT`
 
-Sometimes, the document that you refer to (e.g. tax instruction) does not specify all five statuses. In that case, you can let the `WIDOW` cases to be the same as the `JOINT` case.
+Sometimes, the document that you refer to (e.g. tax instruction) does not specify all five statuses. In that case, you can let the `SURVIVING_SPOUSE` cases to be the same as the `JOINT` case.
 
 PolicyEngine defines parameters as yaml files, which specify the values as of certain dates, as well as metadata on the units and reference(s).
 

diff --git a/changelog_entry.yaml b/changelog_entry.yaml
@@ -0,0 +1,4 @@
+- bump: minor
+  changes:
+    added:
+    - Rename widow to surviving spouse.
diff --git a/policyengine_us/data/datasets/cps/enhanced_cps/loss.py b/policyengine_us/data/datasets/cps/enhanced_cps/loss.py
@@ -306,7 +306,9 @@ def generate_model_variables(
     # Tax return counts by filing status
 
     filing_status = (
-        simulation.calculate("filing_status").replace("WIDOW", "JOINT").values
+        simulation.calculate("filing_status")
+        .replace("SURVIVING_SPOUSE", "JOINT")
+        .values
     )
     for filing_status_value in [
         "SINGLE",

diff --git a/...e_us/parameters/gov/contrib/congress/tlaib/end_child_poverty_act/filer_credit/amount.yaml b/...e_us/parameters/gov/contrib/congress/tlaib/end_child_poverty_act/filer_credit/amount.yaml
@@ -16,5 +16,5 @@ SEPARATE:
   2020-01-01: 0
 HEAD_OF_HOUSEHOLD:
   2020-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   2020-01-01: 0
diff --git a/...meters/gov/contrib/congress/tlaib/end_child_poverty_act/filer_credit/phase_out/start.yaml b/...meters/gov/contrib/congress/tlaib/end_child_poverty_act/filer_credit/phase_out/start.yaml
@@ -16,5 +16,5 @@ SEPARATE:
   2020-01-01: 0
 HEAD_OF_HOUSEHOLD:
   2020-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   2020-01-01: 0
diff --git a/policyengine_us/parameters/gov/contrib/congress/wftca/bonus_guaranteed_deduction/amount.yaml b/policyengine_us/parameters/gov/contrib/congress/wftca/bonus_guaranteed_deduction/amount.yaml
@@ -19,7 +19,7 @@ JOINT:
     2000-01-01: 0
   metadata:
     label: WFTCA joint filer amount
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2000-01-01: 0
   metadata:

diff --git a/...parameters/gov/contrib/congress/wftca/bonus_guaranteed_deduction/phase_out/threshold.yaml b/...parameters/gov/contrib/congress/wftca/bonus_guaranteed_deduction/phase_out/threshold.yaml
@@ -19,7 +19,7 @@ JOINT:
     2000-01-01: 0
   metadata:
     label: WFTCA joint filer phase-out threshold
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2000-01-01: 0
   metadata:

diff --git a/policyengine_us/parameters/gov/contrib/dc_kccatc/phase_out/threshold.yaml b/policyengine_us/parameters/gov/contrib/dc_kccatc/phase_out/threshold.yaml
@@ -7,7 +7,7 @@ SEPARATE:
   2000-01-01: 0
 HEAD_OF_HOUSEHOLD:
   2000-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   2000-01-01: 0
 metadata:
   breakdown: filing_status

diff --git a/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/agi_limit/amount.yaml b/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/agi_limit/amount.yaml
@@ -7,7 +7,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
 SEPARATE:
   0000-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
 metadata:
   unit: currency-USD

diff --git a/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/phase_out/end.yaml b/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/phase_out/end.yaml
@@ -7,7 +7,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
 SEPARATE:
   0000-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
 metadata:
   unit: currency-USD

diff --git a/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/phase_out/threshold.yaml b/policyengine_us/parameters/gov/contrib/ubi_center/basic_income/phase_out/threshold.yaml
@@ -7,7 +7,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
 SEPARATE:
   0000-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
 metadata:
   unit: currency-USD

diff --git a/policyengine_us/parameters/gov/irs/ald/loss/capital/max.yaml b/policyengine_us/parameters/gov/irs/ald/loss/capital/max.yaml
@@ -16,5 +16,5 @@ SEPARATE:
   2010-01-01: 1_500
 HEAD_OF_HOUSEHOLD:
   2010-01-01: 3_000
-WIDOW:
+SURVIVING_SPOUSE:
   2010-01-01: 3_000
diff --git a/policyengine_us/parameters/gov/irs/ald/loss/max.yaml b/policyengine_us/parameters/gov/irs/ald/loss/max.yaml
@@ -62,7 +62,7 @@ SINGLE:
     2023-01-01: 289_000
     2024-01-01: 305_000
     2027-01-01: .inf
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2013-01-01: .inf
     2018-01-01: 500_000

diff --git a/policyengine_us/parameters/gov/irs/ald/misc/max_business_losses.yaml b/policyengine_us/parameters/gov/irs/ald/misc/max_business_losses.yaml
@@ -29,7 +29,7 @@ SINGLE:
     2019-01-01: 255_000.0
     2026-01-01: 283_535.22
     2027-01-01: .inf
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2013-01-01: .inf
     2018-01-01: 500_000.0

diff --git a/policyengine_us/parameters/gov/irs/capital_gains/brackets.yaml b/policyengine_us/parameters/gov/irs/capital_gains/brackets.yaml
@@ -88,7 +88,7 @@ thresholds:
         2022-01-01: 41_675
         2023-01-01: 44_625
         2024-01-01: 47_025
-    WIDOW:
+    SURVIVING_SPOUSE:
       values:
         2013-01-01: 72_500
         2014-01-01: 73_800
@@ -159,7 +159,7 @@ thresholds:
         2022-01-01: 459_750
         2023-01-01: 492_300
         2024-01-01: 518_900
-    WIDOW:
+    SURVIVING_SPOUSE:
       values:
         2013-01-01: 450_000
         2014-01-01: 457_600

diff --git a/policyengine_us/parameters/gov/irs/capital_gains/loss_limit.yaml b/policyengine_us/parameters/gov/irs/capital_gains/loss_limit.yaml
@@ -12,5 +12,5 @@ SEPARATE:
   2013-01-01: 1_500
 SINGLE:
   2013-01-01: 3_000
-WIDOW:
+SURVIVING_SPOUSE:
   2013-01-01: 3_000
diff --git a/policyengine_us/parameters/gov/irs/credits/clean_vehicle/new/eligibility/income_limit.yaml b/policyengine_us/parameters/gov/irs/credits/clean_vehicle/new/eligibility/income_limit.yaml
@@ -12,7 +12,7 @@ metadata:
 JOINT:
   0000-01-01: .inf
   2023-01-01: 300_000
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: .inf
   2023-01-01: 300_000
 HEAD_OF_HOUSEHOLD:

diff --git a/policyengine_us/parameters/gov/irs/credits/clean_vehicle/used/eligibility/income_limit.yaml b/policyengine_us/parameters/gov/irs/credits/clean_vehicle/used/eligibility/income_limit.yaml
@@ -12,7 +12,7 @@ metadata:
 JOINT:
   0000-01-01: .inf
   2023-01-01: 150_000
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: .inf
   2023-01-01: 150_000
 HEAD_OF_HOUSEHOLD:

diff --git a/policyengine_us/parameters/gov/irs/credits/ctc/phase_out/arpa/threshold.yaml b/policyengine_us/parameters/gov/irs/credits/ctc/phase_out/arpa/threshold.yaml
@@ -7,7 +7,7 @@ SEPARATE:
   0000-01-01: 75_000
 HEAD_OF_HOUSEHOLD:
   0000-01-01: 112_500
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 150_000
 metadata:
   unit: currency-USD

diff --git a/policyengine_us/parameters/gov/irs/credits/ctc/phase_out/threshold.yaml b/policyengine_us/parameters/gov/irs/credits/ctc/phase_out/threshold.yaml
@@ -15,7 +15,7 @@ HEAD_OF_HOUSEHOLD:
   2013-01-01: 75_000
   2018-01-01: 200_000
   2026-01-01: 75_000
-WIDOW:
+SURVIVING_SPOUSE:
   2013-01-01: 75_000
   2018-01-01: 400_000
   2026-01-01: 75_000

diff --git a/policyengine_us/parameters/gov/irs/credits/elderly_or_disabled/phase_out.yaml b/policyengine_us/parameters/gov/irs/credits/elderly_or_disabled/phase_out.yaml
@@ -12,7 +12,7 @@ threshold:
   HEAD_OF_HOUSEHOLD:
     values:
       2010-01-01: 7_500
-  WIDOW:
+  SURVIVING_SPOUSE:
     values:
       2010-01-01: 7_500
   metadata:

diff --git a/policyengine_us/parameters/gov/irs/credits/recovery_rebate_credit/arpa/phase_out/length.yaml b/policyengine_us/parameters/gov/irs/credits/recovery_rebate_credit/arpa/phase_out/length.yaml
@@ -5,7 +5,7 @@ JOINT:
   0000-01-01: 10_000
 HEAD_OF_HOUSEHOLD:
   0000-01-01: 7_500
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 5_000
 SEPARATE:
   0000-01-01: 5_000

diff --git a/...engine_us/parameters/gov/irs/credits/recovery_rebate_credit/arpa/phase_out/threshold.yaml b/...engine_us/parameters/gov/irs/credits/recovery_rebate_credit/arpa/phase_out/threshold.yaml
@@ -11,7 +11,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
   2021-01-01: 112_500
   2022-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
   2021-01-01: 75_000
   2022-01-01: 0

diff --git a/...yengine_us/parameters/gov/irs/credits/recovery_rebate_credit/caa/phase_out/threshold.yaml b/...yengine_us/parameters/gov/irs/credits/recovery_rebate_credit/caa/phase_out/threshold.yaml
@@ -11,7 +11,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
   2020-01-01: 112_500
   2021-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
   2020-01-01: 75_000
   2021-01-01: 0

diff --git a/...ngine_us/parameters/gov/irs/credits/recovery_rebate_credit/cares/phase_out/threshold.yaml b/...ngine_us/parameters/gov/irs/credits/recovery_rebate_credit/cares/phase_out/threshold.yaml
@@ -11,7 +11,7 @@ HEAD_OF_HOUSEHOLD:
   0000-01-01: 0
   2020-01-01: 112_500
   2021-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   0000-01-01: 0
   2020-01-01: 75_000
   2021-01-01: 0

diff --git a/policyengine_us/parameters/gov/irs/deductions/itemized/interest/mortgage/cap.yaml b/policyengine_us/parameters/gov/irs/deductions/itemized/interest/mortgage/cap.yaml
@@ -7,7 +7,7 @@ SEPARATE:
   2018-01-01: 500_000
 HEAD_OF_HOUSEHOLD:
   2018-01-01: 1_000_000
-WIDOW:
+SURVIVING_SPOUSE:
   2018-01-01: 1_000_000
 metadata:
   breakdown: filing_status

diff --git a/policyengine_us/parameters/gov/irs/deductions/itemized/limitation/applicable_amount.yaml b/policyengine_us/parameters/gov/irs/deductions/itemized/limitation/applicable_amount.yaml
@@ -67,7 +67,7 @@ HEAD_OF_HOUSEHOLD:
   2032-01-01: 420_150
   2033-01-01: 428_550
   2034-01-01: 437_150
-WIDOW:
+SURVIVING_SPOUSE:
   2013-01-01: 300_000
   2014-01-01: 305_050
   2015-01-01: 309_900

diff --git a/policyengine_us/parameters/gov/irs/deductions/itemized/reduction/agi_threshold.yaml b/policyengine_us/parameters/gov/irs/deductions/itemized/reduction/agi_threshold.yaml
@@ -27,7 +27,7 @@ HEAD_OF_HOUSEHOLD:
   2015-01-01: 154_950
   2016-01-01: 155_650
   2017-01-01: 156_900
-WIDOW:
+SURVIVING_SPOUSE:
   2009-01-01: 166_800
   2013-01-01: 150_000
   2014-01-01: 152_525

diff --git a/policyengine_us/parameters/gov/irs/deductions/itemized/salt_and_real_estate/cap.yaml b/policyengine_us/parameters/gov/irs/deductions/itemized/salt_and_real_estate/cap.yaml
@@ -44,7 +44,7 @@ SINGLE:
     2018-01-01: 10_000
     2019-01-01: 10_000
     2026-01-01: .inf
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2013-01-01: .inf
     2014-01-01: .inf

diff --git a/policyengine_us/parameters/gov/irs/deductions/qbi/phase_out/length.yaml b/policyengine_us/parameters/gov/irs/deductions/qbi/phase_out/length.yaml
@@ -17,7 +17,7 @@ SINGLE:
   2013-01-01: 1.0
   2018-01-01: 50_000.0
   2026-01-01: 1.0
-WIDOW:
+SURVIVING_SPOUSE:
   2013-01-01: 1.0
   2018-01-01: 100_000.0
   2026-01-01: 1.0
diff --git a/policyengine_us/parameters/gov/irs/deductions/qbi/phase_out/start.yaml b/policyengine_us/parameters/gov/irs/deductions/qbi/phase_out/start.yaml
@@ -57,7 +57,7 @@ SINGLE:
   2023-01-01: 182_100
   2024-01-01: 191_950
   2026-01-01: 0
-WIDOW:
+SURVIVING_SPOUSE:
   2013-01-01: 0
   2018-01-01: 315_000
   2019-01-01: 321_400

diff --git a/policyengine_us/parameters/gov/irs/deductions/standard/aged_or_blind/amount.yaml b/policyengine_us/parameters/gov/irs/deductions/standard/aged_or_blind/amount.yaml
@@ -71,7 +71,7 @@ HEAD_OF_HOUSEHOLD:
   2025-08-01: 2_300
   2025-09-01: 2_350
   2025-10-01: 2_400
-WIDOW:
+SURVIVING_SPOUSE:
   2018-01-01: 1_300
   2019-01-01: 1_300
   2021-01-01: 1_350

diff --git a/policyengine_us/parameters/gov/irs/deductions/standard/amount.yaml b/policyengine_us/parameters/gov/irs/deductions/standard/amount.yaml
@@ -76,7 +76,7 @@ HEAD_OF_HOUSEHOLD:
   2032-01-01: 13_650
   2033-01-01: 13_950
   2034-01-01: 14_250
-WIDOW:
+SURVIVING_SPOUSE:
   2018-01-01: 24_000
   2019-01-01: 24_400
   2020-01-01: 24_400

diff --git a/.../parameters/gov/irs/gross_income/dependent_care_assistance_programs/reduction_amount.yaml b/.../parameters/gov/irs/gross_income/dependent_care_assistance_programs/reduction_amount.yaml
@@ -7,7 +7,7 @@ SEPARATE:
   2018-01-01: 2_500
 HEAD_OF_HOUSEHOLD:
   2018-01-01: 5_000
-WIDOW:
+SURVIVING_SPOUSE:
   2018-01-01: 5_000
 metadata:
   breakdown: filing_status

diff --git a/policyengine_us/parameters/gov/irs/income/amt/capital_gains/brackets.yaml b/policyengine_us/parameters/gov/irs/income/amt/capital_gains/brackets.yaml
@@ -87,7 +87,7 @@ thresholds:
         2022-01-01: 41_675
         2023-01-01: 44_625
         2024-01-01: 47_025
-    WIDOW:
+    SURVIVING_SPOUSE:
       values:
         2013-01-01: 72_500
         2014-01-01: 73_800
@@ -158,7 +158,7 @@ thresholds:
         2022-01-01: 459_750
         2023-01-01: 492_300
         2024-01-01: 518_900
-    WIDOW:
+    SURVIVING_SPOUSE:
       values:
         2013-01-01: 450_000
         2014-01-01: 457_600

diff --git a/policyengine_us/parameters/gov/irs/income/amt/exemption/amount.yaml b/policyengine_us/parameters/gov/irs/income/amt/exemption/amount.yaml
@@ -118,7 +118,7 @@ SINGLE:
     2032-01-01: 79_300
     2033-01-01: 80_900
     2034-01-01: 82_500
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2013-01-01: 80_800
     2014-01-01: 82_100

diff --git a/policyengine_us/parameters/gov/irs/income/amt/exemption/phase_out/start.yaml b/policyengine_us/parameters/gov/irs/income/amt/exemption/phase_out/start.yaml
@@ -122,7 +122,7 @@ SINGLE:
     2032-01-01: 176_300
     2033-01-01: 179_800
     2034-01-01: 183_400
-WIDOW:
+SURVIVING_SPOUSE:
   values:
     2013-01-01: 153_900
     2014-01-01: 156_500