mergeron 2024.738940.0__tar.gz → 2024.738949.0__tar.gz

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.738940.0
+Version: 2024.738949.0
 Summary: Analysis of standards defined in Horizontal Merger Guidelines
 License: MIT
 Keywords: merger policy analysis,merger guidelines,merger screening,policy presumptions,concentration standards,upward pricing pressure,GUPPI
@@ -18,7 +18,6 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Dist: aenum (>=3.1)
 Requires-Dist: attrs (>=23.2)
 Requires-Dist: bs4 (>=0.0.1)
 Requires-Dist: certifi (>=2023.11.17)
@@ -28,13 +27,11 @@ Requires-Dist: jinja2 (>=3.1)
 Requires-Dist: joblib (>=1.3)
 Requires-Dist: lxml (>=5.0)
 Requires-Dist: matplotlib (>=3.8)
-Requires-Dist: mkl (==2023.2)
 Requires-Dist: mpmath (>=1.3)
 Requires-Dist: msgpack (>=1.0)
 Requires-Dist: msgpack-numpy (>=0.4)
 Requires-Dist: numpy (>=1.26)
 Requires-Dist: openpyxl (>=3.1.2)
-Requires-Dist: pyarrow (>=15.0)
 Requires-Dist: pymupdf (>=1.23)
 Requires-Dist: requests (>=2.31)
 Requires-Dist: requests-toolbelt (>=1.0.0)
@@ -61,7 +58,7 @@ Routines for downloading and organizing FTC merger investigtions data published
 
 Routines for plotting boundaries of (sets of mergers falling within) specified concentration and diversion ratio boundaries and for calibrating GUPPI thresholds to concentration (ΔHHI) thresholds, and vice-versa.
 
-    mergeron.core.guidelines_standards
+    mergeron.core.guidelines_boundaries
 
 Routines for generating industry data under various distributions of shares, prices, and margins. The user can specify whether rates are specified as, "proportional", "inside-out" (i.e., consistent with merging-firms' in-market shares and a default recapture rate), or "outside-in", (i.e., purchase probabilities are drawn at random for :math:`n+1` goods, from which are derived market shares and recapture rates for the :math:`n` goods in the putative market). Price-cost-margins may be specified as symmetric, i.i.d, or consistent with equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand. Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified. Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented.
 

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/README.rst

@@ -14,7 +14,7 @@ Routines for downloading and organizing FTC merger investigtions data published
 
 Routines for plotting boundaries of (sets of mergers falling within) specified concentration and diversion ratio boundaries and for calibrating GUPPI thresholds to concentration (ΔHHI) thresholds, and vice-versa.
 
-    mergeron.core.guidelines_standards
+    mergeron.core.guidelines_boundaries
 
 Routines for generating industry data under various distributions of shares, prices, and margins. The user can specify whether rates are specified as, "proportional", "inside-out" (i.e., consistent with merging-firms' in-market shares and a default recapture rate), or "outside-in", (i.e., purchase probabilities are drawn at random for :math:`n+1` goods, from which are derived market shares and recapture rates for the :math:`n` goods in the putative market). Price-cost-margins may be specified as symmetric, i.i.d, or consistent with equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand. Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified. Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented.
 

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "mergeron"
 # See ./get_version_str.py
-version = "2024.738940.0"
+version = "2024.738949.0"
 description = "Analysis of standards defined in Horizontal Merger Guidelines"
 keywords = [
     "merger policy analysis",
@@ -34,7 +34,6 @@ classifiers = [
 [tool.poetry.dependencies]
 # You may need to apply the fixes in, https://github.com/python-poetry/poetry/issues/3365
 # if poetry dependency resolution appears to hang (read the page at link to the end)
-aenum = ">=3.1"
 attrs = ">=23.2"
 bs4 = ">=0.0.1"
 google-re2 = ">=1.1"
@@ -42,13 +41,11 @@ jinja2 = ">=3.1"
 joblib = ">=1.3"
 lxml = ">=5.0"
 matplotlib = ">=3.8"
-mkl = "2023.2"
 mpmath = ">=1.3"
 msgpack = ">=1.0"
 msgpack-numpy = ">=0.4"
 numpy = ">=1.26"
 openpyxl = ">=3.1.2"
-pyarrow = ">=15.0"
 pymupdf = ">=1.23"
 python = "^3.12"
 requests = ">=2.31"
@@ -71,6 +68,8 @@ sphinx = ">=7.2"
 sphinx-autodoc-typehints = ">=2.0.0"
 sphinx-autoapi = ">=3.0"
 sphinx-immaterial = ">=0.11"
+pipdeptree = ">=2.15.1"
+uv = ">=0.1.11"
 
 [build-system]
 requires = ["poetry-core"]

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/src/mergeron/core/excel_helper.py

@@ -14,16 +14,29 @@ from .. import _PKG_NAME  # noqa: TID252
 
 __version__ = version(_PKG_NAME)
 
-from collections.abc import Sequence
-from typing import Any, ClassVar
+import enum
+from collections.abc import Mapping, Sequence
+from types import MappingProxyType
+from typing import Any
 
-import aenum  # type: ignore
 import numpy as np
 import numpy.typing as npt
 import xlsxwriter  # type: ignore
 
 
-class CFmt(aenum.UniqueEnum):  # type: ignore
+@enum.unique
+class CFmtParent(dict[str, Any], enum.ReprEnum):
+    def merge(self, _other) -> CFmtParent:
+        if isinstance(_other, CFmtParent):
+            return self.value | _other.value
+        else:
+            raise RuntimeWarning(
+                f"Object {_other!r} not valid for merge(), returned original."
+            )
+            return self.value
+
+
+class CFmt(CFmtParent):  # type: ignore
     """
     Initialize cell formats for xlsxwriter.
 
@@ -35,31 +48,31 @@ class CFmt(aenum.UniqueEnum):  # type: ignore
     See, https://xlsxwriter.readthedocs.io/format.html
     """
 
-    XL_DEFAULT: ClassVar = {"font_name": "Calibri", "font_size": 11}
-    XL_DEFAULT_2003: ClassVar = {"font_name": "Arial", "font_size": 10}
+    XL_DEFAULT = MappingProxyType({"font_name": "Calibri", "font_size": 11})
+    XL_DEFAULT_2003 = MappingProxyType({"font_name": "Arial", "font_size": 10})
 
-    A_CTR: ClassVar = {"align": "center"}
-    A_CTR_ACROSS: ClassVar = {"align": "center_across"}
-    A_LEFT: ClassVar = {"align": "left"}
-    A_RIGHT: ClassVar = {"align": "right"}
+    A_CTR = MappingProxyType({"align": "center"})
+    A_CTR_ACROSS = MappingProxyType({"align": "center_across"})
+    A_LEFT = MappingProxyType({"align": "left"})
+    A_RIGHT = MappingProxyType({"align": "right"})
 
-    BOLD: ClassVar = {"bold": True}
-    ITALIC: ClassVar = {"italic": True}
-    ULINE: ClassVar = {"underline": True}
+    BOLD = MappingProxyType({"bold": True})
+    ITALIC = MappingProxyType({"italic": True})
+    ULINE = MappingProxyType({"underline": True})
 
-    TEXT_WRAP: ClassVar = {"text_wrap": True}
-    IND_1: ClassVar = {"indent": 1}
+    TEXT_WRAP = MappingProxyType({"text_wrap": True})
+    IND_1 = MappingProxyType({"indent": 1})
 
-    DOLLAR_NUM: ClassVar = {"num_format": "[$$-409]#,##0.00"}
-    DT_NUM: ClassVar = {"num_format": "mm/dd/yyyy"}
-    QTY_NUM: ClassVar = {"num_format": "#,##0.0"}
-    PCT_NUM: ClassVar = {"num_format": "##0.000000%"}
-    AREA_NUM: ClassVar = {"num_format": "0.00000000"}
+    DOLLAR_NUM = MappingProxyType({"num_format": "[$$-409]#,##0.00"})
+    DT_NUM = MappingProxyType({"num_format": "mm/dd/yyyy"})
+    QTY_NUM = MappingProxyType({"num_format": "#,##0.0"})
+    PCT_NUM = MappingProxyType({"num_format": "##0.000000%"})
+    AREA_NUM = MappingProxyType({"num_format": "0.00000000"})
 
-    BAR_FILL: ClassVar = {"pattern": 1, "bg_color": "dfeadf"}
-    BOT_BORDER: ClassVar = {"bottom": 1, "bottom_color": "000000"}
-    TOP_BORDER: ClassVar = {"top": 1, "top_color": "000000"}
-    HDR_BORDER: ClassVar = TOP_BORDER | BOT_BORDER
+    BAR_FILL = MappingProxyType({"pattern": 1, "bg_color": "dfeadf"})
+    BOT_BORDER = MappingProxyType({"bottom": 1, "bottom_color": "000000"})
+    TOP_BORDER = MappingProxyType({"top": 1, "top_color": "000000"})
+    HDR_BORDER = TOP_BORDER | BOT_BORDER
 
 
 def matrix_to_sheet(
@@ -216,7 +229,7 @@ def xl_fmt(
         :code:`xlsxwriter` `Format`  object
 
     """
-    _cell_fmt_dict: dict[str, Any] = {}
+    _cell_fmt_dict: Mapping[str, Any] = MappingProxyType({})
     if isinstance(_cell_fmt, tuple):
         ensure_cell_format_spec_tuple(_cell_fmt)
         for _cf in _cell_fmt:

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/src/mergeron/core/ftc_merger_investigations_data.py

@@ -81,13 +81,13 @@ CNT_FCOUNT_DICT = {
 }
 
 
-class TableData(NamedTuple):
+class INVTableData(NamedTuple):
     ind_grp: str
     evid_cond: str
     data_array: NDArray[np.int64]
 
 
-INVData: TypeAlias = Mapping[str, dict[str, dict[str, TableData]]]
+INVData: TypeAlias = Mapping[str, dict[str, dict[str, INVTableData]]]
 
 
 def construct_data(
@@ -130,13 +130,13 @@ def construct_data(
     if _archive_path.is_file() and not rebuild_data:
         _archived_data = msgpack.unpackb(_archive_path.read_bytes(), use_list=False)
 
-        _invdata: dict[str, dict[str, dict[str, TableData]]] = {}
+        _invdata: dict[str, dict[str, dict[str, INVTableData]]] = {}
         for _period in _archived_data:
             _invdata[_period] = {}
             for _table_type in _archived_data[_period]:
                 _invdata[_period][_table_type] = {}
                 for _table_no in _archived_data[_period][_table_type]:
-                    _invdata[_period][_table_type][_table_no] = TableData(
+                    _invdata[_period][_table_type][_table_no] = INVTableData(
                         *_archived_data[_period][_table_type][_table_no]
                     )
         return MappingProxyType(_invdata)
@@ -197,7 +197,7 @@ def _construct_no_entry_evidence_data(_invdata: INVData, _data_period: str, /) -
     _invdata_evid_cond = "No Entry Evidence"
 
     _invdata_sub_evid_cond_conc = _invdata[_data_period]["ByHHIandDelta"]
-    _invdata_sub_evid_cond_conc["Table 9.X"] = TableData(
+    _invdata_sub_evid_cond_conc["Table 9.X"] = INVTableData(
         _invdata_ind_grp,
         _invdata_evid_cond,
         np.column_stack((
@@ -211,7 +211,7 @@ def _construct_no_entry_evidence_data(_invdata: INVData, _data_period: str, /) -
     )
 
     _invdata_sub_evid_cond_fcount = _invdata[_data_period]["ByFirmCount"]
-    _invdata_sub_evid_cond_fcount["Table 10.X"] = TableData(
+    _invdata_sub_evid_cond_fcount["Table 10.X"] = INVTableData(
         _invdata_ind_grp,
         _invdata_evid_cond,
         np.column_stack((
@@ -231,7 +231,7 @@ def _construct_new_period_data(
     /,
     *,
     flag_backward_compatibility: bool = False,
-) -> dict[str, dict[str, TableData]]:
+) -> dict[str, dict[str, INVTableData]]:
     _cuml_period = "1996-{}".format(int(_data_period.split("-")[1]))
     if _cuml_period != "1996-2011":
         raise ValueError('Expected cumulative period, "1996-2011"')
@@ -249,7 +249,7 @@ def _construct_new_period_data(
         _data_typesubdict = {}
         for _table_no in _invdata_cuml[_table_type]:
             _invdata_cuml_sub_table = _invdata_cuml[_table_type][_table_no]
-            _invdata_indugrp, _invdata_evid_cond, _invdata_cuml_array = (
+            _invdata_ind_group, _invdata_evid_cond, _invdata_cuml_array = (
                 _invdata_cuml_sub_table.ind_grp,
                 _invdata_cuml_sub_table.evid_cond,
                 _invdata_cuml_sub_table.data_array,
@@ -257,16 +257,16 @@ def _construct_new_period_data(
 
             _invdata_base_sub_table = _invdata_base[_table_type].get(_table_no, None)
 
-            (_invdata_base_indugrp, _invdata_base_evid_cond, _invdata_base_array) = (
+            (_invdata_base_ind_group, _invdata_base_evid_cond, _invdata_base_array) = (
                 _invdata_base_sub_table or ("", "", None)
             )
 
             # Some tables can't be constructed due to inconsistencies in the data
             # across time periods
             if (
-                (_data_period != "2004-2011" and _invdata_indugrp != "All Markets")
-                or (_invdata_indugrp in ('"Other" Markets', "Industries in Common"))
-                or (_invdata_base_indugrp in ('"Other" Markets', ""))
+                (_data_period != "2004-2011" and _invdata_ind_group != "All Markets")
+                or (_invdata_ind_group in ('"Other" Markets', "Industries in Common"))
+                or (_invdata_base_ind_group in ('"Other" Markets', ""))
             ):
                 continue
 
@@ -334,7 +334,7 @@ def _construct_new_period_data(
                 # )
                 # if np.einsum('ij->', invdata_array_bld_tbc):
                 #     print(
-                #       f"{_data_period}, {_table_no}, {_invdata_indugrp}:",
+                #       f"{_data_period}, {_table_no}, {_invdata_ind_group}:",
                 #       abs(np.einsum('ij->', invdata_array_bld_tbc))
                 #       )
 
@@ -350,22 +350,22 @@ def _construct_new_period_data(
                 np.einsum("ij->i", _invdata_array_bld_enfcls),
             ))
 
-            _data_typesubdict[_table_no] = TableData(
-                _invdata_indugrp, _invdata_evid_cond, _invdata_array_bld
+            _data_typesubdict[_table_no] = INVTableData(
+                _invdata_ind_group, _invdata_evid_cond, _invdata_array_bld
             )
-            del _invdata_indugrp, _invdata_evid_cond, _invdata_cuml_array
-            del _invdata_base_indugrp, _invdata_base_evid_cond, _invdata_base_array
+            del _invdata_ind_group, _invdata_evid_cond, _invdata_cuml_array
+            del _invdata_base_ind_group, _invdata_base_evid_cond, _invdata_base_array
             del _invdata_array_bld
         _invdata_bld[_table_type] = _data_typesubdict
     return _invdata_bld
 
 
 def _invdata_build_aggregate_table(
-    _data_typesub: dict[str, TableData], _aggr_table_list: Sequence[str]
-) -> TableData:
+    _data_typesub: dict[str, INVTableData], _aggr_table_list: Sequence[str]
+) -> INVTableData:
     _hdr_table_no = _aggr_table_list[0]
 
-    return TableData(
+    return INVTableData(
         "Industries in Common",
         "Unrestricted on additional evidence",
         np.column_stack((
@@ -403,7 +403,7 @@ def parse_invdata(
         by range of HHI and ∆HHI.
 
     """
-    _invdata: dict[str, dict[str, dict[str, TableData]]] = {}
+    _invdata: dict[str, dict[str, dict[str, INVTableData]]] = {}
 
     for _invdata_docname in _invdata_docnames:
         _invdata_pdf_path = FTCDATA_DIR.joinpath(_invdata_docname)
@@ -508,7 +508,7 @@ def _parse_table_blocks(
     )
 
     if _data_period == "1996-2011":
-        _invdata_indugrp = (
+        _invdata_ind_group = (
             _table_blocks[1][-3].split("\n")[1]
             if _table_num == "Table 4.8"
             else _table_blocks[2][-3].split("\n")[0]
@@ -524,19 +524,19 @@ def _parse_table_blocks(
     elif _data_period == "1996-2005":
         _table_blocks = sorted(_table_blocks, key=itemgetter(6))
 
-        _invdata_indugrp = _table_blocks[3][-3].strip()
+        _invdata_ind_group = _table_blocks[3][-3].strip()
         if _table_ser > 4:
             _invdata_evid_cond = _table_blocks[5][-3].strip()
 
     elif _table_ser % 2 == 0:
-        _invdata_indugrp = _table_blocks[1][-3].split("\n")[2]
+        _invdata_ind_group = _table_blocks[1][-3].split("\n")[2]
         if (_evid_cond_teststr := _table_blocks[2][-3].strip()) == "Outcome":
             _invdata_evid_cond = "Unrestricted on additional evidence"
         else:
             _invdata_evid_cond = _evid_cond_teststr
 
     elif _table_blocks[3][-3].startswith("FTC Horizontal Merger Investigations"):
-        _invdata_indugrp = _table_blocks[3][-3].split("\n")[2]
+        _invdata_ind_group = _table_blocks[3][-3].split("\n")[2]
         _invdata_evid_cond = "Unrestricted on additional evidence"
 
     else:
@@ -546,10 +546,10 @@ def _parse_table_blocks(
             if _table_ser == 9
             else _table_blocks[3][-3].strip()
         )
-        _invdata_indugrp = _table_blocks[4][-3].split("\n")[2]
+        _invdata_ind_group = _table_blocks[4][-3].split("\n")[2]
 
-    if _invdata_indugrp == "Pharmaceutical Markets":
-        _invdata_indugrp = "Pharmaceuticals Markets"
+    if _invdata_ind_group == "Pharmaceutical Markets":
+        _invdata_ind_group = "Pharmaceuticals Markets"
 
     process_table_func = (
         _process_table_blks_conc_type
@@ -563,7 +563,7 @@ def _parse_table_blocks(
         print(_table_blocks)
         raise ValueError
 
-    _table_data = TableData(_invdata_indugrp, _invdata_evid_cond, _table_array)
+    _table_data = INVTableData(_invdata_ind_group, _invdata_evid_cond, _table_array)
     _invdata[_data_period][_table_type] |= {_table_num: _table_data}
 
 
@@ -579,7 +579,7 @@ def _process_table_blks_conc_type(
     _conc_row_pat = re.compile(r"((?:0|\d,\d{3}) (?:- \d+,\d{3}|\+)|TOTAL)")
 
     _col_titles_array = tuple(CONC_DELTA_DICT.values())
-    # _col_totals: NDArray[np.int64] | None = None
+    _col_totals: NDArray[np.int64] = np.zeros(len(_col_titles_array), np.int64)
     _invdata_array: NDArray[np.int64] = np.array(None)
 
     for _tbl_blk in _table_blocks:
@@ -636,6 +636,9 @@ def _process_table_blks_cnt_type(
     _cnt_row_pat = re.compile(r"(\d+ (?:to \d+|\+)|TOTAL)")
 
     _invdata_array: NDArray[np.int64] = np.array(None)
+    _col_totals: NDArray[np.int64] = np.zeros(
+        3, np.int64
+    )  # "enforced", "closed", "total"
 
     for _tbl_blk in _table_blocks:
         if _cnt_row_pat.match(_blk_str := _tbl_blk[-3]):

mergeron-2024.738940.0/src/mergeron/core/guidelines_standards.py → mergeron-2024.738949.0/src/mergeron/core/guidelines_boundaries.py

@@ -15,7 +15,7 @@ from dataclasses import dataclass
 from typing import Any, Literal, TypeAlias
 
 import numpy as np
-from attr import define, field
+from attrs import define, field
 from mpmath import mp, mpf  # type: ignore
 from numpy.typing import NDArray
 from scipy.spatial.distance import minkowski as distance_function
@@ -33,7 +33,7 @@ class GuidelinesBoundary:
 
 
 @define(slots=True, frozen=True)
-class GuidelinesSTD:
+class HMGThresholds:
     delta: float
     rec: float
     guppi: float
@@ -43,13 +43,12 @@ class GuidelinesSTD:
 
 
 @define(slots=True, frozen=True)
-class GuidelinesStandards:
+class GuidelinesThresholds:
     """
-    Guidelines standards by Guidelines publication year
-
-    Diversion ratio, GUPPI, CMCR, and IPR standards are constructed from
-    concentration standards.
+    Guidelines threholds by Guidelines publication year
 
+    ΔHHI, Recapture Rate, GUPPI, Diversion ratio, CMCR, and IPR thresholds
+    constructed from concentration standards.
     """
 
     pub_year: HMGPubYear
@@ -57,26 +56,26 @@ class GuidelinesStandards:
     Year of publication of the U.S. Horizontal Merger Guidelines (HMG)
     """
 
-    safeharbor: GuidelinesSTD = field(kw_only=True, default=None)
+    safeharbor: HMGThresholds = field(kw_only=True, default=None)
     """
-    Negative presumption defined on various measures
+    Negative presumption quantified on various measures
 
     ΔHHI safeharbor bound, default recapture rate, GUPPI bound,
     diversion ratio limit, CMCR, and IPR
     """
 
-    inferred_presumption: GuidelinesSTD = field(kw_only=True, default=None)
+    imputed_presumption: HMGThresholds = field(kw_only=True, default=None)
     """
-    Inferred ΔHHI safeharbor presumption and related measures
+    Presumption of harm imputed from guidelines
 
     ΔHHI bound inferred from strict numbers-equivalent
     of (post-merger) HHI presumption, and corresponding default recapture rate,
     GUPPI bound, diversion ratio limit, CMCR, and IPR
     """
 
-    presumption: GuidelinesSTD = field(kw_only=True, default=None)
+    presumption: HMGThresholds = field(kw_only=True, default=None)
     """
-    Guidelines ΔHHI safeharbor presumption and related measures
+    Presumption of harm defined in HMG
 
     ΔHHI bound and corresponding default recapture rate, GUPPI bound,
     diversion ratio limit, CMCR, and IPR
@@ -98,7 +97,7 @@ class GuidelinesStandards:
         object.__setattr__(
             self,
             "safeharbor",
-            GuidelinesSTD(
+            HMGThresholds(
                 _dh_s,
                 _r := round_cust((_fc := int(np.ceil(1 / _hhi_p))) / (_fc + 1)),
                 _g_s := gbd_from_dsf(_dh_s, m_star=1.0, r_bar=_r),
@@ -108,12 +107,12 @@ class GuidelinesStandards:
             ),
         )
 
-        # inferred_presumption is relevant for 2010 Guidelines
+        # imputed_presumption is relevant for 2010 Guidelines
         object.__setattr__(
             self,
-            "inferred_presumption",
+            "imputed_presumption",
             (
-                GuidelinesSTD(
+                HMGThresholds(
                     _dh_i := 2 * (0.5 / _fc) ** 2,
                     _r_i := round_cust((_fc - 1 / 2) / (_fc + 1 / 2)),
                     _g_i := gbd_from_dsf(_dh_i, m_star=1.0, r_bar=_r_i),
@@ -122,7 +121,7 @@ class GuidelinesStandards:
                     _g_i,
                 )
                 if self.pub_year == 2010
-                else GuidelinesSTD(
+                else HMGThresholds(
                     _dh_i := 2 * (1 / (_fc + 1)) ** 2,
                     _r,
                     _g_i := gbd_from_dsf(_dh_i, m_star=1.0, r_bar=_r),
@@ -136,7 +135,7 @@ class GuidelinesStandards:
         object.__setattr__(
             self,
             "presumption",
-            GuidelinesSTD(
+            HMGThresholds(
                 _dh_p,
                 _r,
                 _g_p := gbd_from_dsf(_dh_p, m_star=1.0, r_bar=_r),
@@ -391,7 +390,13 @@ def boundary_plot(*, mktshares_plot_flag: bool = True) -> tuple[Any, ...]:
     _fig = plt.figure(figsize=(5, 5), dpi=600)
     _ax_out = _fig.add_subplot()
 
-    def _set_axis_def(_ax1: mpa.Axes, /, mktshares_plot_flag: bool = False) -> mpa.Axes:
+    def _set_axis_def(
+        _ax1: mpa.Axes,
+        /,
+        *,
+        mktshares_plot_flag: bool = False,
+        mktshares_axlbls_flag: bool = False,
+    ) -> mpa.Axes:
         # Set the width of axis gridlines, and tick marks:
         # both axes, both major and minor ticks
         # Frame, grid, and facecolor
@@ -402,7 +407,7 @@ def boundary_plot(*, mktshares_plot_flag: bool = True) -> tuple[Any, ...]:
             _ax1.spines[_spos1].set_linewidth(0.0)
             _ax1.spines[_spos1].set_zorder(0)
             _ax1.spines[_spos1].set_visible(False)
-        _ax1.set_facecolor("#F6F6F6")
+        _ax1.set_facecolor("#E6E6E6")
 
         _ax1.grid(linewidth=0.5, linestyle=":", color="grey", zorder=1)
         _ax1.tick_params(axis="x", which="both", width=0.5)
@@ -421,15 +426,16 @@ def boundary_plot(*, mktshares_plot_flag: bool = True) -> tuple[Any, ...]:
             _ax1.yaxis.get_majorticklabels(), horizontalalignment="right", fontsize=6
         )
 
-        # Axis labels
-        # x-axis
-        _ax1.set_xlabel("Firm 1 Market Share, $s_1$", fontsize=10)
-        _ax1.xaxis.set_label_coords(0.75, -0.1)
-        # y-axis
-        _ax1.set_ylabel("Firm 2 Market Share, $s_2$", fontsize=10)
-        _ax1.yaxis.set_label_coords(-0.1, 0.75)
-
         if mktshares_plot_flag:
+            # Axis labels
+            if mktshares_axlbls_flag:
+                # x-axis
+                _ax1.set_xlabel("Firm 1 Market Share, $s_1$", fontsize=10)
+                _ax1.xaxis.set_label_coords(0.75, -0.1)
+                # y-axis
+                _ax1.set_ylabel("Firm 2 Market Share, $s_2$", fontsize=10)
+                _ax1.yaxis.set_label_coords(-0.1, 0.75)
+
             # Plot the ray of symmetry
             _ax1.plot(
                 [0, 1], [0, 1], linewidth=0.5, linestyle=":", color="grey", zorder=1

{mergeron-2024.738940.0 → mergeron-2024.738949.0}/src/mergeron/core/proportions_tests.py

@@ -7,6 +7,7 @@ Functions to estimate confidence intervals for
 
 from __future__ import annotations
 
+from dataclasses import dataclass
 from importlib.metadata import version
 
 from .. import _PKG_NAME  # noqa: TID252
@@ -14,7 +15,7 @@ from .. import _PKG_NAME  # noqa: TID252
 __version__ = version(_PKG_NAME)
 
 from collections.abc import Sequence
-from typing import Literal, NamedTuple, TypeVar
+from typing import Literal, TypeVar
 
 import numpy as np
 from numpy.typing import NBitBase, NDArray
@@ -101,12 +102,12 @@ def propn_ci(
         case "Agresti-Coull":
             _zsc = norm.ppf(1 - alpha / 2)
             _zscsq = _zsc * _zsc
-            _adjmt_t = 4 if alpha == 0.05 else _zscsq
-            _est_phat = (_npos + _adjmt_t / 2) / (_nobs + _adjmt_t)
+            _adjmt = 4 if alpha == 0.05 else _zscsq
+            _est_phat = (_npos + _adjmt / 2) / (_nobs + _adjmt)
             _est_ci_l, _est_ci_u = (
                 _est_phat + _g
                 for _g in [
-                    _f * _zsc * np.sqrt(_est_phat * (1 - _est_phat) / (_nobs + 4))
+                    _f * _zsc * np.sqrt(_est_phat * (1 - _est_phat) / (_nobs + _adjmt))
                     for _f in (-1, 1)
                 ]
             )
@@ -441,7 +442,7 @@ def _propn_diff_chisq_mn(
     )
 
 
-def propn_ci_diff_multinomial(
+def propn_diff_ci_multinomial(
     _counts: NDArray[np.integer[TI]], /, *, alpha: float = 0.05
 ) -> NDArray[np.float64]:
     """Estimate confidence intervals of pair-wise differences in multinomial proportions
@@ -475,16 +476,17 @@ def propn_ci_diff_multinomial(
     return np.column_stack([_d + _f * _d_cr * np.sqrt(_var) for _f in (-1, 1)])
 
 
-class MultinomialDiffTest(NamedTuple):
+@dataclass(slots=True, frozen=True)
+class MultinomialPropnsTest:
     estimate: np.float64
     dof: int
     critical_value: np.float64
     p_value: np.float64
 
 
-def propn_diff_multinomial_chisq(
+def propn_test_multinomial(
     _counts: NDArray[np.integer[TI]], /, *, alpha: float = 0.05
-) -> MultinomialDiffTest:
+) -> MultinomialPropnsTest:
     """Chi-square test for homogeneity of differences in multinomial proportions.
 
     Differences in multinomial proportions sum to zero.
@@ -510,9 +512,9 @@ def propn_diff_multinomial_chisq(
     _p_bar = _n / np.einsum("jk->j", _n_k / _prob)
 
     _y_sq = _n * ((1 / np.einsum("j->", _p_bar)) - 1)
-    _dof = np.array([_f - 1 for _f in _counts.shape]).prod()
+    _dof = np.array([_s - 1 for _s in _counts.shape]).prod()
     _chi_rv = chi2(_dof)
 
-    return MultinomialDiffTest(
+    return MultinomialPropnsTest(
         _y_sq, _dof, _chi_rv.ppf(1 - alpha), 1 - _chi_rv.cdf(_y_sq)
     )