Releases: shapiromatron/hawc
2024 - Q3
October 24th, 2024
We're proud to release 2024.Q3. This release features a new labelling tool, two new visualizations, and various export improvements.
Assessment members can now create and apply labels to visuals, data pivots, and summary tables to help categorize content within an assessment. Users can filter list pages by these labels and view all items with a given label on one page. This allows for better organization of various content within an assessment on HAWC. This is especially useful for large assessments with lots of visualizations in different health domains, for example.
Two new visualizations were introduced this quarter: PRISMA flow diagrams and literature Venn diagrams. PRISMA flow diagrams are available as a new visual type used for conveying an assessment's systematic review process. They were inspired by a recent paper by Walker et al. 2024. In the literature review module, users can compare tagged references using our new Venn diagram visualization option (alongside the existing tag tree visualization).
Export changes include a new style of reference export, a BMDS-friendly animal endpoint export, and exports for User Defined Fields. Existing imports have been improved, with new filters, new data fields, and drastic speed improvements for large animal exports.
A total of 51 pull requests were merged from 2024-07-10 to 2024-10-24. The complete changelog is described in summary below; the emoji legend describes how change bullets are categorized:
Global Updates:
- 🚀 Assessment labels by @rabstejnek in #1085 (September 27)
- 🚀 Study filter for exports by @munnsmunns in #1082 (August 28)
- 🚀 Reparse DSSTox content and add search index by @munnsmunns in #938 (September 04)
- 🚀 remove unused scripts by @shapiromatron in #1094 (September 05)
- 🐞 Add form prefixes to HTMX forms by @caseyhans in #1100 (September 24)
- 🐞 Catch FieldErrors and ValidationErrors in autocomplete by @munnsmunns in #1088 (August 28)
Study Evaluation / Risk of Bias:
- 🐞 Fix for conflict between SET url setting and url validation by @rabstejnek in #1111 (September 26)
Assessment Updates:
- 🚀 Update AssessmentValue global API by @shapiromatron in #955 (September 03)
- 🚀 Make AssessmentValue.study M2M by @munnsmunns in #1093 (September 19)
- 🚀 Remove Executive Summary feature by @munnsmunns in #1086 (August 29)
- 🚀 ADAF updates for Assessment values by @munnsmunns in #1110 (October 01)
User Interface (UI) Updates:
- 🚀 Update Downloads Page by @caseyhans in #1067 (September 03)
- 🧪 Labeled Items List by @caseyhans in #1091 (September 16)
Literature Review:
- 🚀 Long reference export by @shapiromatron in #1098 (September 18)
- 🚀 Literature tag venn diagrams by @shapiromatron in #1092 (September 18)
- 🐞 Bulk tagging JS fix by @rabstejnek in #1115 (October 03)
Animal Data Extraction:
- 🚀 CPHEAPM-28 Add ToxRefDB to Update Modules by @ZindahFarhaICF in #1073 (September 10)
- 🚀 CPHEAPM-26 - Add ToxRefDB vocab fixture and display by @ZindahFarhaICF in #1066 (September 09)
- 🚀 CPHEAPM-27 Add ToxRefDB to Update Vocab Endpoint by @ZindahFarhaICF in #1075 (September 10)
- 🚀 Animal export optimization by @rabstejnek in #1099 (September 20)
- 🚀 Client Update + BMD Export by @caseyhans in #1079 (September 18)
- 🚀 Add UDF to animal groups and datapivot exports by @caseyhans in #1104 (September 28)
Epidemiology Data Extraction:
- 🚀 Add countries to epiv1 datapivot export by @caseyhans in #1107 (September 24)
- 🚀 multiple worksheet epiv2 export by @shapiromatron in #1113 (October 03)
Visualizations:
- 🚀 create prisma ui by @munnsmunns in #1072 (September 05)
- 🚀 Add exports for Prisma plot by @munnsmunns in #1090 (September 05)
- 🚀 Add exports to Prisma Config form by @munnsmunns in #1097 (September 09)
- 🚀 Implement prisma diagram visual by @munnsmunns in #1105 (October 08)
- 🚀 update epiv2 study design visual fields by @caseyhans in #1116 (October 04)
- 🐞 Data pivot - fix conditional formatting on numeric data by @shapiromatron in #1122 (October 22)
Developer/Security updates:
- 🛠️ Update Ruff Rules by @caseyhans in #1080 (August 28)
- 🛠️ remove user_can_edit_assessment by @caseyhans in #1071 (August 28)
- 🛠️ Add scientific notation filter by @munnsmunns in #1077 (August 28)
- 🛠️ fix create_superuser command by @caseyhans in #1084 (August 28)
- 🛠️ Alert tag rewrite by @caseyhans in #1074 (August 29)
- 🧪 Add path for new HERO API in HERO-ID based import by @munnsmunns in #1070 (September 04)
- 🛠️ make all hawc imports relative instead of absolute by @shapiromatron in #1095 (September 05)
- 🛠️ Add coverage artifact by @shapiromatron in #1106 (September 18)
- 🛠️ add a user agent for external requests by @shapiromatron in #1096 (September 18)
- 🛠️ Change pandas pattern for empty dataframe by @caseyhans in #1109 (September 26)
- 🛠️ Add minimum Python coverage number by @shapiromatron in #1120 (October 16)
- 🐞 Fix display choices for swagger display
/admin/api/swagger/
by @shapiromatron in #1121 (October 22) - 🔒 Bump webpack from 5.88.2 to 5.94.0 in /frontend in #1101 (September 10)
- 🔒 update npm express by @shapiromatron in #1102 (September 10)
- 🔒 Bump micromatch from 4.0.5 to 4.0.8 in /frontend in #1103 (September 10)
- 🔒 Bump wagtail from 6.1.2 to 6.1.3 in #1068 (July 12)
- 🔒 update django from 5.0.6 to 5.0.7 by @shapiromatron in #1069 (July 12)
- 🔒 Upgrade django to 5.1 by @munnsmunns in #1083 (August 28)
Emoji legend:
- 🚀 Feature - this is a new feature or improvement to the existing application
- 🧪 In Progress - a feature actively under development; may not yet be available in production
- 🐞 Bug - fixed an error in the current software
- 📄 Documentation - updated user/developer documentation
- 🔒 Security Updates - security related updates
- 🛠️ Developer Tools - updated internal tooling for a better developer experience
2024 - Q2
July 11, 2024
This release is a collection of smaller user-facing updates to improve new features we've added over the last year, and larger infrastructure changes required to maintain the overall healthiness of the project.
For user-facing updates, we've continued to expand the functionality of User Defined Forms (UDF) released last quarter, adding a reference UDF display, data export downloads, and fixing a few bugs identified during testing. We've made some minor visualization updates as well - adding study evaluation data to epiv2 data pivot, and allowing users to determine which column to use to generate counts in exploratory heatmaps.
Our infrastructure for generating data exports was overhauled for speed and code readability; this was an 8-month effort and thousands of manual visualization inspections to ensure backwards compatibility with our previous approach. We've also expanded our test coverage to 92%, writing dozens of new tests to improve the stability and quality guarantees of HAWC.
A total of 50 updates were made from 2024-04-16 to 2024-07-11. The complete changelog is described in summary below; see the emoji legend which describes how changes are categorized:
Global Changes:
- 🚀 Allow anonymous contact us w/ turnstile enabled by @shapiromatron in #1018 (April 19)
- 🚀 Add a SQL select statement by @shapiromatron in #1035 (June 05)
- 🚀 Email verify post by @shapiromatron in #1019 (June 17)
- 🚀 Rewrite exports mechanism for large datasets (exports v2) by @rabstejnek in #1054 (July 02)
- 🐞 Update (exports v2) from image review by @shapiromatron in #1058 (July 02)
Assessment Updates:
- 🚀 Assessment Detail/Value adjustments by @munnsmunns in #1028 (June 05)
Literature Screening:
- 🐞 Fix identifier DOI dupe checks by @caseyhans in #1038 (June 05)
- 🐞 Fix bugs from demo by @caseyhans in #1061 (June 28)
- 🐞 UDF & Reference Filterset Change by @caseyhans in #1064 (July 02)
Data Tables and Visualizations:
- 🚀 Add RoB data to EpiV2 exports by @munnsmunns in #1039 (June 13)
- 🚀 Exploratory heatmap "count column" setting by @rabstejnek in #1034 (June 14)
- 🧪 Add PRISMA visual type view and JS stub by @munnsmunns in #1020 (June 13)
- 🐞 Fix study evaluation sort_order by @shapiromatron in #1052 (July 02)
- 🐞 SEM scroll fix by @caseyhans in #1013 (June 06)
User Defined Fields:
- 🚀 Standardize 'User Defined Fields' for UDFs by @munnsmunns in #1022 (June 06)
- 🚀 Display Reference UDF Data by @caseyhans in #1026 (June 14)
- 🚀 Add UDF logs by @caseyhans in #1023 (June 17)
- 🚀 Add UDF Export API by @caseyhans in #1027 (June 20)
- 🐞 UDF & Reference Filterset Change by @caseyhans in #1064 (July 02)
Ecological Data Extraction:
- 🚀 Eco - updates from review by @caseyhans in #1056 (June 28)
- 🚀 Eco - add deprecated badge on search view by @shapiromatron in #1060 (June 28)
Bugfixes:
- 🐞 Bugfixes from 2024.Q1 release by @shapiromatron in #1015 (April 19)
- 🐞 Make EHV download public by @caseyhans in #1036 (June 05)
- 🐞 Fix profile update redirect by @caseyhans in #1037 (June 05)
- 🐞 Clone name and ensure under size limit by @shapiromatron in #1021 (June 15)
Developer/Security updates:
- 🛠️ New permission classes by @shapiromatron in #1016 (April 19)
- 🛠️ Remove react-datepicker by @munnsmunns in #1017 (May 13)
- 🛠️ Update to PostgreSQL v 16 by @shapiromatron in #1029 (May 14)
- 🛠️ Remove uswds by @shapiromatron in #1031 (May 14)
- 🛠️ Remove requirements.txt by @shapiromatron in #1033 (June 05)
- 🛠️ Refactor HTMX Viewsets by @shapiromatron in #1012 (June 14)
- 🛠️ Developer quality of life improvements by @shapiromatron in #1040 (June 15)
- 🛠️ python package updates by @shapiromatron in #1046 (June 17)
- 🛠️ Replace and with bs4 tags by @munnsmunns in #1049 (June 27)
- 🛠️ Improve test coverage by @munnsmunns in #1051 (June 27)
- 🛠️ Add dev-header to full width of body instead of as a tab by @shapiromatron in #1057 (June 28)
- 🛠️ Add form helpers instead of repeating code by @shapiromatron in #1053 (June 28)
- 🛠️ Remove supported browser check - no longer relevant by @shapiromatron in #1059 (July 01)
- 🛠️ Add more tests by @shapiromatron in #1062 (July 01)
- 🔒 Update gunicorn by @shapiromatron (April 24)
- 🔒 Bump @babel/traverse from 7.22.8 to 7.24.5 in /frontend in #1025 (May 14)
- 🔒 Bump webpack-dev-middleware from 6.1.1 to 6.1.2 in /frontend in #1030 (May 14)
- 🔒 Bump glob-parent from 3.1.0 to 5.1.2 in /frontend in #1032 (May 14)
- 🔒 Update github action versions by @shapiromatron in #1024 (May 15)
- 🔒 Bump jinja2 from 3.1.2 to 3.1.4 in #1042 (June 05)
- 🔒 Bump requests from 2.31.0 to 2.32.2 in #1041 (June 05)
- 🔒 Bump express from 4.18.2 to 4.19.2 in /frontend in #1043 (June 15)
- 🔒 Bump postcss from 8.4.27 to 8.4.38 in /frontend in #1044 (June 15)
- 🔒 Bump braces from 3.0.2 to 3.0.3 in /frontend in #1045 (June 15)
- 🔒 Bump es5-ext from 0.10.62 to 0.10.64 in /frontend in #1047 (June 17)
- 🔒 Bump djangorestframework from 3.15.1 to 3.15.2 in #1063 (June 28)
- 🔒 Switch from python:3.12-slim-bullseye to centos:stream9-minimal by @shapiromatron in #1065 (July 02)
Emoji legend:
- 🚀 Feature - this is a new feature or improvement to the existing application
- 🧪 In Progress - a feature actively under development; may not yet be available in production
- 🐞 Bug - fixed an error in the current software
- 📄 Documentation - updated user/developer documentation
- 🔒 Security Updates - security related updates
- 🛠️ Developer Tools - updated internal tooling for a better developer experience
2024 - Q1
April 15, 2024
This release includes a new feature we've been developing for the last six months or so - User Defined Forms (UDF). HAWC has always had a fixed schema for data extraction; this was an intentional decision because we wanted to be able to visualize content and perform standardized data analysis across assessments. However, it came at the expense of flexibility. Adding UDFs will allow users to augment existing forms with custom fields for their assessment. Right now, we've added UDFs to literature tags, studies, and bioassay endpoints, but we expect to add more UDF options to other items in the future. We plan on adding UDF data exports and integration with existing visuals in the next release. Documentation is limited, but please reach out with any questions or comments - we'd love to hear your feedback!
Other notable updates include new options in Data Pivot visualizations (calculated columns, columns to the right of the plot), updated task table filtering, updated assessment analytics for epidemiology and study evaluation domains, and many minor user-interface improvements throughout HAWC based on user feedback.
A total of 42 pull requests were merged into HAWC from 2024-02-02 to 2024-04-15. The complete changelog is described in summary below; see the emoji legend which describes how changes are categorized:
Global Changes:
- 🚀 Rework task table and added more sorting options by @shapiromatron in #1000
- 🚀 Added task export by @shapiromatron in #999
- 🚀 Improve User Defined Form (UDF) creation + binding workflows views by @caseyhans in #989
- 🚀 Improve icon representing boolean by @caseyhans in #974
- 🚀 Display HTMX errors that were previously silent by @munnsmunns in #978
- 🚀 Add automated scrolling in HTMX forms by @caseyhans in #990
- 🐞 Improve recording of time spent by @shapiromatron in #996 #1007
Assessment:
- 🚀 Expand assessment analytics with epi and study evaluation data by @dannypeterson in #1010
- 🚀 Expand options for assessment details by @shapiromatron in #998
- 🐞 Fix assessment duplicates in search by @caseyhans in #1001
- 🐞 Fix label for assessment downloads by @shapiromatron in #973
Literature Screening and Tagging:
- 🚀 Added UDF to reference tagging by @munnsmunns in #913
- 🐞 Fix candidate tag filtering by @caseyhans in #977
- 🐞 Fix "needs further tagging" after consensus tags applied by @caseyhans in #1009
Data Extraction:
- 🚀 Added UDF to study forms and views by @munnsmunns in #906
- 🚀 Added UDF to bioassay endpoint forms and views by @munnsmunns in #906
- 🚀 Added "unpublished" parameter to animal client by @dannypeterson in #1011
- 🧪 Build initial data schema for animal v2 data extractions by @DookTibs in #947
Visualizations:
- Data Pivot:
- 🚀 Add calculated columns by @rabstejnek in #991
- 🚀 Add columns to the right of the figure by @shapiromatron in #987
- 🚀 Improve logscale domain estimate by @shapiromatron in #1002
- 🚀 Added additional fields to data pivot list API by @shapiromatron in #1005
- 🐞 Fix conditional formatting for discrete numeric values by @shapiromatron in #993
- Exploratory Heatmap:
- 🚀 Preview custom filter logic @rabstejnek in #986
- 🚀 Improve performance of data preview by @rabstejnek in #979
- Static image:
- 🚀 Added max width and alt-text image options by @shapiromatron in #1008
Developer/Security updates:
- 🔒 Add turnstile to unauthenticated user views by @shapiromatron in #1004
- 🔒 Add email verification checks for user accounts @shapiromatron in #1004
- 🔒 Disable deletion of some content in the admin by @shapiromatron in #981
- 🛠️ Add HTML template formatting @munnsmunns in #985
- 🛠️ Replace bleach with nh3 by @dannypeterson in #984
- 🛠️ Improve test coverage by @shapiromatron in #969
- 🛠️ Improve client visual downloader by @munnsmunns in #988
- 🛠️ Remove patch after proper fix upstream @munnsmunns in #975
- 🛠️ Replace pytest-vcr with pytest-recording by @dannypeterson in #994
- 🛠️ HTMX ViewSet URL updates by @rabstejnek in #992
- 🛠️ Remove create DTXSID by api by @dannypeterson in #995
- 🐞 Fix regression in choice fields by @shapiromatron in #983
- 🐞 Fix bug when returning Study IDs by @shapiromatron in #1006
- 🐞 Add ID check validator helper method @shapiromatron in #1003
- 🐞 Restrict EHV tag API to accept only integer for detail ID by @shapiromatron in #997
Emoji legend:
- 🚀 Feature - this is a new feature or improvement to the existing application
- 🧪 In Progress - a feature actively under development; may not yet be available in production
- 🐞 Bug - fixed an error in the current software
- 📄 Documentation - updated user/developer documentation
- 🔒 Security Updates - security related updates
- 🛠️ Developer Tools - updated internal tooling for a better developer experience
2023 - Q4
February 1, 2024
We're proud to release 2023.Q4. This release makes a number of improvements to our literature screening workflow, an assessment dashboard to highlight key analytics for your project, and a long-needed refresh for improving flexibility and performance of our data exports used in visualizations. Finally, we added a new visual type - an image upload, so we can more easily allow for other visualization types for which HAWC may not be capable of creating.
In the last six months we've released a number of updates in the literature screening module, and we've had some real-world applications which helped identify a few improvements to make the module more intuitive. The first is a workflow system, which allows users to set rules to create workflows for literature (for example, a title/abstract review, a full-text review, etc.). In addition, we added a bulk merge feature to conflict resolutions - this should make it easier to rapidly resolve conflicts, or accept all tags even if only one user has reviewed them (which can be helpful in some situations). We hope you'll find these features useful!
We have a few features that we're close to releasing that we made great progress on with this release. The first is an internal documentation site, so we can better add content for how to use HAWC and keep it up to date for our user base. The second is dramatic performance improvements to our exports, which should make them more flexible, and easier to add to new parts of our app (along with new visualization types). The third are user defined fields, which should be added in the future to our literature screening workflow as well as key data extraction models. We hope that these features will be available in our next release.
A total of 50 pull requests were merged into HAWC from 2023-10-07 to 2024-01-18. The complete changelog is described in summary below; see the emoji legend which describes how changes are categorized:
-
Global Updates:
- 🚀 Allow Sharepoint (sharepoint.com), Zenodo (zenodo.org), and Canadian Government (canada.ca) hyperlinks #924 #949
- 🚀 Add new option for users to show HAWC in debug mode #951
- 📄 Add a documentation application to add internal documentation for HAWC editors #950
- 🛠️ Update EPA flavor of application to use 2023 style guide #945 #960
-
Assessment:
-
Literature Review:
-
Study Evaluation / Risk of Bias:
-
Data Extraction: Animal Bioassay:
-
Data Extraction: Epidemiology:
-
Data Extraction: In Vitro:
- 🧪 Rewrite exports for improved performance #958
-
Visualizations:
-
Developer/Security updates:
- 🔒 Update to Python 3.12 #967
- 🔒 Update to Django 5 #959
- 🔒 Update python packages to most recent versions #928 #929
- 🔒 Update pydantic to v2 #948
- 🛠️ Improve view/form test code coverage #905
- 🛠️ Remove/refactor unused and duplicative code #799 #925 #926 #931
- 🛠️ Standardize template tags for easier use #920 #923
- 🛠️ Standardize assessment level APIs #935
- 🛠️ Standardize caching patterns #940
- 🛠️ Replace black with ruff formatter #942
- 🐞 Remove broken Zenodo badge from readme #954
- 🐞 Fix flaky tests to improve code stability #943 #968
Emoji legend:
- 🚀 Feature - this is a new feature or improvement to the existing application
- 🧪 In Progress - a feature actively under development; may not yet be available in production
- 🐞 Bug - fixed an error in the current software
- 📄 Documentation - updated user/developer documentation
- 🔒 Security Updates - security related updates
- 🛠️ Developer Tools - updated internal tooling for a better developer experience
2023 - Q3
October 17th, 2023
We're proud to release 2023.Q3! We've made a number of quality-of-life improvements this quarter based on user feedback. First, we've refined searching and filtering during literature screening and have updated how references are displayed. Second, we've added a new data export for study evaluation heatmaps; this export is now available on all existing visuals. Finally, we've added some new features to data pivots and exploratory heatmaps to enable more customization of their look and feel.
There's more work that we've been doing behind the scenes that we hope will allow us to add some substantial new features in future release. First, we've rewritten how data can be filtered for visualizations so we can filter more quickly and flexibly. This should allow us to add more visuals and filtering options in the future. Second, we're adding User Defined Forms (UDF), so that users can augment the existing tagging and extractions in HAWC with additional information that may be required for an assessment. This has long been requested over the years and we're excited to break ground on this work.
The complete changelog is described in summary below; see the emoji legend which describes how changes are categorized:
-
User Interface (UI) Updates:
- 🚀 Added
Unpublished
badge to studies, visuals, etc to better show team members the status of content under development #860 - 🚀 Text areas can be resized globally on all text boxes #883
- 🧪 Download filtered data for outcome lists (animal, epidemiology, etc.) #895
- 🐞 Converted assessment Log search form to new inline filter form layout #872
- 🚀 Added
-
Literature Review:
- 🚀 Added authors and year filter to literature review reference search #886
- 🚀 Add better full-text search capabilities #877
- 🚀 UI updates for References - simplify layout for detail and list reference views #878
- 🚀 Added a new "accept all" to accept all proposed tags during conflict resolution #908
- 🚀 Improve validation for full text URL uploads and display errors to users #887
- 🐞 Add db restraint to prevent duplicate (reference, user) pairs in User tags #890
- 🐞 Fix bug in keyword highlighting for literature tagging with special characters #878
-
Study Evaluation / Risk of Bias:
- 🐞 Fix duplicative studies shown in ROB assignment views #885
-
Data Extraction: Animal:
- 🚀 Update experiment comments label on detail view to be consistent with form #904
- 🚀 Animal summary endpoint exports now contain sample size 'N' #898
- 🚀 Calculate percent change relative to control calculated for dichotomous when possible #909 #915
- 🐞 Fixed bug where users couldn't set or view NOEL/LOEL for endpoints where data was not extracted #907
-
Data Extraction: Epidemiology:
-
Visualizations:
- 🚀 Study Evaluation Heatmaps - download data in tabular format using the actions button #892
- 🚀 Exploratory Heatmap - toggle display of counts and colors #916
- 🚀 Data Pivot - show arrows for confidence intervals when out of domain #874
- 🚀 Data Pivot - allow more flexibility with background colors and gridlines #874
- 🚀 Data Pivot - add more flexibility and precision with setting x-axis domains and display #874
- 🚀 Data Pivot - full read/write control via API #896
- 🚀 Visuals - full read/write control via API #896
- 🐞 Data pivot file upload error #894
- 🐞 Fix typos in visual list text #893
- 🐞 Fix deprecated Endpoint Aggregation visual form and remove dependencies #883
-
User Defined Forms (UDF):
-
Developer/Security updates:
- 🛠️ Installed django-browser-reload package for automated browser reloading in debug #881
- 🛠️ Remove dead code #900
- 🛠️ Convert text fields to JSON fields for visuals and data pivots #901
- 🛠️ Refactor prefilters for visuals and datapivots #876
- 🛠️ Standardize actions button menus #860
- 🛠️ Added utility method for generating tabular flat exports to remove duplicate code #873
- 🔒 Add setting to disable login attempts on some domains #879
- 🔒 Fixes from security scans #875 #884 #889
- 🔒 Updated Django to latest release #903
- 🔒 Updated docker container versions #910
Emoji legend:
- 🚀 Feature - this is a new feature or improvement to the existing application
- 🧪 In Progress - a feature actively under development; may not yet be available in production
- 🐞 Bug - fixed an error in the current software
- 📄 Documentation - updated user/developer documentation
- 🔒 Security Updates - security related updates
- 🛠️ Developer Tools - updated internal tooling for a better developer experience
2023-Q2
August 9th, 2023
We're proud to release 2023-Q2. Over the last few quarters, we've been internally developing new data extraction and visualization components in partnership with our scientists, and with this release, those features are made generally available. Specifically:
- Last year we released new data extraction modules for Epidemiology. This update integrates data extraction with existing data visualizations in HAWC, such as exploratory heatmaps and data pivots.
- We've released ecological data extraction, which, like epidemiology, is now fully integrated with our exploratory heatmap and data pivot visualizations.
- We've added an assessment metadata module to add high level project data to assessments (assessment type, current status, related documentation), as well as adding assessment values, if a HAWC assessment results in quantitative values as a conclusion.
In addition to these changes, we've overhauled searching and filtering throughout HAWC; filters should be faster and more intuitive. We added new customizations to assessments to show/hide items on the sidebar, to make it easier to only have links throughout an assessment to pages which have content.
The complete changelog is described below (features marked with the lab icon 🧪 indicate they're not yet available and are behind feature flags):
New Features:
- General improvements
- Literature screening
- Assessment configuration
- Study Evaluation
- Data Extraction: Animal Bioassay
- Data Extraction: Epidemiology
- Data Extraction: Ecology
- Assessment Values and Details
- Summary Tables and Visualizations
- Assorted User Requests
2023-Q1
April 13th, 2023
We're proud to release 2023.Q1. The primary feature in this release is the updated literature screening module with optional conflict resolution of tags. This features allows dual-screening of references in HAWC, and we hope this expands the types of systematic review methodologies that can be conducted from within HAWC.
In addition, we've made assorted quality of life updates throughout the application - assessment data downloads should be better organized and with more information about the underlying reference, study evaluation metrics and domains are now organized by health domain, and summary tables can now be set to filter and paginate for longer tables.
Finally, we're enabling a feature-flag system for future development to make it easier to add features that we can progressively roll out to users. We hope that this approach makes it easier for developers to update code with less context-switching, which ultimately should make us more efficient.
The complete changelog is described below (features marked 🧪 indicate they're not yet generally available and are behind feature flags):
New Features:
-
Literature Screening #756 #774 #752 #794 #789
- release literature tagging with conflict resolution
- rewrote literature summary pages and add new summary stats
- added reference counts to all pages where tag lists are displayed
- add user tag exports and filterable web views
-
Study Evaluation/Risk of Bias
- update the study evaluation domain/metric view to show questions by study type #790
- update study evaluation questions from NTP/OHAT and EPA/IRIS to current approaches; created tools to automate syncing in the future #771
- add study evaluation metric key field for easier copying of metrics across assessments #771
-
Data Extraction
- add API endpoint for epiv2 metadata settings, useful for automated machine extractions #766
- updated animal data extraction help text #764
- 🧪 release candidate for ecological data extraction #740 #746 #783 #784 #791
- revised browsing of controlled vocabulary; added excel-based exports
- add data export for extracted data
- 🧪 release updated version of BMDS execution using 2022 version #788
-
Summary tables
-
Summary visualizations
- No changes this quarter
-
General Improvements
-
Authentication/authorization
- (optionally) add cloudflare turnstyle to prevent bots from login attempts #775
-
- release version 2023.2
- Added
client.riskofbias.compare_metrics
- align metrics when copying across assessments via fuzzy text matching - Added
client.summary.datapivot_list
- retrieve all data pivots for an assessment - Added
client.summary.table_list
- retrieve all tables for an assessment - Added
login
parameter toclient.summary.set_authentication_token
, to setup a client which can be used to browse the HAWC website - Added
client.lit.reference_user_tags
- retrieves all user tag for all references for an assessment.
-
Administrative
Bug/regressions fixed:
- fix bug in data pivot initial settings #770
- fix bug in hawc client and API sessions #776
- fix bug in references "manually added" layout in html #779
- fix bug in user ordering for study evaluation pages #781
- remove duplicate study evaluation rows #782
Software upgrades/security/stability:
- update python, javascript, and CSS dependencies #787 #777
- remove old unused code #767
- remove redundant views, old javascript patterns, and catch errors with invalid data inputs #803
Developer experience:
- simplify django permissions for views and APIs #732 #801 #803
- the old approach was confusing and difficult to infer or test
- make browsable API available for PandasRenderers API views #800
- this will be useful to debug query counts in django debug toolbar
- added plotly template tag for easier plotting on django templates #793
- added feature flags for features still undergoing internal review #802 #788
- this makes it easier for develop to develop this features, but means we'll need to make sure code that we don't yet available to standard deployments is appropriately captured behind feature flags
- in staging environments, we will scan with all features enabled, to ensure that all possible routes are undergoing security review
2022-Q4
January 5th, 2023
The bulk of development this quarter was focused on new conflict resolution workflows for literature screening. If activated for an assessment, multiple users are required to select tags to a reference before they are applied. If two users tag a reference identically, the tags are marked as "resolved" and the reference advances to the next stage of screening. If two users tag a reference differently, then the tags are marked as conflicting, and the reference is added to the conflict resolution view. Note that existing assessments will not have this feature enabled, and tagging will work as it has in the past. This work is still not yet live, and is undergoing testing by our users (indicated by 🧪).
Another large-scale update was migrating our search/filter capabilities throughout HAWC to use django-filters instead of selectable, which is no longer maintained. Performance should be greatly improved with this migration, resulting in faster queries and page loads.
The complete changelog is described below:
New Features:
-
General Improvements
-
Literature Screening
- Add PubMed and DOI identifiers on HERO import #755
- Handle and report 500 errors from HERO requests #705
- Hide RIS import button in some HAWC deployments #705
- 🧪 Conflict resolution to our literature screening/tagging workflow #739
- Create wireframes, new models, new view stubs, and new backend logic as a foundation for further conflict resolution development #708 #721 #716 #735 #741 #750
- Add new view for users to identify and resolve tag conflicts #734 #749
- Reorganize screening page layout to account for user feedback and new conflict resolution #714, #731, #738, #747
-
Risk of Bias/Study Evaluation
-
Data Extraction
-
Summary tables
-
Summary visualizations
- Add Tableau data filters and modernize API #758 #761
- Enable JPEG exports of visualizations #712
- Improve to tagtree hover/help text #709
- Only show units available in an assessment when configuring a data pivot #709
- Fix data pivot plot layout to always show lower-bound on plot instead of on axis #710
- Add client API method to fetch all summary visualizations #717
-
Authentication/authorization
-
Administrative
- Update docs to show latest database schema #720
Bug/regressions fixed:
- Fixed an edge case where dose-group counts in data pivots did not add up correctly #713
- Fix case where user could unintentionally delete tagged references #753
- Change test to use regex for content type ID stability #725
- Various style fixes #726
Software upgrades/security/stability:
- Replace type hints from typing module with built in object types #723
- Standardize buttons for easier integration testing #743
- Add eslint plugin for sorting imports #728
- Reduce scope of API responses in production #715
- Update github actions #730
- Rename urls that use /new/ to use /create/ for consistency across HAWC #707
- Remove dead code #722 #727
2022-Q3
October 6, 2022
Our major update this quarter includes deployment of a new extraction workflow and schema for epidemiology data. Named epiv2
in the software; all new assessments and existing assessments without epidemiology data extraction have been migrated to the new schema; assessments with the old schema, epiv1
, are unchanged. The updated schema simplifies the old schema and user interface for data extraction and makes it easier to extract data at a high level (for systematic evidence maps, SEM), as well as a more detailed granular level, depending on the nature of the assessment. This release includes all the required components for data extraction; future releases will include the components needed to build summary tables and visualizations - in the meantime, try out the extraction forms and let us know what you think!
In addition, we made the following larger changes:
- We updated assessment audit-logs support to create new exports and improving our current logs to show more information
- We updated and standardized many of the forms that we use in HAWC. We've rewritten the text input fields, as well as the autocomplete/autosuggest fields using more modern, stable, and secure technologies. We hope this makes for a more seamless experience for users
- We enhanced summary visuals and tables to reflect the needs of users integrating the visuals into their projects - we hope these updates make the current visuals more flexible
Two other major changes have been released in our next
branch this quarter. These features are available under deployment feature flags and are undergoing some testing by users prior to merging into our main release branch; they are indicated below by the 🧪 emoji. Some production deployments may not have these features available; we hope to have them live soon:
- 🧪 Capturing additional assessment level metadata on a HAWC assessment and quantitative values for a final conclusion. In larger organizations, HAWC is frequently one of many tools and resources used for conducting a systematic review and health assessment. Therefore, we've added some new high-level assessment level fields to capture information regarding the larger project (class of project, relevant documents or URLs, QA procedure and methodology), and fields for capturing health values of interest (points of departure, reference values, etc). #674
- 🧪 Capturing ecological data of interest in a health assessment. Some health assessments include impacts on the environment and ecological health as well as human health. We've created a new data extraction module to extract fields in this domain as well, when appropriate. #634
The complete changelog is described below:
New features:
-
Overall Assessment Settings
-
Literature Screening
-
Data extraction
-
Risk of Bias/Study evaluation
-
Summary tables and visualizations
- Literature tagtrees
- Added a legend #684
- Added an option to show or hide reference counts, hiding counts is useful for documenting the approach in the planning and protocol phase #684
- Added the ability to drag and drop nodes for complex tree layouts #684
- Fixed bug where reference lists for a node were improperly filtered #654
- Data Pivots
- Updated forest plots to include treatment related effects in addition to statistical significance; can be used for conditional formatting #681
- Updated barcharts to handle standard deviation for error bars (previously only confidence intervals were handled correctly) #651 #697
- Added numeric duration exposure, useful for sorting #651
- Study Evaluation Heatmaps/Barcharts
- Improved default positioning of legend #685
- Evidence Profile Tables
- Study Evaluation Tables
- Literature tagtrees
-
General improvements
- Updated the EPA header and footer to match the new style guidelines #693 #703
- Fix mobile rendering of website (sidebar collapse) #672 #700 #664
- Modernized HTML text data entry fields to improve consistency and stability #655 #699
- Modernized text autocomplete data entry fields to improve consistency and stability #667 #698 #701
-
Administrative
Bug/regressions fixed:
- Fixed bug in downloading SVG exports of visuals #677
- Fixed bug which prevented updating assessment file attachments #695
- Better handle improper Unicode in Excel exports #652 #670
- Report an error on extremely large exploratory heatmaps instead of crashing the browser #671
- Improve validation error messages for users #658 #643
- Fix assorted errors #646 #696 #679 #676 #692
Software upgrades/security/stability:
- Quality of life improvements to developer experience #689 #660
- Rewrote integration tests using Playwright instead of Selenium #650
- Rewrote documentation using more user-friendly markdown instead of sphinx #680
- Fix deployment on servers with FIPS cryptography enforcement (RHEL8) #688
- Update HAWC configuration to reasonable and secure defaults #649 #691
2022-Q2
July 12, 2022
Updates were light this quarter; we were focused on other projects. One major change is rewriting how rasterized visuals are created; we're using native tooling in the browser now instead of generating server side; this should result in increased performance and accuracy to the rendered visual. #630
The complete changelog is described below:
- Visualizations:
- Client side rasterization of SVG images #630
- Literature screening:
- Study evaluations:
- Client:
- Admin:
- Developer updates:
- Current in development (behind feature flags):