mergeron_extra 2024.739148.6

Tools for users of the mergeron package.

Modules potentially useful to users of the 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.

The module 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 R. Although written from scratch, the APIs implemented in the module included here are designed for consistency with the APIs in, statsmodels.stats.proportion from the package, statsmodels (https://pypi.org/project/statsmodels/). To access these directly:

import mergeron_extra.proportions_tests as prci

Module mergeron_extra.xlsxw_helper is useful for writing highly formatted output to spreadsheets with xlsx format. The class, mergeron_extra.xlsxw_helper.CFmt and function, mergeron_extra.xlsxw_helper.array_to_sheet are of particular interest, and can be accessed as xlh.CFmt and xlh.array_to_sheet with the following import:

import mergeron_extra.xlsxw_helper as xlh

A recent version of Paul Tol’s python module, tol_colors.py, which provides high-contrast color schemes for making displays with improved visibility for individuals with color-blindness, is redistributed within this package. Other than re-formatting and type annotation, the mergeron_extra.tol_colors module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The tol_colors.py module is distributed under the Standard 3-clause BSD license. To access the mergeron_extra.tol_colors module directly:

import mergeron_extra.tol_colors as ptc