mergeron_extra 2024.739148.7__py3-none-any.whl → 2026.739650.0__py3-none-any.whl

mergeron_extra/__init__.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import numpy as np
 from numpy.typing import NDArray
 
-VERSION = "2024.739148.7"
+VERSION = "2026.739650.0"
 
 __version__ = VERSION
 

mergeron_extra/proportions_tests.py

@@ -9,13 +9,15 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from dataclasses import dataclass
+from itertools import starmap
 from typing import Literal
 
 import numpy as np
+from mergeron import ArrayDouble, ArrayINT
 from scipy.optimize import OptimizeResult, root  # type: ignore
 from scipy.stats import beta, chi2, norm  # type: ignore
 
-from . import VERSION, ArrayDouble, ArrayINT
+from . import VERSION
 
 __version__ = VERSION
 
@@ -29,12 +31,11 @@ def propn_ci(
     method: Literal[
         "Agresti-Coull", "Clopper-Pearson", "Exact", "Wilson", "Score"
     ] = "Wilson",
-) -> tuple[
-    ArrayDouble | float, ArrayDouble | float, ArrayDouble | float, ArrayDouble | float
-]:
-    """Returns point estimates and confidence interval for a proportion
+) -> ArrayDouble:
+    """
+    Point estimates and confidence interval for a proportion.
 
-    Methods "Clopper-Pearson" and "Exact" are synoymous [3]_.  Similarly,
+    Methods "Clopper-Pearson" and "Exact" are synonymous [3]_.  Similarly,
     "Wilson" and "Score" are synonyms here.
 
     Parameters
@@ -65,37 +66,37 @@ def propn_ci(
        https://doi.org/10.1080/00031305.1998.10480550
 
     """
-
-    for _f in _npos, _nobs:
-        if not isinstance(_f, int | np.integer):
-            raise ValueError(
-                f"Count, {_f!r} must have type that is a subtype of np.integer."
-            )
-
-    if not _nobs:
-        return (np.nan, np.nan, np.nan, np.nan)
-
-    _raw_phat: ArrayDouble | float = _npos / _nobs
+    if any((
+        isinstance(_nobs, float) and not _nobs,
+        isinstance(_nobs, np.ndarray) and not _nobs.any(),
+        isinstance(_npos, float) and not _npos,
+        isinstance(_npos, np.ndarray) and not _npos.any(),
+    )):
+        return ArrayDouble([np.nan, np.nan, np.nan, np.nan])
+
+    _raw_phat = (
+        ArrayDouble(_npos / _nobs) if isinstance(_npos, np.ndarray) else _npos / _nobs
+    )
     _est_phat: ArrayDouble | float
     _est_ci_l: ArrayDouble | float
     _est_ci_u: ArrayDouble | float
 
     match method:
         case "Clopper-Pearson" | "Exact":
-            _est_ci_l, _est_ci_u = (
-                beta.ppf(*_f)
-                for _f in (
+            _est_ci_l, _est_ci_u = starmap(
+                beta.ppf,
+                (
                     (alpha / 2, _npos, _nobs - _npos + 1),
                     (1 - alpha / 2, _npos + 1, _nobs - _npos),
-                )
+                ),
             )
-            _est_phat = 1 / 2 * (_est_ci_l + _est_ci_u)
+            _est_phat = 1 / 2 * (_est_ci_l + _est_ci_u)  # type: ignore
 
         case "Agresti-Coull":
             _zsc = norm.ppf(1 - alpha / 2)
             _zscsq = _zsc * _zsc
             _adjmt = 4 if alpha == 0.05 else _zscsq
-            _est_phat = (_npos + _adjmt / 2) / (_nobs + _adjmt)
+            _est_phat = (_npos + _adjmt / 2) / (_nobs + _adjmt)  # type: ignore
             _est_ci_l, _est_ci_u = (
                 _est_phat + _g
                 for _g in [
@@ -120,7 +121,8 @@ def propn_ci(
         case _:
             raise ValueError(f"Method, {f'"{method}"'} not yet implemented.")
 
-    return _raw_phat, _est_phat, _est_ci_l, _est_ci_u
+    retlist = [_raw_phat, _est_phat, _est_ci_l, _est_ci_u]
+    return ArrayDouble(retlist if isinstance(_npos, int) else np.hstack(retlist))  # type: ignore
 
 
 def propn_ci_multinomial(
@@ -165,18 +167,22 @@ def propn_ci_multinomial(
 
     if alternative == "default":
         _ci_len_half = np.sqrt(_chi2_cr * (_chi2_cr + 4 * _n * _prob * (1 - _prob)))
-        return np.column_stack([
-            (_chi2_cr + 2 * _counts + _f * _ci_len_half) / (2 * (_n + _chi2_cr))
-            for _f in (-1, 1)
-        ])
+        return ArrayDouble(
+            np.column_stack([
+                (_chi2_cr + 2 * _counts + _f * _ci_len_half) / (2 * (_n + _chi2_cr))
+                for _f in (-1, 1)
+            ])
+        )
 
     elif alternative == "simplified":
         _ci_len_half = np.sqrt(_chi2_cr * _prob * (1 - _prob) / _n)
-        return np.column_stack([_prob + _f * _ci_len_half for _f in (-1, 1)])
+        return ArrayDouble(
+            np.column_stack([_prob + _f * _ci_len_half for _f in (-1, 1)])
+        )
 
     else:
         raise ValueError(
-            f"Invalid value, {f'"{alternative}"'} for, \"alternative\". "
+            f'Invalid value, {f'"{alternative}"'} for, "alternative". '
             f"Must be one of '{'("default", "simplified")'}'."
         )
 
@@ -190,7 +196,7 @@ def propn_diff_ci(
     *,
     alpha: float = 0.05,
     method: Literal["Agresti-Caffo", "Mee", "M-N", "Newcombe", "Score"] = "M-N",
-) -> tuple[float, float, float, float]:
+) -> ArrayDouble:
     R"""Confidence intervals for differences in binomial proportions.
 
     Methods available are Agresti-Caffo [4]_, Mee [5]_, Meitinen-Nurminen [5]_ [6]_
@@ -239,7 +245,7 @@ def propn_diff_ci(
             )
 
     if not min(_nobs1, _nobs2):
-        return (np.nan, np.nan, np.nan, np.nan)
+        return ArrayDouble((np.nan, np.nan, np.nan, np.nan))
 
     match method:
         case "Agresti-Caffo":
@@ -260,7 +266,7 @@ def propn_diff_ci(
         case _:
             raise ValueError(f"Method, {f'"{method}"'} not implemented.")
 
-    return _res
+    return ArrayDouble(_res)
 
 
 def _propn_diff_ci_agresti_caffo(
@@ -276,7 +282,6 @@ def _propn_diff_ci_agresti_caffo(
     Estimate Agresti-Caffo confidence intervals for differences of
     multiple proportions.
     """
-
     _diff_hat = _npos1 / _nobs1 - _npos2 / _nobs2
 
     _zsc = norm.ppf(1 - alpha / 2)
@@ -327,16 +332,18 @@ def _propn_diff_ci_newcombe_score(
 
 
 def _propn_diff_ci_mn(
-    _npos1: int = 4,
-    _nobs1: int = 10,
-    _npos2: int = 4,
-    _nobs2: int = 10,
+    _npos1: int | np.integer = 4,
+    _nobs1: int | np.integer = 10,
+    _npos2: int | np.integer = 4,
+    _nobs2: int | np.integer = 10,
     /,
     *,
     alpha: float = 0.05,
     method: Literal["M-N", "Mee"] = "M-N",
 ) -> tuple[float, float, float, float]:
     """
+    Meittinen-Nurminen (1985; Newcombe (1998)).
+
     See Miettinen and Nurminen (1985; Newcombe (1998);
         and StasAndCIs.r -> BinomDiffCi -> "mn".
 
@@ -354,7 +361,7 @@ def _propn_diff_ci_mn(
 
     _ci_est_start = np.array([(_diff_hat + _s) / 2 for _s in (-1, 1)])
     # Avoid potential corner cases
-    _ci_est_offset = (1 - 1.055e-2, 1)
+    _ci_est_offset = (1 - 1.025e-2, 1)
     if _diff_hat == 1.0:
         _ci_est_start += _ci_est_offset
     elif _diff_hat == -1.0:
@@ -384,8 +391,12 @@ def _propn_diff_chisq_mn(
     *,
     method: Literal["M-N", "Mee"] = "M-N",
 ) -> float:
-    R"""Estimate the :math:`\chi^2` statistic for the Meittinen-Nurminen (1985),
-    and Newcombe (1998) confidence intervals for a difference in binomial proportions.
+    R"""
+    Estimate :math:`\chi^2` statistic for a difference in binomial proportions.
+
+    This  :math:`\chi^2` statistic is used in the methods of Meittinen-Nurminen (1985),
+    and Newcombe (1998) for estimating confidence intervals for a difference in
+    binomial proportions.
 
     Parameters
     ----------
@@ -454,7 +465,6 @@ def propn_diff_ci_multinomial(
         Array of confidence intervals
 
     """
-
     if len(_counts.shape) > 2:
         raise ValueError(
             "This implementation is only valid for estimating confidence intervals "
@@ -465,7 +475,9 @@ def propn_diff_ci_multinomial(
     _var = np.einsum("jk->j", _prob * (1 - _prob) / _counts)[:, None]
 
     _d, _d_cr = np.diff(_prob, axis=1), norm.ppf(1 - (alpha / len(_counts)))
-    return np.column_stack([_d + _f * _d_cr * np.sqrt(_var) for _f in (-1, 1)])
+    return ArrayDouble(
+        np.column_stack([_d + _f * _d_cr * np.sqrt(_var) for _f in (-1, 1)])
+    )
 
 
 @dataclass(slots=True, frozen=True)
@@ -496,7 +508,6 @@ def propn_test_multinomial(
         Estimated statistic, degrees of freedom, critical value, p-value
 
     """
-
     _n = np.einsum("jk->", _counts).astype(np.int64)
     _n_k = np.einsum("jk->k", _counts).astype(np.int64)
     _prob = _counts / _n_k

mergeron_extra/tol_colors.py

@@ -16,6 +16,7 @@ from collections.abc import Callable, Sequence
 from typing import Final, Literal, TypeAlias
 
 import numpy as np
+from matplotlib import pyplot as plt
 from matplotlib.colors import LinearSegmentedColormap, to_rgba_array
 
 
@@ -670,18 +671,55 @@ TCName: TypeAlias = Literal[
     "bright", "high-contrast", "vibrant", "muted", "medium-contrast", "light"
 ]
 TCNameList: TypeAlias = tuple[TCName, ...]
-Bcset = namedtuple("Bcset", "blue red green yellow cyan purple grey black")
-Hcset = namedtuple("Hcset", "blue yellow red black")
-Vcset = namedtuple("Vcset", "orange blue cyan magenta red teal grey black")
+Bcset = namedtuple(
+    "Bcset", ["blue", "red", "green", "yellow", "cyan", "purple", "grey", "black"]
+)
+Hcset = namedtuple("Hcset", ["blue", "yellow", "red", "black"])
+Vcset = namedtuple(
+    "Vcset", ["orange", "blue", "cyan", "magenta", "red", "teal", "grey", "black"]
+)
 Muset = namedtuple(
-    "Muset", "rose indigo sand green cyan wine teal olive purple pale_grey black"
+    "Muset",
+    [
+        "rose",
+        "indigo",
+        "sand",
+        "green",
+        "cyan",
+        "wine",
+        "teal",
+        "olive",
+        "purple",
+        "pale_grey",
+        "black",
+    ],
 )
 Mcset = namedtuple(
-    "Mcset", "light_blue dark_blue light_yellow dark_red dark_yellow light_red black"
+    "Mcset",
+    [
+        "light_blue",
+        "dark_blue",
+        "light_yellow",
+        "dark_red",
+        "dark_yellow",
+        "light_red",
+        "black",
+    ],
 )
 Lcset = namedtuple(
     "Lcset",
-    "light_blue orange light_yellow pink light_cyan mint pear olive pale_grey black",
+    [
+        "light_blue",
+        "orange",
+        "light_yellow",
+        "pink",
+        "light_cyan",
+        "mint",
+        "pear",
+        "olive",
+        "pale_grey",
+        "black",
+    ],
 )
 
 
@@ -781,7 +819,6 @@ def tol_cset(  # noqa: PLR0911
 
 
 def main() -> None:
-    from matplotlib import pyplot as plt
 
     # Change default colorset (for lines) and colormap (for maps).
     #    plt.rc('axes', prop_cycle=plt.cycler('color', list(tol_cset('bright'))))

mergeron_extra/xlsxw_helper.py

@@ -25,7 +25,7 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from types import MappingProxyType
-from typing import Any, ClassVar, Literal, TypeAlias, TypedDict, overload
+from typing import Any, ClassVar, Literal, TypedDict, overload
 
 import numpy as np
 from aenum import Enum, extend_enum, unique  # type: ignore
@@ -39,38 +39,39 @@ from . import VERSION
 __version__ = VERSION
 
 
-XLBorderType: TypeAlias = Literal[
-    "none",
-    "thin",
-    "medium",
-    "dashed",
-    "dotted",
-    "thick",
-    "double",
-    "hair",
-    "medium_dashed",
-    "dash_dot",
-    "medium_dash_dot",
-    "dash_dot_dot",
-    "medium_dash_dot_dot",
-    "slant_dash_dot",
-    True,
-    False,
-    0,
-    1,
-    2,
-    3,
-    4,
-    5,
-    6,
-    7,
-    8,
-    9,
-    10,
-    11,
-    12,
-    13,
-]
+type XLBorderType = (
+    Literal[
+        "none",
+        "thin",
+        "medium",
+        "dashed",
+        "dotted",
+        "thick",
+        "double",
+        "hair",
+        "medium_dashed",
+        "dash_dot",
+        "medium_dash_dot",
+        "dash_dot_dot",
+        "medium_dash_dot_dot",
+        "slant_dash_dot",
+        0,
+        1,
+        2,
+        3,
+        4,
+        5,
+        6,
+        7,
+        8,
+        9,
+        10,
+        11,
+        12,
+        13,
+    ]
+    | bool
+)
 
 
 class CFmtVal(TypedDict, total=False):
@@ -91,18 +92,12 @@ class CFmtVal(TypedDict, total=False):
     shrink: bool
     bold: bool
     italic: bool
-    underline: Literal[
-        True,
-        False,
-        1,
-        2,
-        33,
-        34,
-        "single",
-        "double",
-        "accountingSingle",
-        "accountingDouble",
-    ]
+    underline: (
+        bool
+        | Literal[
+            1, 2, 33, 34, "single", "double", "accountingSingle", "accountingDouble"
+        ]
+    )
     font_strikeout: bool
     font_script: Literal[1, 2]
 
@@ -261,7 +256,14 @@ class CFmt(Enum):  # type: ignore
     def xl_fmt(
         cls,
         _xl_book: Workbook,
-        _cell_format: Sequence[CFmt | Sequence[CFmt]] | CFmt | None,
+        _cell_format: CFmt
+        | MappingProxyType[CFmtVal, Any]
+        | Sequence[
+            CFmt
+            | MappingProxyType[CFmtVal, Any]
+            | Sequence[CFmt | MappingProxyType[CFmtVal, Any]]
+        ]
+        | None,
         /,
     ) -> Format:
         """
@@ -290,17 +292,17 @@ class CFmt(Enum):  # type: ignore
         if isinstance(_cell_format, Format):
             return _cell_format
         elif _cell_format is None:
-            return _xl_book.add_format(CFmt.XL_DEFAULT.value)
+            return _xl_book.add_format(CFmt.XL_DEFAULT.value)  # type: ignore
 
         _cell_format_dict: CFmtVal = {}
         if isinstance(_cell_format, Sequence):
-            cls.ensure_cell_format_spec_tuple(_cell_format)
+            cls.ensure_cell_format_spec_tuple(_cell_format)  # type: ignore
             for _cf in _cell_format:
                 if isinstance(_cf, Sequence):
                     for _cfi in _cf:
-                        _cell_format_dict |= _cfi.value
+                        _cell_format_dict |= _cfi.value  # type: ignore
                 else:
-                    _cell_format_dict |= _cf.value
+                    _cell_format_dict |= _cf.value  # type: ignore
         elif isinstance(_cell_format, CFmt):
             _cell_format_dict = _cell_format.value
         else:
@@ -502,7 +504,11 @@ def array_to_sheet(
     _num_cols = len(_data_table[0])
     _right_column_id = _col_id + _num_cols
 
-    _cell_format: Sequence[CFmt | Sequence[CFmt]]
+    _cell_format: Sequence[
+        CFmt
+        | MappingProxyType[CFmtVal, Any]
+        | Sequence[CFmt | MappingProxyType[CFmtVal, Any]]
+    ]
     if isinstance(cell_format, Sequence):
         if _num_rows > 1 and ragged_flag:
             raise ValueError(
@@ -517,7 +523,7 @@ def array_to_sheet(
     elif isinstance(cell_format, CFmt):
         _cell_format = (cell_format,) * len(_data_table[0])
     else:
-        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])
+        _cell_format = (CFmt.XL_DEFAULT,) * len(_data_table[0])  # type: ignore
 
     # construct vector of xlslwrter.format.Format objects
     _wbk_formats = tuple(CFmt.xl_fmt(_xl_book, _cf) for _cf in _cell_format)
@@ -527,7 +533,7 @@ def array_to_sheet(
             tuple(
                 CFmt.xl_fmt(
                     _xl_book,
-                    (*_cf, CFmt.BAR_FILL)
+                    (*_cf, CFmt.BAR_FILL)  # type: ignore
                     if isinstance(_cf, Sequence)
                     else (_cf, CFmt.BAR_FILL),
                 )

{mergeron_extra-2024.739148.7.dist-info → mergeron_extra-2026.739650.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: mergeron_extra
-Version: 2024.739148.7
+Version: 2026.739650.0
 Summary: Tools for users of the mergeron package.
-License: MIT
+License-Expression: MIT
 Author: Murthy Kambhampaty
 Author-email: smk@capeconomics.com
 Requires-Python: >=3.12,<4.0
@@ -14,13 +14,14 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Dist: aenum (>=3.1.15,<4.0.0)
+Requires-Dist: aenum (>=3.1.15)
 Requires-Dist: certifi (>=2023.11.17)
+Requires-Dist: frozendict (>=2.4.7)
 Requires-Dist: matplotlib (>=3.8)
+Requires-Dist: mergeron (>=2026.739636.0)
 Requires-Dist: numpy (>=2.0)
 Requires-Dist: scipy (>=1.12)
 Requires-Dist: xlsxwriter (>=3.1)
@@ -29,7 +30,7 @@ Description-Content-Type: text/x-rst
 mergeron-extra: Support package for users of `mergeron`
 =======================================================
 
-Modules potentially useful to users of the :code:`mergeron` package, but which do not implement the principal functions of the package, and are hence considered "extras"  or "external" modules. One of these modules is, in fact, repackaged here although published independently.
+Modules potentially useful to users of the :code:`mergeron` package. 
 
 The module :code:`mergeron_extra.proportions_tests` provides methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. This module is coded for conformance to the literature and to results from the corresponding modules in :code:`R`. Although written from scratch, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/). To access these directly:
 
@@ -37,7 +38,7 @@ The module :code:`mergeron_extra.proportions_tests` provides methods for estimat
 
     import mergeron_extra.proportions_tests as prci
 
-Module :code:`mergeron_extra.xlsxw_helper` is useful for writing highly formatted output to spreadsheets with xlsx format. The class, :code:`mergeron_extra.xlsxw_helper.CFmt` and function, :code:`mergeron_extra.xlsxw_helper.array_to_sheet` are of particular interest, and can be accessed as :code:`xlh.CFmt` and :code:`xlh.array_to_sheet` with the following import:
+Module :code:`mergeron_extra.xlsxw_helper` is useful for writing highly formatted output to spreadsheets with xlsx format. (Does not re-export the parent package, `xlsxwriter`.) The class, :code:`mergeron_extra.xlsxw_helper.CFmt` and function, :code:`mergeron_extra.xlsxw_helper.array_to_sheet` are of particular interest, and can be accessed as :code:`xlh.CFmt` and :code:`xlh.array_to_sheet` with the following import:
 
 .. code-block:: python
 

mergeron_extra-2026.739650.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+mergeron_extra/__init__.py,sha256=49kLOqlUfALOT5bwCXQHpjh6g2lNhciSGx4r7tQrguc,399
+mergeron_extra/proportions_tests.py,sha256=GWQ6rMhphe1XL55m8tuccGwshN9Tms9wmrfEZjpeaRw,15524
+mergeron_extra/py.types,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mergeron_extra/tol_colors.py,sha256=9x83ymz5xcmHAVmDzifLe_GZWvL03c7hxbKQW6XPLek,22626
+mergeron_extra/xlsxw_helper.py,sha256=WW8sSqPSChlVsi60r2W4HSRB52ZWlEp35d1StHJa1HQ,19358
+mergeron_extra-2026.739650.0.dist-info/METADATA,sha256=D2s5bB3KU_o7iCqVl93F4wgkrURv6tIEzV-c8Fezwxc,3620
+mergeron_extra-2026.739650.0.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+mergeron_extra-2026.739650.0.dist-info/RECORD,,

{mergeron_extra-2024.739148.7.dist-info → mergeron_extra-2026.739650.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.0.1
+Generator: poetry-core 2.3.1
 Root-Is-Purelib: true
 Tag: py3-none-any

mergeron_extra-2024.739148.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-mergeron_extra/__init__.py,sha256=ar78FdYer0GhrcAwnlBGsTruLHKB9D_SHvgIT0XWP1w,399
-mergeron_extra/proportions_tests.py,sha256=3mctgM09M8Aee3l1zAlsYW1t962Ndzvb6bZkd7NHp7c,15019
-mergeron_extra/py.types,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mergeron_extra/tol_colors.py,sha256=EgajNpN-BAlsD__E_-CgzGDRGy7j0rO97KpCTDdbZSc,22225
-mergeron_extra/xlsxw_helper.py,sha256=8OMolNzSIqyTEkBW8Oh0Vsb02nvI9Qv4MNDlm0Kc5tI,18947
-mergeron_extra-2024.739148.7.dist-info/METADATA,sha256=7UkLlFqqWDw8TKtfFoCo9yNUYO1kCHqpjL3Lrhk_f_4,3742
-mergeron_extra-2024.739148.7.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-mergeron_extra-2024.739148.7.dist-info/RECORD,,