Add Local Housing Allowance parameters (#787)

* Add missing label for benefit uprating index * Add LHA * Add BRMA imputation * Address comments * Add to README.md * Fix test failures * Comment out label test for now * Remove old LHA parameter tree
PolicyEngine · Nov 26, 2023 · 2f9e7f3 · 2f9e7f3
1 parent dbf5a73
commit 2f9e7f3
Show file tree

Hide file tree

Showing 18 changed files with 394 additions and 5,617 deletions.
diff --git a/changelog_entry.yaml b/changelog_entry.yaml
@@ -0,0 +1,4 @@
+- bump: patch
+  changes:
+    fixed:
+    - Added missing label for benefit uprating.
diff --git a/policyengine_uk/data/gov/README.md b/policyengine_uk/data/gov/README.md
@@ -0,0 +1,11 @@
+# Data
+
+This folder contains data files used in policy computations that are too granular for YAML parameters to be efficient.
+
+## brma_to_region.csv.gz
+
+This mapping file is used to convert BRMA codes to region codes. It was created by GPT-4 (20 randomly checked and all correct) for English BRMAs; Scottish, Welsh and Northern Ireland BRMAs were added manually.
+
+## local_housing_allowance_list_of_rents.csv.gz
+
+This file contains the list of rents used to determine LHA rates. English BRMAs for 2019 and 2020 are from the Valuation Office Agency [here](https://www.gov.uk/government/collections/local-housing-allowance-list-of-rents). Scottish, Welsh and Northern Ireland BRMAs are matched from the closest English BRMA.
diff --git a/policyengine_uk/data/gov/__init__.py b/policyengine_uk/data/gov/__init__.py
@@ -0,0 +1,17 @@
+import pandas as pd
+from pathlib import Path
+
+FOLDER = Path(__file__).parent
+
+lha_list_of_rents = pd.read_csv(
+    FOLDER / "local_housing_allowance_list_of_rents.csv.gz",
+    compression="gzip",
+)
+
+brma_to_region = pd.read_csv(
+    FOLDER / "brma_to_region.csv.gz", compression="gzip"
+)
+
+enhanced_frs_brmas = pd.read_csv(
+    FOLDER / "enhanced_frs_brmas.csv.gz", compression="gzip"
+)
diff --git a/policyengine_uk/data/gov/brma_to_region.csv.gz b/policyengine_uk/data/gov/brma_to_region.csv.gz
diff --git a/policyengine_uk/data/gov/enhanced_frs_brmas.csv.gz b/policyengine_uk/data/gov/enhanced_frs_brmas.csv.gz
diff --git a/policyengine_uk/data/gov/local_housing_allowance_list_of_rents.csv.gz b/policyengine_uk/data/gov/local_housing_allowance_list_of_rents.csv.gz
diff --git a/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml b/policyengine_uk/parameters/gov/benefit_uprating_cpi.yaml
@@ -1,4 +1,4 @@
-description: September CPI
+description: Most recent September CPIH index value, updated for each uprating occurrence.
 values:
   2024-01-01: 132.0
   2023-04-01: 123.8
@@ -25,5 +25,4 @@ values:
   2002-04-01: 75.0
   2001-04-01: 73.8
 metadata:
-  unit: currency-GBP
   label: Benefit uprating index
diff --git a/policyengine_uk/parameters/gov/dwp/LHA/freeze.yaml b/policyengine_uk/parameters/gov/dwp/LHA/freeze.yaml
@@ -0,0 +1,8 @@
+description: While this parameter is true, LHA rates are frozen in cash terms.
+values:
+  2015-01-01: false
+  2020-01-01: true
+  2024-01-01: false
+metadata:
+  unit: bool
+  label: LHA freeze
diff --git a/policyengine_uk/parameters/gov/dwp/LHA/percentile.yaml b/policyengine_uk/parameters/gov/dwp/LHA/percentile.yaml
@@ -0,0 +1,6 @@
+description: Local Housing Allowance rates are set at this percentile of private rents in the family's Broad Rental Market Area. This parameter does not apply if LHA is frozen.
+values:
+  2015-01-01: 0.3
+metadata:
+  unit: /1
+  label: LHA percentile