Merge pull request #100 from GeriLife/add-work-factories

Add caregiver role and work model factories, enhance data generation, and improve visualizations

Author: brylie

caregivers/factories.py

@@ -0,0 +1,12 @@
+import factory
+from factory import Sequence
+
+from .models import CaregiverRole
+
+
+class CaregiverRoleFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = CaregiverRole
+        django_get_or_create = ("name",)
+
+    name = Sequence(lambda n: f"Caregiver Role {n}")

common/management/commands/make_fake_data.py

@@ -3,27 +3,53 @@
 import datetime
 import random
 
+from caregivers.factories import CaregiverRoleFactory
 from homes.factories import HomeFactory
 from metrics.models import ResidentActivity
 from residents.factories import ResidentFactory, ResidencyFactory
+from work.factories import WorkTypeFactory, WorkFactory
 
 NUM_HOMES = 5
 NUM_RESIDENTS_PER_HOME = range(5, 10)
 NUM_ACTIVITIES_PER_RESIDENT = range(10, 120)
+NUM_WORK_ENTRIES = range(10, 30)
 ACTIVITY_DAYS_AGO = range(0, 90)
 ACTIVITY_MINUTES = range(30, 120)
+WORK_MINUTES = range(30, 480)
+
+# Predefined caregiver roles
+CAREGIVER_ROLES = ["Nurse", "Practical Nurse", "Staff", "Volunteer"]
+
+# Predefined work types
+WORK_TYPES = ["Medication", "Cooking", "Cleaning", "Recreation", "Hygiene", "Wellness"]
 
 
 class Command(BaseCommand):
-    help = "Creates fake homes, residents, residencies, and resident activities."
+    help = "Creates fake homes, residents, residencies, resident activities, caregiver roles, and work."
 
     def handle(self, *args, **options):
         with transaction.atomic():
+            self.stdout.write("Creating caregiver roles...")
+            caregiver_roles = []
+            for role_name in CAREGIVER_ROLES:
+                role = CaregiverRoleFactory(name=role_name)
+                caregiver_roles.append(role)
+
+            self.stdout.write("Creating work types...")
+            work_types = []
+            for work_type_name in WORK_TYPES:
+                work_type = WorkTypeFactory(name=work_type_name)
+                work_types.append(work_type)
+
+            self.stdout.write("Creating homes...")
             homes = HomeFactory.create_batch(NUM_HOMES)
             today = datetime.date.today()
 
             for home in homes:
                 num_residents = random.choice(NUM_RESIDENTS_PER_HOME)
+                self.stdout.write(
+                    f"Creating {num_residents} residents for {home.name}...",
+                )
                 residents = ResidentFactory.create_batch(num_residents)
 
                 residencies = [
@@ -59,4 +85,17 @@ def handle(self, *args, **options):
 
                 ResidentActivity.objects.bulk_create(all_activities)
 
+                # Create work entries for this home
+                self.stdout.write(f"Creating work entries for {home.name}...")
+                num_work_entries = random.choice(NUM_WORK_ENTRIES)
+                for _ in range(num_work_entries):
+                    WorkFactory.create(
+                        home=home,
+                        type=random.choice(work_types),
+                        caregiver_role=random.choice(caregiver_roles),
+                        date=today
+                        - datetime.timedelta(days=random.choice(ACTIVITY_DAYS_AGO)),
+                        duration_minutes=random.choice(WORK_MINUTES),
+                    )
+
         self.stdout.write(self.style.SUCCESS("Successfully created fake data"))

homes/charts.py

@@ -1,9 +1,9 @@
-from django.db.models import Sum
+from django.db.models import Sum, ExpressionWrapper, FloatField
 from django.utils.translation import gettext as _
 
 import pandas as pd
 import plotly.express as px
-from core.constants import DAY_MILLISECONDS
+from core.constants import DAY_MILLISECONDS, HOUR_MINUTES
 from homes.models import Home
 
 from homes.queries import (
@@ -76,7 +76,12 @@ def prepare_work_by_type_chart(home: Home) -> str:
     work_by_type = list(
         home.work_performed.values("type__name")
         .order_by("type__name")
-        .annotate(total_hours=Sum("duration_hours")),
+        .annotate(
+            total_hours=ExpressionWrapper(
+                Sum("duration_minutes") / HOUR_MINUTES,
+                output_field=FloatField(),
+            ),
+        ),
     )
 
     work_by_type_chart = px.bar(
@@ -88,16 +93,30 @@ def prepare_work_by_type_chart(home: Home) -> str:
             "type__name": _("Type of work"),
             "total_hours": _("Total hours"),
         },
-    ).to_html()
-    return work_by_type_chart
+        template="plotly_dark",
+    )
+
+    # Set plot background/paper color to transparent
+    work_by_type_chart.update_layout(
+        plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
+        font_color="#FFFFFF",
+    )
+
+    return work_by_type_chart.to_html()
 
 
 def prepare_work_by_caregiver_role_chart(home: Home) -> str:
     """Prepare the work hours by caregiver role chart."""
     work_by_caregiver_role = list(
         home.work_performed.values("caregiver_role__name")
         .order_by("caregiver_role__name")
-        .annotate(total_hours=Sum("duration_hours")),
+        .annotate(
+            total_hours=ExpressionWrapper(
+                Sum("duration_minutes") / HOUR_MINUTES,
+                output_field=FloatField(),
+            ),
+        ),
     )
 
     work_by_caregiver_role_chart = px.bar(
@@ -109,9 +128,17 @@ def prepare_work_by_caregiver_role_chart(home: Home) -> str:
             "caregiver_role__name": _("Caregiver role"),
             "total_hours": _("Total hours"),
         },
-    ).to_html()
+        template="plotly_dark",
+    )
 
-    return work_by_caregiver_role_chart
+    # Set plot background/paper color to transparent
+    work_by_caregiver_role_chart.update_layout(
+        plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
+        font_color="#FFFFFF",
+    )
+
+    return work_by_caregiver_role_chart.to_html()
 
 
 def prepare_daily_work_percent_by_caregiver_role_and_type_chart(home: Home) -> str:
@@ -134,6 +161,7 @@ def prepare_daily_work_percent_by_caregiver_role_and_type_chart(home: Home) -> s
         },
         # Add numeric text on bars
         text_auto=True,
+        template="plotly_dark",
     )
 
     # Format y-axis as percentages
@@ -149,6 +177,19 @@ def prepare_daily_work_percent_by_caregiver_role_and_type_chart(home: Home) -> s
         width=DAY_MILLISECONDS,
     )
 
+    # Set plot background/paper color to transparent
+    daily_work_percent_by_caregiver_role_and_type_chart.update_layout(
+        plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
+        font_color="#FFFFFF",
+    )
+
+    # Remove individual y-axis labels and add a single global one
+    daily_work_percent_by_caregiver_role_and_type_chart.update_yaxes(title_text="")
+    daily_work_percent_by_caregiver_role_and_type_chart.update_layout(
+        yaxis_title=_("Work percent"),
+    )
+
     return daily_work_percent_by_caregiver_role_and_type_chart.to_html()
 
 
@@ -169,6 +210,7 @@ def prepare_home_work_percent_by_caregiver_role_chart(home: Home) -> str:
             "home_name": "",
         },
         text_auto=True,
+        template="plotly_dark",
     )
 
     home_work_percent_by_caregiver_role_chart.update_layout(
@@ -181,7 +223,9 @@ def prepare_home_work_percent_by_caregiver_role_chart(home: Home) -> str:
             "pad": 0,
         },
         plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
         showlegend=False,
+        font_color="#FFFFFF",
         xaxis={
             "tickformat": ",.0%",
         },
@@ -213,9 +257,17 @@ def prepare_work_percent_by_caregiver_role_and_type_chart(
             "work_type": _("Type of work"),
         },
         text_auto=True,
+        template="plotly_dark",
     )
     work_percent_by_caregiver_role_and_type_chart.layout.yaxis.tickformat = ",.0%"
 
+    # Set plot background/paper color to transparent
+    work_percent_by_caregiver_role_and_type_chart.update_layout(
+        plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
+        font_color="#FFFFFF",
+    )
+
     return work_percent_by_caregiver_role_and_type_chart.to_html()
 
 
@@ -234,6 +286,14 @@ def prepare_work_by_caregiver_role_and_type_chart(
             "total_hours": _("Total hours"),
             "work_type": _("Type of work"),
         },
+        template="plotly_dark",
+    )
+
+    # Set plot background/paper color to transparent
+    work_by_caregiver_role_and_type_chart.update_layout(
+        plot_bgcolor="rgba(0, 0, 0, 0)",
+        paper_bgcolor="rgba(0, 0, 0, 0)",
+        font_color="#FFFFFF",
     )
 
     return work_by_caregiver_role_and_type_chart.to_html()

homes/queries.py

@@ -22,7 +22,7 @@ def get_daily_total_hours_by_role_and_work_type_with_percent(home_id):
             date,
             caregiver_role.name as role_name,
             work_type.name as work_type,
-            sum(duration_hours) as daily_total_hours
+            sum(duration_minutes) / 60.0 as daily_total_hours
         from work
         left join work_type on type_id = work_type.id
         left join caregiver_role on caregiver_role_id = caregiver_role.id
@@ -56,7 +56,7 @@ def get_total_hours_by_role_and_work_type_with_percent(home_id):
         select
             caregiver_role.name as role_name,
             work_type.name as work_type,
-            sum(duration_hours) as total_hours
+            sum(duration_minutes) / 60.0 as total_hours
         from work
         left join work_type on type_id = work_type.id
         left join caregiver_role on caregiver_role_id = caregiver_role.id
@@ -90,7 +90,7 @@ def get_home_total_hours_by_role_with_percent(home_id):
         select
             home.name as home_name,
             caregiver_role.name as role_name,
-            CAST(sum(duration_hours) as FLOAT) as total_hours
+            CAST(sum(duration_minutes) / 60.0 as FLOAT) as total_hours
         from work
         left join home on home_id = home.id
         left join caregiver_role on caregiver_role_id = caregiver_role.id

homes/templates/homes/home_detail.html

@@ -67,17 +67,16 @@ <h2 class="mt-3">{% translate "Current Residents" %}</h2>
             </table>
         {% endif %}
 
-        {% include "homes/home_detail_charts.html" %}
-
         <div class="row">
-            <!-- only load analytics charts if work has been recorded -->
+            <!-- only load analytics charts if activities have been recorded -->
             <h2>
-                {% translate "Work" %}
+                {% translate "Activities" %}
             </h2>
             {% if work_has_been_recorded %}
+                <p>{% translate "Activities recorded in the past 30 days" %}</p>
                 {% include "homes/home_detail_charts.html" %}
             {% else %}
-                <p>{% translate "No work has been recorded yet." %}</p>
+                <p>{% translate "No activities have been recorded yet." %}</p>
             {% endif %}
         </div>
     </div>

homes/templates/homes/home_detail_charts.html

@@ -1,3 +1,5 @@
+{% load i18n %}
+
 <div class="row">
     {{ activity_counts_by_resident_and_activity_type_chart|safe }}
 </div>
@@ -17,6 +19,10 @@
     </div>
 </div>
 
+<h2>{% translate "Work" %}</h2>
+
+<p>{% translate "Work recorded in the past 30 days." %}</p>
+
 <div class="row">
     {{ daily_work_percent_by_caregiver_role_and_type_chart|safe }}
 </div>

pyproject.toml

@@ -18,6 +18,7 @@ dependencies = [
     "plotly>=5.18.0,<6.0",
     "psycopg2-binary>=2.9.9,<3.0",
     "shortuuid>=1.0.11,<2.0",
+    "statsmodels>=0.14.4",
     "whitenoise>=6.6.0,<7.0",
 ]