Merge pull request #1427 from PolicyEngine/add-own-vehicle-variable

Add owns vehicle variable

Author: vahid-ahmadi

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: minor
+  changes:
+    added:
+    - Add owns vehicle variable

policyengine_uk/tests/policy/baseline/finance/benefit/family/child_benefit.yaml

@@ -26,6 +26,7 @@
     benunits:
       benunit:
         members: [parent1, parent2, child1]
+        would_claim_child_benefit: true
   output:
     child_benefit: 1098
 - name: Child Benefit with two children, one over 16
@@ -45,5 +46,6 @@
     benunits:
       benunit:
         members: [parent1, parent2, child1, child2]
+        would_claim_child_benefit: true
   output:
     child_benefit: 1825.20

policyengine_uk/tests/policy/baseline/gov/dcms/bbc/tv-licence/tv_licence.yaml

@@ -1,6 +1,7 @@
 - name: TV Licence full price - ineligible for aged or blind discount.
   period: 2023
   input:
+    household_owns_tv: true
     tv_licence_discount: 0
     would_evade_tv_licence_fee: false
   output:
@@ -9,6 +10,7 @@
 - name: TV Licence half price - eligible for blind discount but not aged.
   period: 2023
   input:
+    household_owns_tv: true
     tv_licence_discount: 0.5
     would_evade_tv_licence_fee: false
   output:
@@ -17,6 +19,7 @@
 - name: Free TV Licence - eligible for aged discount.
   period: 2023
   input:
+    household_owns_tv: true
     tv_licence_discount: 1
     would_evade_tv_licence_fee: false
   output:

policyengine_uk/tests/policy/baseline/household/wealth/vehicle.yaml

@@ -0,0 +1,27 @@
+- name: Household with no vehicles does not own a vehicle
+  period: 2024
+  input:
+    num_vehicles: 0
+  output:
+    owns_vehicle: false
+
+- name: Household with one vehicle owns a vehicle
+  period: 2024
+  input:
+    num_vehicles: 1
+  output:
+    owns_vehicle: true
+
+- name: Household with multiple vehicles owns a vehicle
+  period: 2024
+  input:
+    num_vehicles: 3
+  output:
+    owns_vehicle: true
+
+- name: Default num_vehicles is zero
+  period: 2024
+  input: {}
+  output:
+    num_vehicles: 0
+    owns_vehicle: false

policyengine_uk/tests/policy/reforms/parametric/basic_income/basic_income.yaml

@@ -21,6 +21,7 @@
     benunits:
       benunit:
         members: [working_age, senior, child]
+        would_claim_child_benefit: true
   output:
     basic_income: [52, 104, 156]
     child_benefit: 1820

policyengine_uk/variables/gov/hmrc/would_claim_child_benefit.py

@@ -11,8 +11,12 @@ class would_claim_child_benefit(Variable):
     value_type = bool
 
     def formula(benunit, period, parameters):
+        claims_all_entitled_benefits = benunit(
+            "claims_all_entitled_benefits", period
+        )
         takeup_rate = parameters(period).gov.hmrc.child_benefit.takeup
         overall_p = takeup_rate.overall
-        return (random(benunit) < overall_p) * ~benunit(
+        random_takeup = (random(benunit) < overall_p) & ~benunit(
             "child_benefit_opts_out", period
         )
+        return claims_all_entitled_benefits | random_takeup

policyengine_uk/variables/household/wealth/num_vehicles.py

@@ -0,0 +1,9 @@
+from policyengine_uk.model_api import *
+
+
+class num_vehicles(Variable):
+    label = "number of vehicles owned by the household"
+    documentation = "Imputed from WAS vcarnr7 variable"
+    entity = Household
+    definition_period = YEAR
+    value_type = int

policyengine_uk/variables/household/wealth/owns_vehicle.py

@@ -0,0 +1,17 @@
+from policyengine_uk.model_api import *
+
+
+class owns_vehicle(Variable):
+    label = "whether the household owns a vehicle"
+    documentation = (
+        "Used for calibration to NTS 2024 data "
+        "showing 78% of UK households own at least one car. "
+        "Source: https://www.gov.uk/government/statistics/national-travel-survey-2024"
+    )
+    reference = "https://www.gov.uk/government/statistics/national-travel-survey-2024/nts-2024-household-car-availability-and-trends-in-car-trips"
+    entity = Household
+    definition_period = YEAR
+    value_type = bool
+
+    def formula(household, period):
+        return household("num_vehicles", period) > 0