microdf-python 0.4.5__py3-none-any.whl → 1.0.0__py3-none-any.whl

microdf/__init__.py

@@ -1,156 +1,10 @@
-from .agg import agg, combine_base_reform, pctchg_base_reform
-from .concat import concat
-from .constants import (
-    BENS,
-    ECI_REMOVE_COLS,
-    HOUSING_CASH_SHARE,
-    MCAID_CASH_SHARE,
-    MCARE_CASH_SHARE,
-    MED_BENS,
-    OTHER_CASH_SHARE,
-    SNAP_CASH_SHARE,
-    SSI_CASH_SHARE,
-    TANF_CASH_SHARE,
-    VET_CASH_SHARE,
-    WIC_CASH_SHARE,
-)
-from .custom_taxes import (
-    CARBON_TAX_INCIDENCE,
-    FTT_INCIDENCE,
-    VAT_INCIDENCE,
-    add_carbon_tax,
-    add_custom_tax,
-    add_ftt,
-    add_vat,
-)
-from .income_measures import cash_income, market_income, tpc_eci
-from .inequality import (
-    bottom_50_pct_share,
-    bottom_x_pct_share,
-    gini,
-    t10_b50,
-    top_0_1_pct_share,
-    top_1_pct_share,
-    top_10_pct_share,
-    top_50_pct_share,
-    top_x_pct_share,
-)
-from .io import read_stata_zip
 from .microdataframe import MicroDataFrame, MicroDataFrameGroupBy
 from .microseries import MicroSeries, MicroSeriesGroupBy
-from .poverty import (
-    deep_poverty_gap,
-    deep_poverty_rate,
-    fpl,
-    poverty_gap,
-    poverty_rate,
-    squared_poverty_gap,
-)
-from .tax import mtr, tax_from_mtrs
-from .taxcalc import (
-    add_weighted_metrics,
-    calc_df,
-    n65,
-    recalculate,
-    static_baseline_calc,
-)
-from .ubi import ubi_or_bens
-from .utils import (
-    cartesian_product,
-    dedup_list,
-    flatten,
-    listify,
-    ordinal_label,
-)
-from .weighted import (
-    add_weighted_quantiles,
-    quantile_chg,
-    weight,
-    weighted_mean,
-    weighted_median,
-    weighted_quantile,
-    weighted_sum,
-)
 
 name = "microdf"
 __version__ = "0.1.0"
 
 __all__ = [
-    # agg.py
-    "combine_base_reform",
-    "pctchg_base_reform",
-    "agg",
-    # concat.py
-    "concat",
-    # constants.py
-    "BENS",
-    "ECI_REMOVE_COLS",
-    "HOUSING_CASH_SHARE",
-    "MCAID_CASH_SHARE",
-    "MCARE_CASH_SHARE",
-    "MED_BENS",
-    "OTHER_CASH_SHARE",
-    "SNAP_CASH_SHARE",
-    "SSI_CASH_SHARE",
-    "TANF_CASH_SHARE",
-    "VET_CASH_SHARE",
-    "WIC_CASH_SHARE",
-    # custom_taxes.py
-    "CARBON_TAX_INCIDENCE",
-    "FTT_INCIDENCE",
-    "VAT_INCIDENCE",
-    "add_custom_tax",
-    "add_vat",
-    "add_carbon_tax",
-    "add_ftt",
-    # income_measures.py
-    "cash_income",
-    "tpc_eci",
-    "market_income",
-    # inequality.py
-    "gini",
-    "top_x_pct_share",
-    "bottom_x_pct_share",
-    "bottom_50_pct_share",
-    "top_10_pct_share",
-    "top_1_pct_share",
-    "top_0_1_pct_share",
-    "top_50_pct_share",
-    "t10_b50",
-    # io.py
-    "read_stata_zip",
-    # poverty.py
-    "fpl",
-    "poverty_rate",
-    "deep_poverty_rate",
-    "poverty_gap",
-    "squared_poverty_gap",
-    "deep_poverty_gap",
-    # tax.py
-    "mtr",
-    "tax_from_mtrs",
-    # taxcalc.py
-    "static_baseline_calc",
-    "add_weighted_metrics",
-    "n65",
-    "calc_df",
-    "recalculate",
-    # ubi.py
-    "ubi_or_bens",
-    # utils.py
-    "ordinal_label",
-    "dedup_list",
-    "listify",
-    "flatten",
-    "cartesian_product",
-    # weighted.py
-    "weight",
-    "weighted_sum",
-    "weighted_mean",
-    "weighted_quantile",
-    "weighted_median",
-    "add_weighted_quantiles",
-    "quantile_chg",
     # microseries.py
     "MicroSeries",
     "MicroSeriesGroupBy",

microdf/tests/test_microseries_dataframe.py

@@ -105,24 +105,6 @@ def test_multiple_groupby() -> None:
     assert (df.groupby(["x", "y"]).z.sum() == np.array([5, 6])).all()
 
 
-def test_concat() -> None:
-    df1 = mdf.MicroDataFrame({"x": [1, 2]}, weights=[3, 4])
-    df2 = mdf.MicroDataFrame({"y": [5, 6]}, weights=[7, 8])
-    # Verify that pd.concat returns DataFrame (probably no way to fix this).
-    pd_long = pd.concat([df1, df2])
-    assert isinstance(pd_long, pd.DataFrame)
-    assert not isinstance(pd_long, mdf.MicroDataFrame)
-    # Verify that mdf.concat works.
-    mdf_long = mdf.concat([df1, df2])
-    assert isinstance(mdf_long, mdf.MicroDataFrame)
-    # Weights should be preserved.
-    assert mdf_long.weights.equals(pd.concat([df1.weights, df2.weights]))
-    # Verify it works horizontally too (take the first set of weights).
-    mdf_wide = mdf.concat([df1, df2], axis=1)
-    assert isinstance(mdf_wide, mdf.MicroDataFrame)
-    assert mdf_wide.weights.equals(df1.weights)
-
-
 def test_set_index() -> None:
     d = mdf.MicroDataFrame(dict(x=[1, 2, 3]), weights=[4, 5, 6])
     assert d.x.__class__ == MicroSeries

microdf_python-1.0.0.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: microdf-python
+Version: 1.0.0
+Summary: Weighted pandas DataFrames and Series for survey microdata
+Author-email: Max Ghenis <max@ubicenter.org>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Provides-Extra: dev
+Requires-Dist: codecov; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: flake8-pyproject; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: docformatter; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: linecheck; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: jupyter_book; extra == "docs"
+Dynamic: license-file
+
+[![Build](https://github.com/PolicyEngine/microdf/workflows/Pull%20request/badge.svg)](https://github.com/PolicyEngine/microdf/actions)
+[![Codecov](https://codecov.io/gh/PolicyEngine/microdf/branch/master/graph/badge.svg)](https://codecov.io/gh/PolicyEngine/microdf)
+
+# microdf
+Weighted pandas DataFrames and Series for survey microdata analysis.
+
+## Overview
+microdf provides `MicroDataFrame` and `MicroSeries` classes that extend pandas functionality with integrated weighting support, essential for accurate survey data analysis.
+
+## Key Features
+- **MicroDataFrame**: A pandas DataFrame with an integrated weight column
+- **MicroSeries**: A pandas Series with integrated weights
+- **Weighted operations**: All aggregations (sum, mean, median, etc.) automatically use weights
+- **Inequality metrics**: Built-in Gini coefficient calculation
+- **Poverty analysis**: Integrated poverty rate and gap calculations
+
+## Installation
+Install with:
+
+    pip install microdf-python
+
+Or for development:
+
+    pip install git+https://github.com/PolicyEngine/microdf.git
+
+## Usage
+```python
+import microdf as mdf
+import pandas as pd
+
+# Create sample data with weights
+df = pd.DataFrame({
+    'income': [10_000, 20_000, 30_000, 40_000, 50_000],
+    'weights': [1, 2, 3, 2, 1]
+})
+
+# Create a MicroDataFrame
+mdf_df = mdf.MicroDataFrame(df, weights='weights')
+
+# All operations are weight-aware
+print(mdf_df.income.mean())  # Weighted mean
+print(mdf_df.income.gini())  # Gini coefficient
+```
+
+## Questions
+Contact the maintainer, Max Ghenis (max@policyengine.org).
+
+## Citation
+You may cite the source of your analysis as "microdf release #.#.#, author's calculations."

microdf_python-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+microdf/__init__.py,sha256=ldRvhE8t4cD7qlxQ5yLndMnWEUYpDw4m-jCDV_psXkY,319
+microdf/microdataframe.py,sha256=5jYQ76PYjndACJO6hsJCaCL0g0clAsQbWltVcPtJ7yU,18202
+microdf/microseries.py,sha256=URFT9bqry5Q_qezl3ge9lW8FSbQ6qg0XRaFQwN0IkwQ,22130
+microdf/tests/conftest.py,sha256=u-EMyX1-u_nM-YO0RJYCzYHQDXxUI2WQE6GkyJlErqg,150
+microdf/tests/test_microseries_dataframe.py,sha256=QSxdJ0ZfXO1XZgER9LRqDt5SGpVGyME03gefixH6spk,8855
+microdf_python-1.0.0.dist-info/licenses/LICENSE,sha256=uPs-ASYnzlldpf2z8jeRgQFeEH3FLhSuX0rw0OKWoDU,1067
+microdf_python-1.0.0.dist-info/METADATA,sha256=mC0MB2zQwVaqrPXfmh9mIc1KX5lmSO1zS9ilCvZQQg0,2483
+microdf_python-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microdf_python-1.0.0.dist-info/top_level.txt,sha256=T2WFPTygQQMdS3GF8YpZ12DKfMGrspbZ3r7z-e3KfiM,8
+microdf_python-1.0.0.dist-info/RECORD,,

microdf/_optional.py

@@ -1,85 +0,0 @@
-import distutils.version
-import importlib
-import types
-import warnings
-from typing import Optional, Union
-
-# Adapted from:
-# https://github.com/pandas-dev/pandas/blob/master/pandas/compat/_optional.py
-
-VERSIONS = {
-    "taxcalc": "2.0.0",
-}
-
-
-def _get_version(module: types.ModuleType) -> str:
-    """
-
-    :param module: types.ModuleType:
-    :param module: types.ModuleType:
-
-    """
-    version = getattr(module, "__version__", None)
-    if version is None:
-        # xlrd uses a capitalized attribute name
-        version = getattr(module, "__VERSION__", None)
-
-    if version is None:
-        raise ImportError(f"Can't determine version for {module.__name__}")
-    return version
-
-
-def import_optional_dependency(
-    name: str,
-    extra: Optional[str] = "",
-    raise_on_missing: Optional[bool] = True,
-    on_version: Optional[str] = "raise",
-) -> Union[types.ModuleType, None]:
-    """Import an optional dependency. By default, if a dependency is missing an
-    ImportError with a nice message will be raised. If a dependency is present,
-    but too old, we raise.
-
-    :param name: The module name. This should be top-level only, so that the
-        version may be checked.
-    :type name: str
-    :param extra: Additional text to include in the ImportError message.
-    :type extra: str
-    :param raise_on_missing: Whether to raise if the optional dependency is
-        not found. When False and the module is not present, None is returned.
-    :type raise_on_missing: bool, default True
-    :param on_version: What to do when a dependency's version is too old.
-        * raise : Raise an ImportError
-        * warn : Warn that the version is too old. Returns None
-        * ignore: Return the module, even if the version is too old.
-          It's expected that users validate the version locally when
-    :type on_version: str {'raise', 'warn'}
-    """
-    msg = (
-        f"Missing optional dependency '{name}'. {extra} "
-        f"Use pip or conda to install {name}."
-    )
-    try:
-        module = importlib.import_module(name)
-    except ImportError:
-        if raise_on_missing:
-            raise ImportError(msg) from None
-        else:
-            return None
-
-    minimum_version = VERSIONS.get(name)
-    if minimum_version:
-        version = _get_version(module)
-        if distutils.version.LooseVersion(version) < minimum_version:
-            assert on_version in {"warn", "raise", "ignore"}
-            msg = (
-                f"microdf requires version '{minimum_version}' or newer of "
-                f"'{name}' "
-                f"(version '{version}' currently installed)."
-            )
-            if on_version == "warn":
-                warnings.warn(msg, UserWarning)
-                return None
-            elif on_version == "raise":
-                raise ImportError(msg)
-
-    return module

microdf/agg.py

@@ -1,90 +0,0 @@
-from typing import Optional
-
-import pandas as pd
-
-import microdf as mdf
-
-
-def combine_base_reform(
-    base: pd.DataFrame,
-    reform: pd.DataFrame,
-    base_cols: Optional[list] = None,
-    cols: Optional[list] = None,
-    reform_cols: Optional[list] = None,
-) -> pd.DataFrame:
-    """Combine base and reform with certain columns.
-
-    :param base: Base DataFrame. Index must match reform.
-    :type base: pd.DataFrame
-    :param reform: Reform DataFrame. Index must match base.
-    :type reform: pd.DataFrame
-    :param base_cols: Columns in base to keep.
-    :type base_cols: list, optional
-    :param cols: Columns to keep from both base and reform.
-    :type cols: list, optional
-    :param reform_cols: Columns in reform to keep.
-    :type reform_cols: list, optional
-    :returns: DataFrame with columns for base ("_base") and reform ("_reform").
-    :rtype: pd.DataFrame
-    """
-    all_base_cols = mdf.listify([base_cols] + [cols])
-    all_reform_cols = mdf.listify([reform_cols] + [cols])
-    return base[all_base_cols].join(
-        reform[all_reform_cols], lsuffix="_base", rsuffix="_reform"
-    )
-
-
-def pctchg_base_reform(combined: pd.DataFrame, metric: str) -> pd.Series:
-    """Calculates the percentage change in a metric for a combined dataset.
-
-    :param combined: Combined DataFrame with _base and _reform columns.
-    :type combined: pd.DataFrame
-    :param metric: String of the column to calculate the difference. Must exist
-        as metric_m_base and metric_m_reform in combined.
-    :type metric: str
-    :returns: Series with percentage change.
-    :rtype: pd.Series
-    """
-    return combined[metric + "_m_reform"] / combined[metric + "_m_base"] - 1
-
-
-def agg(
-    base: pd.DataFrame,
-    reform: pd.DataFrame,
-    groupby: str,
-    metrics: list,
-    base_metrics: Optional[list] = None,
-    reform_metrics: Optional[list] = None,
-) -> pd.DataFrame:
-    """Aggregates differences between base and reform.
-
-    :param base: Base DataFrame. Index must match reform.
-    :type base: pd.DataFrame
-    :param reform: Reform DataFrame. Index must match base.
-    :type reform: pd.DataFrame
-    :param groupby: Variable in base to group on.
-    :type groupby: str
-    :param metrics: List of variables to agg and calculate the % change of.
-        These should have associated weighted columns ending in _m in base and
-        reform.
-    :type metrics: list
-    :param base_metrics: List of variables from base to sum.
-    :type base_metrics: Optional[list]
-    :param reform_metrics: List of variables from reform to sum.
-    :type reform_metrics: Optional[list]
-    :returns: DataFrame with groupby and metrics, and _pctchg metrics.
-    :rtype: pd.DataFrame
-    """
-    metrics = mdf.listify(metrics)
-    metrics_m = [i + "_m" for i in metrics]
-    combined = combine_base_reform(
-        base,
-        reform,
-        base_cols=mdf.listify([groupby, base_metrics]),
-        cols=mdf.listify(metrics_m),
-        reform_cols=mdf.listify(reform_metrics),
-    )
-    grouped = combined.groupby(groupby).sum()
-    for metric in metrics:
-        grouped[metric + "_pctchg"] = pctchg_base_reform(grouped, metric)
-    return grouped

microdf/concat.py

@@ -1,29 +0,0 @@
-import inspect
-
-import pandas as pd
-
-import microdf as mdf
-from microdf.microdataframe import MicroDataFrame
-
-
-def concat(*args, **kwargs) -> "MicroDataFrame":
-    """Concatenates MicroDataFrame objects, preserving weights. If
-    concatenating horizontally, the first set of weights are used. All args and
-    kwargs are passed to pd.concat.
-
-    :return: MicroDataFrame with concatenated weights.
-    :rtype: mdf.MicroDataFrame
-    """
-    # Extract args with respect to pd.concat.
-    pd_args = inspect.getcallargs(pd.concat, *args, **kwargs)
-    objs = pd_args["objs"]
-    axis = pd_args["axis"]
-    # Create result, starting with pd.concat.
-    res = mdf.MicroDataFrame(pd.concat(*args, **kwargs))
-    # Assign weights depending on axis.
-    if axis == 0:
-        res.weights = pd.concat([obj.weights for obj in objs])
-    else:
-        # If concatenating horizontally, use the first set of weights.
-        res.weights = objs[0].weights
-    return res

microdf/constants.py

@@ -1,40 +0,0 @@
-# Constants for share of each benefit that is cash.
-HOUSING_CASH_SHARE = 0.0
-MCAID_CASH_SHARE = 0.0
-MCARE_CASH_SHARE = 0.0
-# https://github.com/open-source-economics/taxdata/issues/148
-# https://docs.google.com/spreadsheets/d/1g_YdFd5idgLL764G0pZBiBnIlnCBGyxBmapXCOZ1OV4
-OTHER_CASH_SHARE = 0.35
-SNAP_CASH_SHARE = 0.0
-SSI_CASH_SHARE = 1.0
-TANF_CASH_SHARE = 0.25
-# https://github.com/open-source-economics/C-TAM/issues/62.
-VET_CASH_SHARE = 0.48
-WIC_CASH_SHARE = 0.0
-
-# Columns to remove from expanded_income to approximate TPC's Expanded Cash
-# Income.
-ECI_REMOVE_COLS = [
-    "wic_ben",
-    "housing_ben",
-    "vet_ben",
-    "mcare_ben",
-    "mcaid_ben",
-]
-
-# Benefits.
-BENS = [
-    "housing_ben",
-    "mcaid_ben",
-    "mcare_ben",
-    "vet_ben",
-    "other_ben",
-    "snap_ben",
-    "ssi_ben",
-    "tanf_ben",
-    "wic_ben",
-    "e02400",  # Social Security (OASDI).
-    "e02300",  # Unemployment insurance.
-]
-
-MED_BENS = ["mcaid_ben", "mcare_ben", "vet_ben"]

microdf/custom_taxes.py

@@ -1,174 +0,0 @@
-"""Functions and data for estimating taxes outside the income tax system.
-
-Examples include value added tax, financial transaction tax, and carbon tax.
-"""
-
-from typing import Optional
-
-import numpy as np
-import pandas as pd
-
-import microdf as mdf
-
-# Source:
-# https://www.taxpolicycenter.org/briefing-book/who-would-bear-burden-vat
-VAT_INCIDENCE = pd.Series(
-    index=[-1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 99.9],
-    data=[3.9, 3.9, 3.6, 3.6, 3.6, 3.6, 3.6, 3.4, 3.4, 3.2, 2.8, 2.5, 2.5],
-)
-VAT_INCIDENCE /= 100
-
-# Source: Table 5 in
-# https://www.treasury.gov/resource-center/tax-policy/tax-analysis/Documents/WP-115.pdf
-CARBON_TAX_INCIDENCE = pd.Series(
-    index=[-1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 99.9],
-    data=[0.8, 1.2, 1.4, 1.5, 1.6, 1.7, 1.8, 1.8, 1.8, 1.8, 1.6, 1.4, 0.7],
-)
-CARBON_TAX_INCIDENCE /= 100
-
-# Source: Figure 1 in
-# https://www.taxpolicycenter.org/sites/default/files/alfresco/publication-pdfs/2000587-financial-transaction-taxes.pdf
-FTT_INCIDENCE = pd.Series(
-    index=[-1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 99.9],
-    data=[0.1, 0.1, 0.1, 0.1, 0.1, 0.1, 0.2, 0.2, 0.2, 0.3, 0.4, 0.8, 1.0],
-)
-FTT_INCIDENCE /= 100
-
-
-def add_custom_tax(
-    df: pd.DataFrame,
-    segment_income: str,
-    w: str,
-    base_income: str,
-    incidence: pd.Series,
-    name: str,
-    total: Optional[float] = None,
-    ratio: Optional[float] = None,
-    verbose: Optional[bool] = True,
-) -> None:
-    """Add a custom tax based on incidence analysis driven by percentiles.
-
-    :param df: DataFrame.
-    :param segment_income: Income measure used to segment tax units into
-        quantiles.
-    :param w: Weight used to segment into quantiles (either s006 or XTOT_m).
-    :param base_income: Income measure by which incidence is multiplied to
-        estimate liability.
-    :param incidence: pandas Series indexed on the floor of an income
-        percentile, with values for the tax rate.
-    :param name: Name of the column to add.
-    :param total: Total amount the tax should generate. If not provided,
-        liabilities are calculated only based on the incidence schedule.
-        (Default value = None)
-    :param ratio: Ratio to adjust the tax by, compared to the original tax.
-        This acts as a multiplier for the incidence argument. (Default value =
-        None)
-    :param verbose: Whether to print the tax adjustment factor if needed.
-        Defaults to True.
-    :returns: Nothing. Adds the column name to df representing the tax
-        liability. df is also sorted by segment_income.
-    """
-    if ratio is not None:
-        incidence = incidence * ratio
-        assert total is None, "ratio and total cannot both be provided."
-    df.sort_values(segment_income, inplace=True)
-    income_percentile = 100 * df[w].cumsum() / df[w].sum()
-    tu_incidence = incidence.iloc[
-        pd.cut(
-            income_percentile,
-            # Add a right endpoint. Should be 100 but sometimes a decimal
-            # gets added.
-            bins=incidence.index.tolist() + [101],
-            labels=False,
-        )
-    ].values
-    df[name] = np.maximum(0, tu_incidence * df[base_income])
-    if total is not None:
-        initial_total = mdf.weighted_sum(df, name, "s006")
-        if verbose:
-            print(
-                "Multiplying tax by "
-                + str(round(total / initial_total, 2))
-                + "."
-            )
-        df[name] *= total / initial_total
-
-
-def add_vat(
-    df: pd.DataFrame,
-    segment_income: Optional[str] = "tpc_eci",
-    w: Optional[str] = "XTOT_m",
-    base_income: Optional[str] = "aftertax_income",
-    incidence: Optional[pd.Series] = VAT_INCIDENCE,
-    name: Optional[str] = "vat",
-    **kwargs,
-) -> None:
-    """Add value added tax based on incidence estimate from Tax Policy Center.
-
-    :param df: DataFrame with columns for tpc_eci, XTOT_m, and aftertax_income.
-    :param Other: arguments: Args to add_custom_tax with VAT defaults.
-    :param segment_income: Default value = "tpc_eci")
-    :param w: Default value = "XTOT_m")
-    :param base_income: Default value = "aftertax_income")
-    :param incidence: Default value = VAT_INCIDENCE)
-    :param name: Default value = "vat") :param **kwargs: Other arguments passed
-        to add_custom_tax().
-    :returns: Nothing. Adds vat to df. df is also sorted by tpc_eci.
-    """
-    add_custom_tax(
-        df, segment_income, w, base_income, incidence, name, **kwargs
-    )
-
-
-def add_carbon_tax(
-    df: pd.DataFrame,
-    segment_income: Optional[str] = "tpc_eci",
-    w: Optional[str] = "XTOT_m",
-    base_income: Optional[str] = "aftertax_income",
-    incidence: Optional[pd.Series] = CARBON_TAX_INCIDENCE,
-    name: Optional[str] = "carbon_tax",
-    **kwargs,
-) -> None:
-    """Add carbon tax based on incidence estimate from the US Treasury
-    Department.
-
-    :param df: DataFrame with columns for tpc_eci, XTOT_m, and aftertax_income.
-    :param Other: arguments: Args to add_custom_tax with carbon tax defaults.
-    :param segment_income: Default value = "tpc_eci")
-    :param w: Default value = "XTOT_m")
-    :param base_income: Default value = "aftertax_income")
-    :param incidence: Default value = CARBON_TAX_INCIDENCE)
-    :param name: Default value = "carbon_tax") :param **kwargs: Other arguments
-        passed to add_custom_tax().
-    :returns: Nothing. Adds carbon_tax to df. df is also sorted by tpc_eci.
-    """
-    add_custom_tax(
-        df, segment_income, w, base_income, incidence, name, **kwargs
-    )
-
-
-def add_ftt(
-    df: pd.DataFrame,
-    segment_income: Optional[str] = "tpc_eci",
-    w: Optional[str] = "XTOT_m",
-    base_income: Optional[str] = "aftertax_income",
-    incidence: Optional[pd.Series] = FTT_INCIDENCE,
-    name: Optional[str] = "ftt",
-    **kwargs,
-) -> None:
-    """Add financial transaction tax based on incidence estimate from Tax
-    Policy Center.
-
-    :param df: DataFrame with columns for tpc_eci, XTOT_m, and aftertax_income.
-    :param Other: arguments: Args to add_custom_tax with FTT defaults.
-    :param segment_income: Default value = "tpc_eci")
-    :param w: Default value = "XTOT_m")
-    :param base_income: Default value = "aftertax_income")
-    :param incidence: Default value = FTT_INCIDENCE)
-    :param name: Default value = "ftt") :param **kwargs: Other arguments passed
-        to add_custom_tax().
-    :returns: Nothing. Adds ftt to df. df is also sorted by tpc_eci.
-    """
-    add_custom_tax(
-        df, segment_income, w, base_income, incidence, name, **kwargs
-    )