mergeron_extra


Namemergeron_extra JSON
Version 2024.739148.6 PyPI version JSON
download
home_pageNone
SummaryTools for users of the mergeron package.
upload_time2024-10-20 17:48:38
maintainerNone
docs_urlNone
authorMurthy Kambhampaty
requires_python<4.0,>=3.12
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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.

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:

.. code-block:: python

    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:

.. code-block:: python

    import mergeron_extra.xlsxw_helper as xlh

A recent version of Paul Tol's python module, :code:`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 :code:`mergeron_extra.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The :code:`tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the :code:`mergeron_extra.tol_colors` module directly:

.. code-block:: python

    import mergeron_extra.tol_colors as ptc

.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
   :alt: Poetry
   :target: https://python-poetry.org/

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
   :alt: Ruff
   :target: https://github.com/astral-sh/ruff

.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
   :alt: Checked with mypy
   :target: https://mypy-lang.org/

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :alt: License: MIT
   :target: https://opensource.org/licenses/MIT


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mergeron_extra",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "Murthy Kambhampaty",
    "author_email": "smk@capeconomics.com",
    "download_url": "https://files.pythonhosted.org/packages/6f/4a/b78482bf56760bf9d34a0f847dcd65cdc11043721e945c84815b87898b09/mergeron_extra-2024.739148.6.tar.gz",
    "platform": null,
    "description": "mergeron-extra: Support package for users of `mergeron`\n=======================================================\n\nModules 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.\n\nThe 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:\n\n.. code-block:: python\n\n    import mergeron_extra.proportions_tests as prci\n\nModule :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:\n\n.. code-block:: python\n\n    import mergeron_extra.xlsxw_helper as xlh\n\nA recent version of Paul Tol's python module, :code:`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 :code:`mergeron_extra.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The :code:`tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the :code:`mergeron_extra.tol_colors` module directly:\n\n.. code-block:: python\n\n    import mergeron_extra.tol_colors as ptc\n\n.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json\n   :alt: Poetry\n   :target: https://python-poetry.org/\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n   :alt: Ruff\n   :target: https://github.com/astral-sh/ruff\n\n.. image:: https://www.mypy-lang.org/static/mypy_badge.svg\n   :alt: Checked with mypy\n   :target: https://mypy-lang.org/\n\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n   :alt: License: MIT\n   :target: https://opensource.org/licenses/MIT\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Tools for users of the mergeron package.",
    "version": "2024.739148.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38b2b9e57c0b037caf0d2b6c8d7bc65ec379b4600af297a726e448ffebf7e713",
                "md5": "4c8152edeee3936b3f4f332f1c42f40d",
                "sha256": "deae44eafc6c661727196edb06cb3201fb0c597881979b7d075b79cfdfe73657"
            },
            "downloads": -1,
            "filename": "mergeron_extra-2024.739148.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c8152edeee3936b3f4f332f1c42f40d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 16825,
            "upload_time": "2024-10-20T17:48:36",
            "upload_time_iso_8601": "2024-10-20T17:48:36.675586Z",
            "url": "https://files.pythonhosted.org/packages/38/b2/b9e57c0b037caf0d2b6c8d7bc65ec379b4600af297a726e448ffebf7e713/mergeron_extra-2024.739148.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f4ab78482bf56760bf9d34a0f847dcd65cdc11043721e945c84815b87898b09",
                "md5": "2de3983878a318901c7e113bcbdc4702",
                "sha256": "6a10d17dd2fc98bcd27ad52b5edb368a760dc4e34f000391dfca63cd45c58ec6"
            },
            "downloads": -1,
            "filename": "mergeron_extra-2024.739148.6.tar.gz",
            "has_sig": false,
            "md5_digest": "2de3983878a318901c7e113bcbdc4702",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 17823,
            "upload_time": "2024-10-20T17:48:38",
            "upload_time_iso_8601": "2024-10-20T17:48:38.310512Z",
            "url": "https://files.pythonhosted.org/packages/6f/4a/b78482bf56760bf9d34a0f847dcd65cdc11043721e945c84815b87898b09/mergeron_extra-2024.739148.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-20 17:48:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mergeron_extra"
}
        
Elapsed time: 0.39012s