pyprevent 0.1.3__cp311-none-win_amd64.whl

pyprevent/__init__.py

@@ -0,0 +1,16 @@
+from .ascvd_calc import (
+    batch_calculate_10_yr_ascvd_risk,
+    batch_calculate_30_yr_ascvd_risk,
+    calculate_10_yr_ascvd_risk,
+    calculate_30_yr_ascvd_risk,
+)
+
+
+from .heart_failure import (
+    batch_calculate_10_yr_heart_failure_risk,
+    batch_calculate_30_yr_heart_failure_risk,
+    calculate_10_yr_heart_failure_risk,
+    calculate_30_yr_heart_failure_risk,
+)
+
+from .cvd import *

pyprevent/ascvd_calc.py

@@ -0,0 +1,327 @@
+import numpy as np
+import pandas as pd
+from pyprevent import _pyprevent
+
+from .utils import _prepare_df_for_batch, _report_any_null_values
+
+
+def calculate_10_yr_ascvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 10-year risk of atherosclerotic cardiovascular disease (ASCVD).
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing ASCVD over the next 10 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 79.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 10-year ASCVD risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_10_yr_ascvd_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 10-year ASCVD risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_10_yr_ascvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def calculate_30_yr_ascvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 30-year risk of atherosclerotic cardiovascular disease (ASCVD).
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing ASCVD over the next 30 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 59.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 30-year ASCVD risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_30_yr_ascvd_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 30-year ASCVD risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_30_yr_ascvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def batch_calculate_10_yr_ascvd_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+     Batch calculate the 10-year risk of atherosclerotic cardiovascular disease (ASCVD) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 10-year ASCVD risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 79. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    numpy.ndarray: A numpy array of estimated 10-year ASCVD risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_10_yr_ascvd_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A np.array of estimated 10-year ASCVD risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_10_yr_ascvd_risk(df, **column_mappings)
+    # Returns: A np.array of estimated 10-year ASCVD risk percentages
+    """
+
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate ASCVD risk for each row
+    result = _pyprevent.calculate_10_yr_ascvd_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result
+
+
+def batch_calculate_30_yr_ascvd_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+    Batch calculate the 30-year risk of atherosclerotic cardiovascular disease (ASCVD) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 30-year ASCVD risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 59. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    numpy.ndarray: A list of estimated 30-year ASCVD risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_30_yr_ascvd_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A numpy array of estimated 30-year ASCVD risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_30_yr_ascvd_risk(df, **column_mappings)
+    # Returns: A numpy array of estimated 30-year ASCVD risk percentages
+    """
+    # Default column names
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate ASCVD risk for each row
+    result = _pyprevent.calculate_30_yr_ascvd_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result

pyprevent/cvd.py

@@ -0,0 +1,384 @@
+import numpy as np
+import pandas as pd
+from pyprevent import _pyprevent
+
+from .utils import _prepare_df_for_batch, _report_any_null_values
+
+"""
+def calculate_10_yr_ascvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    return _pyprevent.calculate_10_yr_ascvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def calculate_30_yr_ascvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    return _pyprevent.calculate_30_yr_ascvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+"""
+
+
+def calculate_10_yr_cvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 10-year risk of cardiovascular disease .
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing CVD over the next 10 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 79.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 10-year CVD risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_10_yr_cvd_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 10-year CVD risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_10_yr_cvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def calculate_30_yr_cvd_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 30-year risk of cardiovascular disease (CVD).
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing CVD over the next 30 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 59.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 30-year CVD risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_30_yr_cvd_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 30-year CVD risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_30_yr_cvd_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def batch_calculate_10_yr_cvd_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+    Batch calculate the 10-year risk of cardiovascular disease (CVD) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 10-year CVD risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 79. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    np.ndarray: A numpy array of estimated 10-year CVD risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_10_yr_cvd_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A numpy array of estimated 10-year CVD risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_10_yr_cvd_risk(df, **column_mappings)
+    # Returns: A numpy array of estimated 10-year CVD risk percentages
+    """
+
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate ASCVD risk for each row
+    result = _pyprevent.calculate_10_yr_cvd_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result
+
+
+def batch_calculate_30_yr_cvd_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+    Batch calculate the 30-year risk of cardiovascular disease (CVD) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 30-year CVD risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 59. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    np.ndarray: A numpy array of estimated 30-year CVD risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_30_yr_cvd_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A numpy array of estimated 30-year CVD risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_30_yr_cvd_risk(df, **column_mappings)
+    # Returns: A numpy array of estimated 30-year CVD risk percentages
+    """
+
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate ASCVD risk for each row
+    result = _pyprevent.calculate_30_yr_cvd_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result

pyprevent/heart_failure.py

@@ -0,0 +1,327 @@
+import numpy as np
+import pandas as pd
+from pyprevent import _pyprevent
+
+from .utils import _prepare_df_for_batch, _report_any_null_values
+
+
+def calculate_10_yr_heart_failure_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 10-year risk of developing heart failure (HF).
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing HF over the next 10 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 79.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 10-year HF risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_10_yr_heart_failure_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 10-year HF risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_10_yr_heart_failure_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def calculate_30_yr_heart_failure_risk(
+    sex: str,
+    age: float,
+    total_cholesterol: float,
+    hdl_cholesterol: float,
+    systolic_bp: float,
+    has_diabetes: bool,
+    current_smoker: bool,
+    bmi: float,
+    egfr: float,
+    on_htn_meds: bool,
+    on_cholesterol_meds: bool,
+) -> float:
+    """
+    Calculate the 30-year risk of developing heart failure (HF).
+
+    This function uses various health and lifestyle parameters to estimate the risk
+    of developing HF over the next 30 years. The input values must fall within
+    specified ranges for the calculation to be valid.
+
+    Parameters:
+    - sex (str): The sex of the individual ('male' or 'female'). Case insensitive.
+    - age (float): Age of the individual in years. Must be between 30 and 59.
+    - total_cholesterol (float): Total cholesterol level (mg/dL). Must be between 130 and 320.
+    - hdl_cholesterol (float): High-density lipoprotein cholesterol level (mg/dL). Must be between 20 and 100.
+    - systolic_bp (float): Systolic blood pressure (mmHg). Must be between 90 and 200.
+    - has_diabetes (bool): Indicates if the individual has diabetes (True or False).
+    - current_smoker (bool): Indicates if the individual is a current smoker (True or False).
+    - bmi (float): Body mass index (kg/m^2). Must be between 18.5 and 39.9.
+    - egfr (float): Estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140.
+    - on_htn_meds (bool): Indicates if the individual is on hypertension medication (True or False).
+    - on_cholesterol_meds (bool): Indicates if the individual is on cholesterol-lowering medication (True or False).
+
+    Returns:
+    float: The estimated 30-year HF risk percentage.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges.
+
+    Example:
+    >>> calculate_30_yr_heart_failure_risk(
+    ...     sex="male",
+    ...     age=45,
+    ...     total_cholesterol=210,
+    ...     hdl_cholesterol=55,
+    ...     systolic_bp=130,
+    ...     has_diabetes=False,
+    ...     current_smoker=True,
+    ...     bmi=28,
+    ...     egfr=65,
+    ...     on_htn_meds=False,
+    ...     on_cholesterol_meds=False,
+    ... )
+    # Returns: Estimated 30-year CVD risk percentage (e.g., 12.3)
+    """
+    return _pyprevent.calculate_30_yr_heart_failure_rust(
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+    )
+
+
+def batch_calculate_10_yr_heart_failure_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+    Batch calculate the 10-year risk of heart failure (HF) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 10-year HF risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 79. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    np.ndarray: A numpy array of estimated 10-year HF risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_10_yr_heart_failure_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A numpy array of estimated 10-year HF risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_10_yr_heart_failure_risk(df, **column_mappings)
+    # Returns: A numpy array of estimated 10-year HF risk percentages
+    """
+
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate risk for each row
+    result = _pyprevent.calculate_10_yr_hf_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result
+
+
+def batch_calculate_30_yr_heart_failure_risk(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    """
+    Batch calculate the 30-year risk of heart failure (HF) for a dataset.
+
+    This function processes a DataFrame with health and lifestyle parameters to estimate
+    the 30-year HF risk for each individual in the dataset. The input values must fall
+    within specified ranges for the calculation to be valid.
+
+    Parameters:
+    - df (pd.DataFrame): DataFrame containing the required data.
+    - sex (str): Column name for the sex of the individuals ('male' or 'female'). Case insensitive. Default 'sex'.
+    - age (str): Column name for the age of the individuals in years. Must be between 30 and 59. Default 'age'.
+    - total_cholesterol (str): Column name for the total cholesterol level (mg/dL). Must be between 130 and 320. Default 'total_cholesterol'.
+    - hdl_cholesterol (str): Column name for the HDL cholesterol level (mg/dL). Must be between 20 and 100. Default 'hdl_cholesterol'.
+    - systolic_bp (str): Column name for the systolic blood pressure (mmHg). Must be between 90 and 200. Default 'systolic_bp'.
+    - has_diabetes (str): Column name indicating if the individual has diabetes (True or False). Default 'has_diabetes'.
+    - current_smoker (str): Column name indicating if the individual is a current smoker (True or False). Default 'current_smoker'.
+    - bmi (str): Column name for the body mass index (kg/m^2). Must be between 18.5 and 39.9. Default 'bmi'.
+    - egfr (str): Column name for the estimated glomerular filtration rate (mL/min/1.73 m^2). Must be between 15 and 140. Default 'egfr'.
+    - on_htn_meds (str): Column name indicating if the individual is on hypertension medication (True or False). Default 'on_htn_meds'.
+    - on_cholesterol_meds (str): Column name indicating if the individual is on cholesterol-lowering medication (True or False). Default 'on_cholesterol_meds'.
+    - **kwargs: Optional keyword arguments for custom column mappings.
+
+    Returns:
+    np.ndarray: A numpy array of estimated 30-year HF risk percentages for each individual in the DataFrame.
+
+    Raises:
+    ValueError: If any of the input parameters are outside their valid ranges or if the specified columns are not found in the DataFrame.
+
+    Example:
+    >>> df = pd.DataFrame({...})
+    >>> risks = batch_calculate_30_yr_heart_failure_risk(df, sex='gender', age='patient_age', ...)
+    >>> print(risks)
+    # Returns: A numpy array of estimated 30-year HF risk percentages
+
+    Alternatively, can pass in a dictionary of column mappings
+    >>> df = pd.DataFrame({...})
+    >>> column_mappings = {
+    ...     'sex': 'gender_column',
+    ...     'age': 'age_column',
+    ...     'total_cholesterol': 'cholesterol_total',
+    ...     'hdl_cholesterol': 'cholesterol_hdl',
+    ...     'systolic_bp': 'bp_systolic',
+    ...     'has_diabetes': 'diabetes_status',
+    ...     'current_smoker': 'smoker_status',
+    ...     'bmi': 'body_mass_index',
+    ...     'egfr': 'glomerular_rate',
+    ...     'on_htn_meds': 'hypertension_meds',
+    ...     'on_cholesterol_meds': 'cholesterol_meds'
+    ... }
+    >>> risks = batch_calculate_30_yr_heart_failure_risk(df, **column_mappings)
+    # Returns: A numpy array of estimated 30-year HF risk percentages
+    """
+    # Default column names
+    data = _prepare_df_for_batch(
+        df,
+        sex,
+        age,
+        total_cholesterol,
+        hdl_cholesterol,
+        systolic_bp,
+        has_diabetes,
+        current_smoker,
+        bmi,
+        egfr,
+        on_htn_meds,
+        on_cholesterol_meds,
+        **kwargs,
+    )
+
+    # Calculate risk for each row
+    result = _pyprevent.calculate_30_yr_hf_rust_parallel_np(data=data)
+    _report_any_null_values(result)
+
+    return result

pyprevent/utils.py

@@ -0,0 +1,69 @@
+import numpy as np
+import pandas as pd
+
+
+def _prepare_df_for_batch(
+    df: pd.DataFrame,
+    sex: str = "sex",
+    age: str = "age",
+    total_cholesterol: str = "total_cholesterol",
+    hdl_cholesterol: str = "hdl_cholesterol",
+    systolic_bp: str = "systolic_bp",
+    has_diabetes: str = "has_diabetes",
+    current_smoker: str = "current_smoker",
+    bmi: str = "bmi",
+    egfr: str = "egfr",
+    on_htn_meds: str = "on_htn_meds",
+    on_cholesterol_meds: str = "on_cholesterol_meds",
+    **kwargs,
+) -> np.ndarray:
+    # Default column names
+    column_mapping = {
+        "sex": sex,
+        "age": age,
+        "total_cholesterol": total_cholesterol,
+        "hdl_cholesterol": hdl_cholesterol,
+        "systolic_bp": systolic_bp,
+        "has_diabetes": has_diabetes,
+        "current_smoker": current_smoker,
+        "bmi": bmi,
+        "egfr": egfr,
+        "on_htn_meds": on_htn_meds,
+        "on_cholesterol_meds": on_cholesterol_meds,
+    }
+
+    # Update column names with mappings from kwargs if provided
+    column_mapping.update(kwargs)
+
+    # Ensure all required column names exist in the DataFrame
+    for key, col in column_mapping.items():
+        if col not in df.columns:
+            raise ValueError(
+                f"Column '{col}' for parameter '{key}' not found in DataFrame."
+            )
+
+    reordered_df = df[[column_mapping[key] for key in column_mapping]].copy()
+
+    sex_col = column_mapping["sex"]
+    reordered_df[sex_col] = (
+        reordered_df[sex_col].str.lower().map({"female": 0, "male": 1})
+    )
+
+    # Convert boolean columns to integers based on the column names from column_mapping
+    bool_cols = [
+        column_mapping["has_diabetes"],
+        column_mapping["current_smoker"],
+        column_mapping["on_htn_meds"],
+        column_mapping["on_cholesterol_meds"],
+    ]
+    reordered_df[bool_cols] = reordered_df[bool_cols].astype(int)
+    return reordered_df.values.astype(np.float64)
+
+
+def _report_any_null_values(result: np.ndarray) -> None:
+    null_rows = np.isnan(result).sum()
+    if null_rows > 0:
+        print(
+            f"WARNING: {null_rows} patients were unable to have the score calculated"
+            f"as their input parameters were out of the range."
+        )

pyprevent-0.1.3.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: pyprevent
+Version: 0.1.3
+License-File: LICENSE.txt
+Summary: Python implementation of 2024 AHA PREVENT calculator
+Author-email: lhegstrom@nference.net
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Source, https://github.com/lhegstrom/PyPrevent/
+Project-URL: Tracker, https://github.com/lhegstrom/PyPrevent/issues
+
+# PyPREVENT :anatomical_heart:
+
+###### 2024 updates from AHA on ASCVD (Atherosclerotic and Cardiovascular Disease), CVD (cardiovascular disease) and Heart Failure (HF)
+
+<h1 align="center">
+  <img src="https://github.com/lhegstrom/PyPREVENT/blob/main/images/PyPreventLogo.png?raw=true" width="100%">
+  <br>
+</h1>
+
+![Python- 3.7 --> 3.12](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
+
+## Introduction
+The PyPREVENT Equations package offers 2024 updates from the [American Heart Association (AHA) on Atherosclerotic and
+Cardiovascular Disease (ASCVD), Cardiovascular Disease (CVD), and Heart Failure
+(HF)](https://professional.heart.org/en/guidelines-and-statements/prevent-calculator)[^1][^2]. It's a mixed Rust and Python
+module, leveraging the speed of Rust for equation implementation and the flexibility of Python for ease of use.
+
+## Installation
+**Requirements:**
+- Python 3.7 to 3.12 on a Silicon Mac / Linux system (more compatibility coming soon)
+
+
+To install the package, pip install using:
+```bash
+pip install pyprevent
+```
+
+## TL;DR
+
+```python
+import pyprevent
+
+pyprevent.calculate_30_yr_ascvd_risk(
+    sex="MALE",
+    age=40,
+    total_cholesterol=200,
+    hdl_cholesterol=50,
+    systolic_bp=120,
+    has_diabetes=False,
+    current_smoker=False,
+    bmi=25,
+    egfr=70,
+    on_htn_meds=False,
+    on_cholesterol_meds=False,
+)
+```
+
+## Examples
+
+[A longer, and more thorough example is located here.](example_notebooks/Example%20Notebook.ipynb)
+
+
+## Implementation Status
+
+| Formula                          | Status             |
+|----------------------------------|--------------------|
+| 10 yr ASCVD (individual)         | :white_check_mark: |
+| 10 yr ASCVD (batch)              | :white_check_mark: |
+| 30 yr ASCVD (individual)         | :white_check_mark: |
+| 30 yr ASCVD (batch)              | :white_check_mark: |
+| 10 yr Heart Failure (individual) | :white_check_mark: |
+| 10 yr Heart Failure (batch)      | :white_check_mark: |
+| 30 yr Heart Failure (individual) | :white_check_mark: |
+| 30 yr Heart Failure (batch)      | :white_check_mark: |
+| 10 yr CVD (individual)           | :white_check_mark: |
+| 10 yr CVD (batch)                | :white_check_mark: |
+| 30 yr CVD (individual)           | :white_check_mark: |
+| 30 yr CVD (batch)                | :white_check_mark: |
+
+
+## Program Structure
+
+This is a mixed [Rust](https://www.rust-lang.org/) and Python module.
+
+The rust source code is used to implement the equations. This is a lower level language that requires compilation prior to being run -- and thus is many times faster than pure python.
+
+The rust source code is located in the /src directory.
+The individual functions are written in their respective files, and registered to the rust_aha_formulas python module within the lib.rs file.
+
+The python source is located in the /pyprevent directory.
+
+Unit tests are implemented in the /tests directory using [slash](https://getslash.github.io/slash/).
+
+
+[^1]: Khan SS, Matsushita K, Sang Y, et al. Development and Validation of the American Heart Association Predicting Risk of Cardiovascular Disease EVENTs (PREVENTTM) Equations. Circulation 2023. DOI: [10.1161/CIRCULATIONAHA.123.067626](https://www.ahajournals.org/doi/10.1161/CIRCULATIONAHA.123.067626)
+[^2]: Khan SS, Coresh J, Pencina MJ, et al. Novel Prediction Equations for Absolute Risk Assessment of Total Cardiovascular Disease Incorporating Cardiovascular-Kidney-Metabolic Health: A Scientific Statement From the American Heart Association. Circulation 2023;148(24):1982-2004. DOI: [10.1161/CIR.0000000000001191](https://www.ahajournals.org/doi/10.1161/CIR.0000000000001191)
+
+

pyprevent-0.1.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+pyprevent-0.1.3.dist-info/METADATA,sha256=9slpLJvRaMH3qIcklIvk3hAeDPw8J3_jIGSPHahLARg,4238
+pyprevent-0.1.3.dist-info/WHEEL,sha256=QWeP2iNVclb1lqJMYxkB3S_jGRNF2KI-alH1eOqR1Tk,95
+pyprevent-0.1.3.dist-info/license_files/LICENSE.txt,sha256=pKu9-Z5HMzqIf7cElXf6Sl6jNqCUKxVILnH3PcghAX4,1095
+pyprevent/ascvd_calc.py,sha256=TaZ8w-_8coUlvF2J-_908qUS_X6u3a6K154wxD5llNk,13924
+pyprevent/cvd.py,sha256=H-yhmEVT7baev_ySJIfEbFAi3hS-3sefmS2YDuVDr5M,14981
+pyprevent/heart_failure.py,sha256=I0bfm9LLBZcRMwdnshMECtCIxhXYhMeyAQ8xyfZayWE,13877
+pyprevent/utils.py,sha256=h8MSy11dVatiog1XnJkb9rZYIMTHpLJZHjyqc3_ZpdI,2304
+pyprevent/__init__.py,sha256=ccZ4SpVqycMpkqOIBra1NMlaxuhbFFWUgG5281ATrNA,409
+pyprevent/_pyprevent.cp311-win_amd64.pyd,sha256=x6-XfsHMwInQJ-nH2WkrXT4pCcT0_vok3dgfFKhJXAo,474624
+pyprevent-0.1.3.dist-info/RECORD,,

pyprevent-0.1.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.4.0)
+Root-Is-Purelib: false
+Tag: cp311-none-win_amd64

pyprevent-0.1.3.dist-info/license_files/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Lars Hegstrom, MD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.