ed-rhilbert / pyhealth

[For training purposes] An example python package to calculate health indicators

pyhealth

Python package to calculate health indicators

• Renan HILBERT
• v0.0.1 (July 2023)

Installation

 pip install git+https://github.com/ed-rhilbert/pyhealth

Getting started

>>> from pyhealth.calculations.calculate import calculate_bmi

>>> heights = [1.75, 1.65, 1.80]
>>> weights = [80, 55, 95.2]

>>> bmis = calculate_bmi(heights, weights)
>>> print(bmis)

[26.122448979591837, 20.202020202020204, 29.382716049382715]

Contribution

git clone [email protected]:ed-rhilbert/pyhealth.git
cd pyhealth/
python3 -m venv venv
source venv/bin activate
pip install -r requirements.txt
pip install -e .

Tests

pytest

Test with code coverage

pytest --cov

Documentation

TO DO

pyhealth's Issues

Ideal weight given height

User story

As a end-user, I want to calculate ideal weights given a list of persons' heights.

Integration with Pandas

User story

As a end-user, I want to be able to be able to directly calculate indicators given a pandas dataframe, so that I only have to indicate column's names for height, weight etc.

Weight category given the BMI

User story

As a end-user, I want to be able to affect a weight categories to a a list of persons given their heights and weights

Negative values are not detected

What happened ?

I tried to calculate the body mass indices with an erroneous negative value for a weight. It gave me no warning and returned a negative value.

What was expected ?

In this case, the BMI shoud be None as when height is zero.

How to reproduce ?

>>> from pyhealth.indicators.health import bmi
>>> bmi(2, -100)
-25.0

Height conversion cm -> m

User story

As a end-user, I want to be able to easily convert a list of heights in cm into m so that I can calculate BMIs with the existing methods.