Metadata-Version: 2.1
Name: PHStatsMethods
Version: 0.1.12
Summary: This is a python package to calculate statistics in public health, including indicators for Fingertips.
Home-page: https://github.com/DataS-DHSC/PHStatsMethods
Author: Department of Health and Social Care
Author-email: annabel.westermann@dhsc.gov.uk, hadley.nanayakkara@dhsc.gov.uk, cameron.stewart@dhsc.gov.uk, jack.burden@dhsc.gov.uk, thilaksan.vikneswaran@dhsc.gov.uk, paul.fryers@dhsc.gov.uk, karandeep.kaur@dhsc.gov.uk, phds@phe.gov.uk
License: GPL-3.0
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy >=1.24.0
Requires-Dist: pandas >=2.0.0
Requires-Dist: pytest >=8.0.0
Requires-Dist: scipy >=1.8.0
Requires-Dist: openpyxl >=3.1.0

# PHStatsMethods
This is a Python package to support analysts in the execution of statistical
methods approved for use in the production of Public Health indicators such as
those presented via [Fingertips](https://fingertips.phe.org.uk/). It
provides functions for the generation of Proportions, Rates, DSRs, ISRs,
Funnel plots and Means including confidence intervals for these statistics,
and a function for assigning data to quantiles.

Any feedback would be appreciated and can be provided using the Issues
section of the [PHStatsMethods GitHub
repository](https://github.com/DataS-DHSC/PHStatsMethods/issues).


## Installation
This packaged should be installed using pip:


    pip install PHStatsMethods


Or it can be compiled from source (still requires pip):

    pip install git+https://github.com/DataS-DHSC/PHStatsMethods.git

## Usage
PH_statistical_methods should be imported and used in line with standard python
conventions. It is suggested that if the whole package is to be imported 
then the following convention is used:
 
    import PHStatsMethods


For more information on any function, you can use:

    help(PHStatsMethods.function)

## Licence
This project is released under the [GPL-3](https://opensource.org/licenses/GPL-3.0)
licence.
