Merge pull request #197 from PhilMiller/develop

#196: Add centralized presentation of model last change date

Author: quinn-dougherty

docs/CONTRIBUTING.md

@@ -30,6 +30,7 @@ As of March 21, help is especially wanted from contributors with experience in K
 - Request review from the relevant maintainer(s).
 - Check your pull request periodically to see if any changes have been requested or any merge conflicts have arisen.
 - If a merge conflict arises, rebase against the latest `develop` branch and force-push the new branch as early as you can. You may need to do this more than once before your changes get merged. Do your best to keep your branch in a mergeable state until it is finished being reviewed and accepted.
+- If your change affects the results calculated or presented, update `change_date` in `src/penn_chime/parameters.py` when the pull request is ready for merge, so users can see when results have last changed
 - Note: Frequent contributors with write access can submit pull requests from a new branch in the `CodeforPhilly/chime` repository.
 
 ## Review & Release

src/penn_chime/models.py

@@ -1,4 +1,9 @@
-"""Models."""
+"""Models.
+
+Changes affecting results or their presentation should also update
+parameters.py `change_date`, so users can see when results have last
+changed
+"""
 
 from typing import Generator, Tuple
 

src/penn_chime/parameters.py

@@ -1,4 +1,8 @@
-"""Parameters."""
+"""Parameters.
+
+Changes affecting results or their presentation should also update
+`change_date`, so users can see when results have last changed
+"""
 
 from numpy import log2  # type: ignore
 
@@ -128,3 +132,11 @@ def n_days(self, n_days: int):
             i_icu_v,
             i_ventilated_v,
         )
+
+    def change_date(self):
+        """
+        This reflects a date from which previously-run reports will no
+        longer match current results, indicating when users should
+        re-run their reports
+        """
+        return "March 23 2020"

src/penn_chime/presentation.py

@@ -45,7 +45,7 @@ def display_header(st, p):
         unsafe_allow_html=True,
     )
     st.markdown(
-        """**IMPORTANT NOTICE**: Admissions and Census calculations were previously **undercounting**. Please update your reports. See more about this issue [here](https://github.com/CodeForPhilly/chime/pull/190)."""
+        """**IMPORTANT NOTICE**: Admissions and Census calculations were previously **undercounting**. Please update your reports generated before """ + p.change_date() + """. See more about changes [here](https://github.com/CodeForPhilly/chime/labels/models)."""
     )
     st.markdown(
         """*This tool was developed by the [Predictive Healthcare team](http://predictivehealthcare.pennmedicine.org/) at