growthcharts 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

growthcharts/child.py

@@ -1,6 +1,7 @@
 import pandas as pd
 import matplotlib.pyplot as plt
 import math
+import json
 from scipy.stats import norm
 
 from .patient import Patient
@@ -49,221 +50,380 @@ class Child(Patient):
 
         super().__init__(sex, age, wt, length)
 
-    def plot_wtage(self, title=None):
+    def plot_wtage(self, title=None, figsize=(12,7), show=True, ax=None):
         """
-        Plot weight-for-age growth chart with patient's measurement.
+    Plot weight-for-age growth chart for the child.
+
+    This method draws CDC percentile curves and overlays
+    the patient's weight measurement.
+
+    The returned figure can be customized, embedded in apps,
+    or saved as an image.
+
+    Args:
+        title (str, optional):
+            Custom title for the chart.
+
+        figsize (tuple, optional):
+            Figure size in inches (width, height).
+            Default is (12, 7).
+
+        show (bool, optional):
+            Whether to display the plot using matplotlib.
+            If False, the plot will not be shown.
+            Default is True.
+
+        ax (matplotlib.axes.Axes, optional):
+            Existing matplotlib Axes object for embedding
+            in custom layouts or applications.
+
+    Returns:
+        tuple:
+            (fig, ax)
+
+            fig : matplotlib.figure.Figure
+                The created matplotlib figure.
+
+            ax : matplotlib.axes.Axes
+                The axes containing the plot.
+    """
 
-        Args:
-            title (str, optional): Plot title.
-        """
         df = self.df_wtage
+        sex = self._normalize_sex()
 
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+        data = df[df['Sex'] == sex]
 
-        data = df[df['Sex'] == self.sex]
+        if ax is None:
+            fig, ax = plt.subplots(figsize=figsize)
+        else:
+            fig = ax.figure
 
-        plt.figure(figsize=(12, 7))
         for i, col in enumerate(self.agecolumns[1:]):
+
             if i in self.highlight_indices:
-                plt.plot(data['Agemos'], data[col],
-                         color='gray', linewidth=2, label=f'{title} {col}')
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='gray', linewidth=2,
+                    label=col
+                )
             else:
-                plt.plot(data['Agemos'], data[col],
-                         color='lightgray', linewidth=1)
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='lightgray', linewidth=1
+                )
 
         if self.wt is not None:
-            plt.scatter(self.age, self.wt, color='red', s=100, zorder=5)
+            ax.scatter(
+                self.age, self.wt,
+                color='red', s=100,
+                zorder=5, label="Patient"
+            )
 
-        plt.title(title)
-        plt.xlabel("age(month)")
-        plt.ylabel("Weight(Kg)")
-        plt.grid(True)
-        plt.legend()
-        plt.show()
+        ax.set_title(title or "Weight for Age")
+        ax.set_xlabel("Age (months)")
+        ax.set_ylabel("Weight (Kg)")
+        ax.grid(True)
+        ax.legend()
 
-    def plot_lenage(self, title=None):
-        """
-        Plot length-for-age growth chart with patient's measurement.
+        if show:
+            plt.show()
 
-        Args:
-            title (str, optional): Plot title.
+        return fig, ax
+
+
+    def plot_lenage(self, title=None, figsize=(12,7), show=True, ax=None):
         """
+    Plot length/height-for-age growth chart for the child.
+
+    This method draws CDC percentile curves and overlays
+    the patient's length or height measurement.
+
+    The output figure can be customized, embedded in
+    applications, or exported as an image file.
+
+    Args:
+        title (str, optional):
+            Custom title for the chart.
+
+        figsize (tuple, optional):
+            Figure size in inches (width, height).
+            Default is (12, 7).
+
+        show (bool, optional):
+            Whether to display the plot using matplotlib.
+            If False, the plot will not be shown.
+            Default is True.
+
+        ax (matplotlib.axes.Axes, optional):
+            Existing matplotlib Axes object for embedding
+            in custom layouts or applications.
+
+    Returns:
+        tuple:
+            (fig, ax)
+
+            fig : matplotlib.figure.Figure
+                The created matplotlib figure.
+
+            ax : matplotlib.axes.Axes
+                The axes containing the plot.
+    """
+
         df = self.df_lenage
+        sex = self._normalize_sex()
 
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+        data = df[df['Sex'] == sex]
 
-        data = df[df['Sex'] == self.sex]
+        if ax is None:
+            fig, ax = plt.subplots(figsize=figsize)
+        else:
+            fig = ax.figure
 
-        plt.figure(figsize=(14, 10))
         for i, col in enumerate(self.agecolumns[1:]):
+
             if i in self.highlight_indices:
-                plt.plot(data['Agemos'], data[col],
-                         color='gray', linewidth=2, label=f'{title} {col}')
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='gray', linewidth=2,
+                    label=col
+                )
             else:
-                plt.plot(data['Agemos'], data[col],
-                         color='lightgray', linewidth=1)
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='lightgray', linewidth=1
+                )
 
         if self.length is not None:
-            plt.scatter(self.age, self.length, color='red', s=100, zorder=5)
+            ax.scatter(
+                self.age, self.length,
+                color='red', s=100,
+                zorder=5, label="Patient"
+            )
 
-        plt.title(title)
-        plt.xlabel("age(month)")
-        plt.ylabel("Length(cm)")
-        plt.grid(True)
-        plt.legend()
-        plt.show()
+        ax.set_title(title or "Length for Age")
+        ax.set_xlabel("Age (months)")
+        ax.set_ylabel("Length (cm)")
+        ax.grid(True)
+        ax.legend()
 
-    def plot_bmiage(self, title=None):
-        """
-        Plot BMI-for-age growth chart with patient's measurement.
+        if show:
+            plt.show()
 
-        Args:
-            title (str, optional): Plot title.
+        return fig, ax
+
+
+    def plot_bmiage(self, title=None, figsize=(12,7), show=True, ax=None):
         """
+    Plot BMI-for-age growth chart for the child.
+
+    This method draws CDC BMI percentile curves and overlays
+    the patient's calculated BMI value.
+
+    The resulting figure can be modified, embedded in apps,
+    or saved to disk.
+
+    Args:
+        title (str, optional):
+            Custom title for the chart.
+
+        figsize (tuple, optional):
+            Figure size in inches (width, height).
+            Default is (12, 7).
+
+        show (bool, optional):
+            Whether to display the plot using matplotlib.
+            If False, the plot will not be shown.
+            Default is True.
+
+        ax (matplotlib.axes.Axes, optional):
+            Existing matplotlib Axes object for embedding
+            in custom layouts or applications.
+
+    Returns:
+        tuple:
+            (fig, ax)
+
+            fig : matplotlib.figure.Figure
+                The created matplotlib figure.
+
+            ax : matplotlib.axes.Axes
+                The axes containing the plot.
+    """
+
         df = self.df_bmiage
+        sex = self._normalize_sex()
 
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+        data = df[df['Sex'] == sex]
 
-        data = df[df['Sex'] == self.sex]
+        if ax is None:
+            fig, ax = plt.subplots(figsize=figsize)
+        else:
+            fig = ax.figure
 
-        plt.figure(figsize=(12, 7))
         for i, col in enumerate(self.agecolumns[1:]):
+
             if i in self.highlight_indices:
-                plt.plot(data['Agemos'], data[col],
-                         color='gray', linewidth=2, label=f'{title} {col}')
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='gray', linewidth=2,
+                    label=col
+                )
             else:
-                plt.plot(data['Agemos'], data[col],
-                         color='lightgray', linewidth=1)
+                ax.plot(
+                    data['Agemos'], data[col],
+                    color='lightgray', linewidth=1
+                )
 
-        if self.wt is not None and self.length is not None and self.length > 0:
-            plt.scatter(self.age, self.bmi, color='red', s=100, zorder=5)
+        if self.wt and self.length and self.length > 0:
+            ax.scatter(
+                self.age, self.bmi,
+                color='red', s=100,
+                zorder=5, label="Patient"
+            )
 
-        plt.title(title)
-        plt.xlabel("age(month)")
-        plt.ylabel("BMI")
-        plt.grid(True)
-        plt.legend()
-        plt.show()
+        ax.set_title(title or "BMI for Age")
+        ax.set_xlabel("Age (months)")
+        ax.set_ylabel("BMI")
+        ax.grid(True)
+        ax.legend()
 
-    def analyze_wtage(self):
-        """
-        Analyze weight-for-age using LMS method.
+        if show:
+            plt.show()
 
-        Returns:
-            dict: Z-score and percentile.
-        """
-        df = self.df_wtage
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+        return fig, ax
 
-        df2 = df[df['Sex'] == self.sex]
-        row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
 
-        L = float(row['L'].values[0])
-        M = float(row['M'].values[0])
-        S = float(row['S'].values[0])
+def analyze_wtage(self, return_json=False):
+    """
+    Analyze weight-for-age using LMS method.
 
-        if L != 0:
-            z = ((self.wt / M) ** L - 1) / (L * S)
-        else:
-            z = math.log(self.wt / M) / S
+    Args:
+        return_json (bool): If True, returns a JSON string. Default False.
 
-        percentile = norm.cdf(z) * 100
+    Returns:
+        dict or JSON: Z-score, percentile, and interpretation.
+    """
+    df = self.df_wtage
+    sex = self._normalize_sex()
+    df2 = df[df['Sex'] == sex]
 
-        return {
-            "Z": round(z, 2),
-            "Percentile": round(percentile, 2)
-        }
+    row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
+    L, M, S = float(row['L'].values[0]), float(row['M'].values[0]), float(row['S'].values[0])
 
-    def analyze_lenage(self):
-        """
-        Analyze length-for-age using LMS method.
+    if L != 0:
+        z = ((self.wt / M) ** L - 1) / (L * S)
+    else:
+        z = math.log(self.wt / M) / S
 
-        Returns:
-            dict: Z-score and percentile.
-        """
-        df = self.df_lenage
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+    percentile = norm.cdf(z) * 100
 
-        df2 = df[df['Sex'] == self.sex]
-        row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
+    result = {
+        "indicator": "Weight-for-Age",
+        "value": round(self.wt, 2),
+        "unit": None,
+        "Age_Months": round(self.age, 2),
+        "sex": "Male" if sex == "1" else "Female",
 
-        L = float(row['L'].values[0])
-        M = float(row['M'].values[0])
-        S = float(row['S'].values[0])
+        "z_score": round(z, 2),
+        "percentile": round(percentile, 1),
 
-        if L != 0:
-            z = ((self.length / M) ** L - 1) / (L * S)
-        else:
-            z = math.log(self.length / M) / S
+        "z_interpretation": self._interpret_z(z),
+        "percentile_interpretation": self._interpret_percentile(percentile)
+    }
 
-        percentile = norm.cdf(z) * 100
+    if return_json:
+        import json
+        return json.dumps(result)
 
-        return {
-            "Z": round(z, 2),
-            "Percentile": round(percentile, 2)
-        }
+    return result
 
-    def analyze_bmiage(self):
-        """
-        Analyze BMI-for-age using LMS method.
 
-        Returns:
-            dict: Z-score and percentile.
-        """
-        df = self.df_bmiage
-        self.sex = str(self.sex).lower()
-        if self.sex in ['m', '1']:
-            self.sex = '1'
-        elif self.sex in ['f', '2']:
-            self.sex = '2'
-        else:
-            raise TypeError('define sex as m or f')
+def analyze_lenage(self, return_json=False):
+    """
+    Analyze length-for-age using LMS method.
 
-        df2 = df[df['Sex'] == self.sex]
-        row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
+    Args:
+        return_json (bool): If True, returns a JSON string. Default False.
 
-        L = float(row['L'].values[0])
-        M = float(row['M'].values[0])
-        S = float(row['S'].values[0])
+    Returns:
+        dict or JSON: Z-score, percentile, and interpretation.
+    """
+    df = self.df_lenage
+    sex = self._normalize_sex()
+    df2 = df[df['Sex'] == sex]
 
-        if L != 0:
-            z = ((self.bmi / M) ** L - 1) / (L * S)
-        else:
-            z = math.log(self.bmi / M) / S
+    row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
+    L, M, S = float(row['L'].values[0]), float(row['M'].values[0]), float(row['S'].values[0])
+
+    if L != 0:
+        z = ((self.length / M) ** L - 1) / (L * S)
+    else:
+        z = math.log(self.length / M) / S
+
+    percentile = norm.cdf(z) * 100
+
+    result = {
+        "indicator": "Length-for-Age",
+        "value": round(self.length, 2),
+        "unit": None,
+        "Age_Months": round(self.age, 2),
+        "sex": "Male" if sex == "1" else "Female",
+
+        "z_score": round(z, 2),
+        "percentile": round(percentile, 1),
+
+        "z_interpretation": self._interpret_z(z),
+        "percentile_interpretation": self._interpret_percentile(percentile)
+    }
+
+    if return_json:
+        import json
+        return json.dumps(result)
+
+    return result
+
+
+def analyze_bmiage(self, return_json=False):
+    """
+    Analyze BMI-for-age using LMS method.
+
+    Args:
+        return_json (bool): If True, returns a JSON string. Default False.
+
+    Returns:
+        dict or JSON: Z-score, percentile, and interpretation.
+    """
+    df = self.df_bmiage
+    sex = self._normalize_sex()
+    df2 = df[df['Sex'] == sex]
+
+    row = df2.iloc[(df2['Agemos'] - self.age).abs().argsort()[:1]]
+    L, M, S = float(row['L'].values[0]), float(row['M'].values[0]), float(row['S'].values[0])
+
+    if L != 0:
+        z = ((self.bmi / M) ** L - 1) / (L * S)
+    else:
+        z = math.log(self.bmi / M) / S
+
+    percentile = norm.cdf(z) * 100
+
+    result = {
+        "indicator": "BMI-for-Age",
+        "value": round(self.bmi, 2),
+        "unit": None,
+        "Age_Months": round(self.age, 2),
+        "sex": "Male" if sex == "1" else "Female",
+
+        "z_score": round(z, 2),
+        "percentile": round(percentile, 1),
+
+        "z_interpretation": self._interpret_z(z),
+        "percentile_interpretation": self._interpret_percentile(percentile)
+    }
+
+    if return_json:
+        import json
+        return json.dumps(result)
 
-        percentile = norm.cdf(z) * 100
+    return result
 
-        return {
-            "Z": round(z, 2),
-            "Percentile": round(percentile, 2)
-        }