Welcome to the KFRE Python Library Documentation!

Note

This documentation is for kfre stable version 0.1.12.

kfre is a Python library designed to estimate the risk of chronic kidney disease (CKD) progression using the Kidney Failure Risk Equation (KFRE) developed by Tangri et al. It provides risk assessments over two distinct timelines: 2 years and 5 years. The library is tailored for healthcare professionals and researchers, enabling precise CKD risk predictions based on patient data. It supports predictions for both males and females and includes adjustments for individuals from North American and non-North American regions.

Prerequisites

Before you install kfre, ensure your system meets the following requirements:

  • Python: version 3.6 or higher is required to run kfre.

Additionally, kfre depends on the following packages, which will be automatically installed when you install kfre:

  • numpy: version 1.18.5 or higher

  • pandas: version 1.0.5 or higher

  • matplotlib: version 3.2.2 or higher

  • seaborn: version 0.10.1 or higher

  • scikit-learn: version 0.23.1 or higher

Installation

You can install kfre directly from PyPI:

pip install kfre