Fix alg2 (#206)

* Calculate values related to `arbeitsl_geld_2`, `wohngeld`, `kinderzuschlag`, `kindergeld` at appropriate level of aggregation (hh and/or tu).
* Several refactorings, corrected typos, and bugfixes

Co-authored-by: Hans-Martin von Gaudecker <[email protected]>

Author: MaxBlesch

CHANGES.rst

@@ -9,11 +9,13 @@ releases are available on `Anaconda.org <https://anaconda.org/gettsim/gettsim>`_
 0.3.2 - 2020-06-xx
 ------------------
 
-* :gh:`197` adds all functions which build the tax and transfer system to the
-  documentation (:ghuser:`tobiasraabe`).
+* :gh:`206` fixes several bugs in `arbeitsl_geld_2` and related transfers, calculating
+  them at the appropriate (household) level (:ghuser:`MaxBlesch`).
+* :gh:`202` fixes bugs that surfaced for negative incomes (:ghuser:`MaxBlesch`).
 * :gh:`200` adds a debug mode to gettsim and documents the feature
   (:ghuser:`tobiasraabe`).
-* :gh:`202` fixes bugs that surfaced for negative incomes (:ghuser:`MaxBlesch`).
+* :gh:`197` adds all functions which build the tax and transfer system to the
+  documentation (:ghuser:`tobiasraabe`).
 * :gh:`196` adds docstring to `policy_for_date.py` and improves its interface
   (:ghuser:`MaxBlesch`).
 

gettsim/benefits/arbeitsl_geld_2/arbeitsl_geld_2.py

@@ -1,26 +1,44 @@
 import numpy as np
 
 
-def regelbedarf_m(regelsatz_m, kost_unterk_m):
+def arbeitsl_geld_2_m_hh(
+    arbeitsl_geld_2_m_minus_eink_hh,
+    wohngeld_vorrang_hh,
+    kinderzuschlag_vorrang_hh,
+    wohngeld_kinderzuschlag_vorrang_hh,
+    rentner_in_hh,
+):
+    out = arbeitsl_geld_2_m_minus_eink_hh.clip(lower=0)
+    cond = (
+        wohngeld_vorrang_hh
+        | kinderzuschlag_vorrang_hh
+        | wohngeld_kinderzuschlag_vorrang_hh
+        | rentner_in_hh
+    )
+    out.loc[cond] = 0
+    return out
+
+
+def regelbedarf_m_hh(regelsatz_m_hh, kost_unterk_m_hh):
     """Basic monthly subsistence level, including cost of dwelling.
 
     Parameters
     ----------
-    regelsatz_m
-    kost_unterk_m
+    regelsatz_m_hh
+    kost_unterk_m_hh
 
     Returns
     -------
 
     """
-    return regelsatz_m + kost_unterk_m
+    return regelsatz_m_hh + kost_unterk_m_hh
 
 
-def alleinerziehenden_mehrbedarf(
-    alleinerziehend,
+def alleinerziehenden_mehrbedarf_hh(
+    alleinerziehend_hh,
     anz_kinder_hh,
-    anz_kind_zwischen_0_6_per_hh,
-    anz_kind_zwischen_0_15_per_hh,
+    anz_kind_zwischen_0_6_hh,
+    anz_kind_zwischen_0_15_hh,
     arbeitsl_geld_2_params,
 ):
     """Compute alleinerziehenden_mehrbedarf.
@@ -32,16 +50,17 @@ def alleinerziehenden_mehrbedarf(
     """
     lower = arbeitsl_geld_2_params["mehrbedarf_anteil"]["min_1_kind"] * anz_kinder_hh
     value = (
-        (anz_kind_zwischen_0_6_per_hh >= 1)
-        | ((2 <= anz_kind_zwischen_0_15_per_hh) & (anz_kind_zwischen_0_15_per_hh <= 3))
+        (anz_kind_zwischen_0_6_hh >= 1)
+        | ((2 <= anz_kind_zwischen_0_15_hh) & (anz_kind_zwischen_0_15_hh <= 3))
     ) * arbeitsl_geld_2_params["mehrbedarf_anteil"]["kind_unter_7_oder_mehr"]
 
-    return alleinerziehend * value.clip(
+    out = alleinerziehend_hh * value.clip(
         lower=lower, upper=arbeitsl_geld_2_params["mehrbedarf_anteil"]["max"]
     )
+    return out
 
 
-def kindersatz_m_bis_2010(
+def kindersatz_m_hh_bis_2010(
     hh_id,
     kind_zwischen_0_6,
     kind_zwischen_7_13,
@@ -56,10 +75,10 @@ def kindersatz_m_bis_2010(
         + anteile["kinder_14_24"] * kind_zwischen_14_24
     )
 
-    return per_child.groupby(hh_id).transform("sum")
+    return per_child.groupby(hh_id).sum()
 
 
-def kindersatz_m_ab_2011(
+def kindersatz_m_hh_ab_2011(
     hh_id,
     kind_zwischen_0_6,
     kind_zwischen_7_13,
@@ -72,48 +91,44 @@ def kindersatz_m_ab_2011(
         + arbeitsl_geld_2_params["regelsatz"][4] * kind_zwischen_14_24
     )
 
-    return per_child.groupby(hh_id).transform("sum")
+    return per_child.groupby(hh_id).sum()
 
 
-def regelsatz_m_bis_2010(
-    hh_id,
+def regelsatz_m_hh_bis_2010(
     anz_erwachsene_hh,
-    alleinerziehenden_mehrbedarf,
-    kindersatz_m,
+    alleinerziehenden_mehrbedarf_hh,
+    kindersatz_m_hh,
     arbeitsl_geld_2_params,
 ):
-    anz_erwachsene_in_hh = hh_id.replace(anz_erwachsene_hh)
     data = np.where(
-        anz_erwachsene_in_hh == 1,
-        arbeitsl_geld_2_params["regelsatz"] * (1 + alleinerziehenden_mehrbedarf),
+        anz_erwachsene_hh == 1,
+        arbeitsl_geld_2_params["regelsatz"] * (1 + alleinerziehenden_mehrbedarf_hh),
         arbeitsl_geld_2_params["regelsatz"]
         * (
-            (2 + alleinerziehenden_mehrbedarf)
+            (2 + alleinerziehenden_mehrbedarf_hh)
             * arbeitsl_geld_2_params["anteil_regelsatz"]["zwei_erwachsene"]
-            + (anz_erwachsene_in_hh - 2).clip(lower=0)
+            + (anz_erwachsene_hh - 2).clip(lower=0)
             * arbeitsl_geld_2_params["anteil_regelsatz"]["weitere_erwachsene"]
         ),
     )
 
-    return kindersatz_m + data
+    return kindersatz_m_hh + data
 
 
-def regelsatz_m_ab_2011(
-    hh_id,
+def regelsatz_m_hh_ab_2011(
     anz_erwachsene_hh,
-    alleinerziehenden_mehrbedarf,
-    kindersatz_m,
+    alleinerziehenden_mehrbedarf_hh,
+    kindersatz_m_hh,
     arbeitsl_geld_2_params,
 ):
-    anz_erwachsene_in_hh = hh_id.replace(anz_erwachsene_hh)
     data = np.where(
-        anz_erwachsene_in_hh == 1,
-        arbeitsl_geld_2_params["regelsatz"][1] * (1 + alleinerziehenden_mehrbedarf),
-        arbeitsl_geld_2_params["regelsatz"][2] * (2 + alleinerziehenden_mehrbedarf)
+        anz_erwachsene_hh == 1,
+        arbeitsl_geld_2_params["regelsatz"][1] * (1 + alleinerziehenden_mehrbedarf_hh),
+        arbeitsl_geld_2_params["regelsatz"][2] * (2 + alleinerziehenden_mehrbedarf_hh)
         + (
             arbeitsl_geld_2_params["regelsatz"][3]
-            * (anz_erwachsene_in_hh - 2).clip(lower=0)
+            * (anz_erwachsene_hh - 2).clip(lower=0)
         ),
     )
 
-    return kindersatz_m + data
+    return kindersatz_m_hh + data

gettsim/benefits/arbeitsl_geld_2/kost_unterk.py

@@ -1,57 +1,54 @@
-def kost_unterk_m(_berechtigte_wohnfläche, _miete_pro_sqm):
-    """
-    Only 'appropriate' housing costs are paid. Two possible options:
-    1. Just pay rents no matter what
-    return household["miete"] + household["heizkost"]
-    2. Add restrictions regarding flat size and rent per square meter (set it 10€,
-    slightly above average)
+def kost_unterk_m_hh(berechtigte_wohnfläche_hh, miete_pro_qm_hh):
+    """Justified costs of living.
 
     Parameters
     ----------
-    _berechtigte_wohnfläche
-    _miete_pro_sqm
+    berechtigte_wohnfläche_hh
+    miete_pro_qm_hh
 
     Returns
     -------
 
     """
-    return _berechtigte_wohnfläche * _miete_pro_sqm
+    return berechtigte_wohnfläche_hh * miete_pro_qm_hh
 
 
-def _miete_pro_sqm(kaltmiete_m, heizkost_m, wohnfläche):
+def miete_pro_qm_hh(kaltmiete_m_hh, heizkosten_m_hh, wohnfläche_hh):
     """
 
     Parameters
     ----------
-    kaltmiete_m
-    heizkost_m
-    wohnfläche
+    kaltmiete_m_hh
+    heizkosten_m_hh
+    wohnfläche_hh
 
     Returns
     -------
 
     """
-    return ((kaltmiete_m + heizkost_m) / wohnfläche).clip(upper=10)
+    return ((kaltmiete_m_hh + heizkosten_m_hh) / wohnfläche_hh).clip(upper=10)
 
 
-def _berechtigte_wohnfläche(wohnfläche, bewohnt_eigentum, haushaltsgröße):
+def berechtigte_wohnfläche_hh(wohnfläche_hh, bewohnt_eigentum_hh, haushaltsgröße_hh):
     """
 
     Parameters
     ----------
-    wohnfläche
-    bewohnt_eigentum
-    haushaltsgröße
+    wohnfläche_hh
+    bewohnt_eigentum_hh
+    haushaltsgröße_hh
 
     Returns
     -------
 
     """
-    out = wohnfläche * 0
-    out.loc[bewohnt_eigentum] = wohnfläche.loc[bewohnt_eigentum].clip(
-        upper=(80 + (haushaltsgröße.loc[bewohnt_eigentum] - 2).clip(lower=0) * 20)
+    out = wohnfläche_hh * 0
+    out.loc[bewohnt_eigentum_hh] = wohnfläche_hh.loc[bewohnt_eigentum_hh].clip(
+        upper=(80 + (haushaltsgröße_hh.loc[bewohnt_eigentum_hh] - 2).clip(lower=0) * 20)
     )
-    out.loc[~bewohnt_eigentum] = wohnfläche.loc[~bewohnt_eigentum].clip(
-        upper=(45 + (haushaltsgröße.loc[~bewohnt_eigentum] - 1).clip(lower=0) * 15)
+    out.loc[~bewohnt_eigentum_hh] = wohnfläche_hh.loc[~bewohnt_eigentum_hh].clip(
+        upper=(
+            45 + (haushaltsgröße_hh.loc[~bewohnt_eigentum_hh] - 1).clip(lower=0) * 15
+        )
     )
     return out

gettsim/benefits/benefit_checks/benefit_checks.py

@@ -1,43 +1,44 @@
-def arbeitsl_geld_2_m(
-    arbeitsl_geld_2_m_basis,
-    wohngeld_m_vorrang,
-    kinderzuschlag_vorrang,
-    wohngeld_m_kinderzuschlag_vorrang,
-    anz_rentner_per_hh,
+def arbeitsl_geld_2_m_minus_eink_hh(
+    _regelbedarf_m_vermögens_check_hh,
+    kindergeld_m_hh,
+    unterhaltsvors_m_hh,
+    arbeitsl_geld_2_eink_hh,
 ):
-    cond = (
-        wohngeld_m_vorrang | kinderzuschlag_vorrang | wohngeld_m_kinderzuschlag_vorrang
+    out = (
+        _regelbedarf_m_vermögens_check_hh
+        - arbeitsl_geld_2_eink_hh
+        - unterhaltsvors_m_hh
+        - kindergeld_m_hh
     )
-    return arbeitsl_geld_2_m_basis.where(~cond & (anz_rentner_per_hh == 0), 0)
+    return out
 
 
-def wohngeld_m(
-    _wohngeld_basis_hh_vermögens_check,
-    wohngeld_m_vorrang,
-    wohngeld_m_kinderzuschlag_vorrang,
-    arbeitsl_geld_2_m_basis,
-    anz_rentner_per_hh,
+def wohngeld_vorrang_hh(
+    wohngeld_vermögens_check_hh, arbeitsl_geld_2_m_minus_eink_hh,
 ):
-    cond = (
-        ~wohngeld_m_vorrang
-        & ~wohngeld_m_kinderzuschlag_vorrang
-        & (arbeitsl_geld_2_m_basis > 0)
-    )
-    return _wohngeld_basis_hh_vermögens_check.where(
-        ~cond & (anz_rentner_per_hh == 0), 0
-    )
+    rest_arbeitsl_geld_2 = (
+        arbeitsl_geld_2_m_minus_eink_hh - wohngeld_vermögens_check_hh
+    ).clip(lower=0)
+    return (rest_arbeitsl_geld_2 == 0) & (arbeitsl_geld_2_m_minus_eink_hh > 0)
 
 
-def kinderzuschlag_m(
-    _kinderzuschlag_m_vermögens_check,
-    kinderzuschlag_vorrang,
-    wohngeld_m_kinderzuschlag_vorrang,
-    arbeitsl_geld_2_m_basis,
-    anz_rentner_per_hh,
+def kinderzuschlag_vorrang_hh(
+    kinderzuschlag_vermögens_check_hh, arbeitsl_geld_2_m_minus_eink_hh,
 ):
-    cond = (
-        ~kinderzuschlag_vorrang
-        & ~wohngeld_m_kinderzuschlag_vorrang
-        & (arbeitsl_geld_2_m_basis > 0)
-    )
-    return _kinderzuschlag_m_vermögens_check.where(~cond & (anz_rentner_per_hh == 0), 0)
+    rest_arbeitsl_geld_2 = (
+        arbeitsl_geld_2_m_minus_eink_hh - kinderzuschlag_vermögens_check_hh
+    ).clip(lower=0)
+    return (rest_arbeitsl_geld_2 == 0) & (arbeitsl_geld_2_m_minus_eink_hh > 0)
+
+
+def wohngeld_kinderzuschlag_vorrang_hh(
+    wohngeld_vermögens_check_hh,
+    kinderzuschlag_vermögens_check_hh,
+    arbeitsl_geld_2_m_minus_eink_hh,
+):
+    rest_arbeitsl_geld_2 = (
+        arbeitsl_geld_2_m_minus_eink_hh
+        - wohngeld_vermögens_check_hh
+        - kinderzuschlag_vermögens_check_hh
+    ).clip(lower=0)
+    return (rest_arbeitsl_geld_2 == 0) & (arbeitsl_geld_2_m_minus_eink_hh > 0)