Metadata-Version: 2.5
Name: healthiar
Version: 0.1.0
Summary: Python wrapper for the healthiar R package.
Project-URL: Homepage, https://swisstph.github.io/healthiar/index.html
Project-URL: Documentation, https://swisstph.github.io/healthiar/reference/index.html
Project-URL: Repository, https://github.com/SwissTPH/healthiar.git
Project-URL: Issues, https://github.com/SwissTPH/healthiar/issues
Author-email: Arno Pauwels <arno.pauwels@sciensano.be>, Gianni Ardielli <gianni.ardielli@swisstph.ch>
License-Expression: GPL-3.0-only
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9
Requires-Dist: geopandas
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: rioxarray
Requires-Dist: rpy2
Requires-Dist: scipy
Requires-Dist: xarray
Description-Content-Type: text/markdown

# healthiar

[![PyPI - Version](https://img.shields.io/pypi/v/healthiar.svg)](https://pypi.org/project/healthiar)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/healthiar.svg)](https://pypi.org/project/healthiar)

-----

## Table of Contents

- [Requirements](#requirements)
- [Installation](#installation)
- [Documentation](#documentation)
- [License](#license)

## Requirements

To use this Python package, you need [R](https://www.r-project.org/), with the [`healthiar`](https://cran.r-project.org/web/packages/healthiar/) package installed. Click [here](https://swisstph.github.io/healthiar/index.html#installation) for instructions on installing the R package.

| Software | Versions |
|----------|----------|
| Python   | >=3.9    |
| R        | >=4.5    |

## Installation

1.  Install the `healthiar` wrapper package with `pip`:

    ```console
    pip install healthiar
    ```
    Be aware that this does **not** install the `healthiar` R package.

2.  Add the path of your R installation as environment variable (**Required**):

    ```console
    import os
    os.environ["PATH"] = "/path/to/R/R-4.6.0/bin/x64"
    ```

## Documentation

For the documentation on using `healthiar`, we refer to the R package documentation:
- [Intro to healthiar](https://swisstph.github.io/healthiar/articles/intro_to_healthiar.html) vignette;
- [Using healthiar with Python](https://swisstph.github.io/healthiar/articles/using_healthiar_with_python.html) vignette;
- [Reference page](https://swisstph.github.io/healthiar/reference/index.html) of the package website.

## License

`healthiar` is distributed under the terms of the [GPL-3.0-only](https://spdx.org/licenses/GPL-3.0-only.html) license.
