Welcome to the KFRE Python Library Documentation!
Note
This documentation is for kfre stable version 0.1.18.
kfre is a Python library designed to estimate the risk of kidney failure in
patients with chronic kidney disease (CKD) 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 intended as a research and
validation tool for biostatisticians and data scientists working with patient
cohorts, enabling kidney failure 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.7.4or higher is required to runkfre.
Additionally, kfre depends on the following packages, which will be automatically installed when you install kfre:
numpy: version
1.18.5or higherpandas: version
1.0.5or highermatplotlib: version
3.2.2or higherseaborn: version
0.10.1or higherscikit-learn: version
0.23.1or highertqdm: version
4.0or higher
Installation
You can install kfre directly from PyPI:
pip install kfre
Table of Contents
Getting Started
- Welcome to the KFRE Python Library Documentation!
- Table of Contents
- Usage Guide
- Input Requirements and Common Pitfalls
- uPCR to uACR
- Calcium
- Phosphate
- Albumin
- Conversion Functions
- AUC ROC & Precision-Recall Curves
- Performance Metrics
- Bootstrap Confidence Intervals
- An Independent Validation of the Kidney Failure Risk Equation (KFRE) on a Seoul University Hospital Population
- Acknowledgements
- Testimonials
- Citing KFRE
- Changelog
- References
Documentation