binomialbias


Namebinomialbias JSON
Version 1.3.2 PyPI version JSON
download
home_pagehttp://binomialbias.sciris.org
SummaryQuantitative assessment of discrimination based on the binomial distribution
upload_time2024-03-15 15:35:04
maintainer
docs_urlNone
authorP.A. Robinson, C. C. Kerr
requires_python
license
keywords binomial distribution discrimination bias sexism racism
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # BinomialBias

[![PyPI](https://badgen.net/pypi/v/binomialbias/?color=blue)](https://pypi.org/project/binomialbias)
[![Tests](https://github.com/thekerrlab/binomialbias/actions/workflows/tests.yaml/badge.svg)](https://github.com/thekerrlab/binomialbias/actions/workflows/tests.yaml?query=workflow)

This library computes and plots quantitative assessments of discrimination within organizations, based on the binomial distribution.

This code supports the following paper:

**Quantitative measures of discrimination with application to appointment processes.** Robinson PA, Kerr CC (2024). *PLoS ONE* 19(3): e0299870. https://doi.org/10.1371/journal.pone.0299870

There are several ways to use this library, described below.


## Webapp

A live webapp is running at https://binomialbias.sciris.org.


## Local installation and usage

### Python

To use locally with Python, run

    pip install binomialbias

This can then be run via e.g.:

    import binomialbias as bb
    bb.plot_bias(n=20, n_e=10, n_a=7)

This example shows the statistics for the case where there were `n = 20` appointments (e.g., the size of a committee), out of which `n_e = 10` people were expected to belong to a given group (e.g., female), and for which `n_a = 7` actually were.

### Shiny

To run the [Shiny](https://shiny.posit.co/py/) app locally, clone the repository from GitHub, then install with

    pip install -e .[app]

The Shiny app can then be run locally via the `run` script.


## Structure

- All code for the Python package is in the `binomialbias` folder.
- The script for generating the figure in the paper is in the `scripts` folder.
- Continuous integration tests are in the `tests` folder.
- Older Jupyter and Matplotlib versions are available in the `archive` folder.

            

Raw data

            {
    "_id": null,
    "home_page": "http://binomialbias.sciris.org",
    "name": "binomialbias",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "binomial distribution,discrimination,bias,sexism,racism",
    "author": "P.A. Robinson, C. C. Kerr",
    "author_email": "cliff@thekerrlab.com",
    "download_url": "https://files.pythonhosted.org/packages/99/fc/29f12c1458031117bb505c062aa9cc5883f015ae372da12c8090ffa5592f/binomialbias-1.3.2.tar.gz",
    "platform": "OS Independent",
    "description": "# BinomialBias\n\n[![PyPI](https://badgen.net/pypi/v/binomialbias/?color=blue)](https://pypi.org/project/binomialbias)\n[![Tests](https://github.com/thekerrlab/binomialbias/actions/workflows/tests.yaml/badge.svg)](https://github.com/thekerrlab/binomialbias/actions/workflows/tests.yaml?query=workflow)\n\nThis library computes and plots quantitative assessments of discrimination within organizations, based on the binomial distribution.\n\nThis code supports the following paper:\n\n**Quantitative measures of discrimination with application to appointment processes.** Robinson PA, Kerr CC (2024). *PLoS ONE* 19(3): e0299870. https://doi.org/10.1371/journal.pone.0299870\n\nThere are several ways to use this library, described below.\n\n\n## Webapp\n\nA live webapp is running at https://binomialbias.sciris.org.\n\n\n## Local installation and usage\n\n### Python\n\nTo use locally with Python, run\n\n    pip install binomialbias\n\nThis can then be run via e.g.:\n\n    import binomialbias as bb\n    bb.plot_bias(n=20, n_e=10, n_a=7)\n\nThis example shows the statistics for the case where there were `n = 20` appointments (e.g., the size of a committee), out of which `n_e = 10` people were expected to belong to a given group (e.g., female), and for which `n_a = 7` actually were.\n\n### Shiny\n\nTo run the [Shiny](https://shiny.posit.co/py/) app locally, clone the repository from GitHub, then install with\n\n    pip install -e .[app]\n\nThe Shiny app can then be run locally via the `run` script.\n\n\n## Structure\n\n- All code for the Python package is in the `binomialbias` folder.\n- The script for generating the figure in the paper is in the `scripts` folder.\n- Continuous integration tests are in the `tests` folder.\n- Older Jupyter and Matplotlib versions are available in the `archive` folder.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Quantitative assessment of discrimination based on the binomial distribution",
    "version": "1.3.2",
    "project_urls": {
        "Homepage": "http://binomialbias.sciris.org"
    },
    "split_keywords": [
        "binomial distribution",
        "discrimination",
        "bias",
        "sexism",
        "racism"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ae94caf88efb8db28cc063a089a2e269b5b5ae4c9ab361dab888d7f6813f139b",
                "md5": "a98e373243a7906372e2c4abfcb90923",
                "sha256": "80bdbed1ecaa308ef807707cf9164a43da640e0a0dbdd2896a8f988280ebab8f"
            },
            "downloads": -1,
            "filename": "binomialbias-1.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a98e373243a7906372e2c4abfcb90923",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18537,
            "upload_time": "2024-03-15T15:35:02",
            "upload_time_iso_8601": "2024-03-15T15:35:02.335499Z",
            "url": "https://files.pythonhosted.org/packages/ae/94/caf88efb8db28cc063a089a2e269b5b5ae4c9ab361dab888d7f6813f139b/binomialbias-1.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "99fc29f12c1458031117bb505c062aa9cc5883f015ae372da12c8090ffa5592f",
                "md5": "4143f13feaf112e4fa96fae2efad123a",
                "sha256": "b58cac105350046d3599cee8490454e8eb993316fe304fc17cd92ea5ac5ad0e4"
            },
            "downloads": -1,
            "filename": "binomialbias-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4143f13feaf112e4fa96fae2efad123a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 19859,
            "upload_time": "2024-03-15T15:35:04",
            "upload_time_iso_8601": "2024-03-15T15:35:04.255461Z",
            "url": "https://files.pythonhosted.org/packages/99/fc/29f12c1458031117bb505c062aa9cc5883f015ae372da12c8090ffa5592f/binomialbias-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-15 15:35:04",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "binomialbias"
}
        
Elapsed time: 0.24931s