Releases: Gilead-BioStats/gsm
v1.6.0
gsm v1.6.0
This release includes significant qualification testing updates, improvements to reporting, updates to default variable names, and updates to mappings and workflows.
Mapping and Workflow Updates
- All default KRI workflows (except for Screen Failure) only include enrolled patients by default.
- Mappings have been updated to reflect expected default variable names.
- A new mapping_domain has been added.
Reporting
- Small bugs were squashed that resulted in erroneous data being reported about workflow status.
Qualification Testing and Reporting
- Major refactor for the qualification report, which adds more detail, and more easily-read tables.
- Qualified functionality for 24 functions that include the bulk of the entire analytics pipeline in
{gsm}
What's Changed
- 987/1031 - resolve conflicts by @chelseadickens in #1038
- Sync
dev
andmain
by @mattroumaya in #1063 - Fix-1049: Update non-serious AE KRI to include all AEs by @Zhongkai-Wang in #1056
- Fix 1057 - PD_Map_Raw() Qual. Tests Updates by @collleenmclaughlin in #1059
- Fix 1031; 987; 1058 - qual tests for nMinDenominator + subset-oriented tests + PD_Assess() updates by @chelseadickens in #1036
- Fix 1065 - update is_mapping_valid by @mattroumaya in #1067
- Fix 1061 - fix report error log by @mattroumaya in #1068
- Fix 1074 - update data by @mattroumaya in #1075
- Fix 1070 - add flag counts to report by @mattroumaya in #1071
- Fix 1052 - util-is_mapping_valid() Qual. Tests by @collleenmclaughlin in #1072
- Fix 1035 - add badge to documentation by @mattroumaya in #1073
- Fix 967 - Check workflow list for Make_Snapshot by @mattroumaya in #1039
- Fix 1066 - Test Script Language Update by @collleenmclaughlin in #1087
- Fix 1066 - update qualification test ordering by @chelseadickens in #1093
- Fix 1083 - update meta_workflow by @mattroumaya in #1088
- Fix 1099, 1100, 1102 by @mattroumaya in #1103
- update qualification_analyze_normalapprox() in helper-qualification.R by @chelseadickens in #1114
- Fix 1107 - Update Analyze_NormalApprox by @Zhongkai-Wang in #1112
- Fix 1096 Qualification - Aligning Qual. Tests with Updates by @collleenmclaughlin in #1117
- Fix 1086 - Add Unit Tests/Code Coverage by @mattroumaya in #1115
- Update domain and column mappings. by @samussiah in #1104
- Update protocol deviation mapping. by @samussiah in #1119
- Fix 1079 - Updated Qual Report Rmd by @collleenmclaughlin in #1121
- Testing qual report by @mattroumaya in #1123
- Fix 1033 - Update qualification workflow vignette by @chelseadickens in #1125
- Fix 1095: Update Stats Vignettes by @Zhongkai-Wang in #1126
- Fix 1130 - add
Read_Mapping()
function by @mattroumaya in #1131 - Release v1.6.0 by @mattroumaya in #1124
- Fix 1133 - update qualification report filepath by @mattroumaya in #1135
Full Changelog: v1.5.0...v1.6.0
v1.5.0
gsm v1.5.0
This release includes changes to Protocol Deviation mapping and analysis, significant qualification testing updates, improvements to reporting, and workflow updates:
Protocol Deviation Mapping and Assessment
PD_Map_Raw()
has been split into two separate functions:PD_Map_Raw_Binary()
andPD_Map_Raw_Rate()
.PD_Assess()
has been split into two separate functions:PD_Assess_Binary()
andPD_Assess_Rate()
.- The default Important Protocol Deviation QTL now uses the binary PD mapping and assessment.
Qualification Testing
- Management of qualification specifications is now done in a
.csv
file, rather than separate YAML files. - Most mapping and assess functions are now qualified.
Reporting
- New feature added to the output of
Study_Report()
to highlight an individual site/group in any given visualization. - New feature added to the output of
Study_Report()
to hightlight an individual site/group across all visualizations.
What's Changed
- Sync
dev
andmain
by @mattroumaya in #972 - Remove
nStep
argument inQueryRate_Assess()
. by @samussiah in #974 - Fix 961 - minify lData by @mattroumaya in #983
- Fix 979 - remove unused functions and dependencies by @mattroumaya in #982
- Fix 953 - remove qualification YAML --> csv file by @mattroumaya in #976
- Fix 920 - AE_Map_Raw() Qual. Tests by @collleenmclaughlin in #975
- Fix 937 - PD_Map_Raw() Qual. Tests by @collleenmclaughlin in #977
- Fix 934 - LB_Map_Raw() Qual. Tests by @collleenmclaughlin in #978
- Fix 928 - Disp_Map_Raw() Qual. Tests by @collleenmclaughlin in #980
- Add dropdown to widgets to highlight sites. by @samussiah in #985
- Fix 986 - make unit tests faster by @mattroumaya in #989
- Data model fixes by @samussiah in #997
- fix 919 - qualify AE_Assess for normal approximation by @chelseadickens in #955
- fix 933 - qualify LB_Assess for normal approximation by @chelseadickens in #959
- fix 936 - qualify PD_Assess for normal approximation by @chelseadickens in #960
- Fix 924 - DataChg_Map_Raw() Qual. Tests by @collleenmclaughlin in #992
- Fix 926 - DataEntry_Map_Raw() Qual. Tests by @collleenmclaughlin in #995
- Fix 939 - QueryAge_Map_Raw() Qual. Tests by @collleenmclaughlin in #996
- Fix 965 - add missing unit tests by @mattroumaya in #998
- Fix 1005 - QueryRate_Map_Raw Grouping by @mattroumaya in #1007
- Fix-1005 - Additional update to correct counting and merging logic by @Zhongkai-Wang in #1009
- Fix 1006 - make flowchart optional by @mattroumaya in #1008
- Update
rbm-viz
tov1.0.0
. by @samussiah in #1011 - fix 923 - qualify DataChg_Assess by @chelseadickens in #1001
- fix 925 - qualify DataEntry_Assess by @chelseadickens in #1002
- fix 938 - qualify QueryAge_Assess by @chelseadickens in #1000
- fix 940 - qualify QueryRate_Assess by @chelseadickens in #999
- Fix 1014 - update reporting functions by @mattroumaya in #1015
- Fix 1018 - Minor Qual. Test Updates by @collleenmclaughlin in #1019
- Fix 966 - update rbm-viz function docs by @mattroumaya in #1013
- fix 927 - qualify Disp_Assess for normal approximation by @chelseadickens in #956
- Fix 962 - clean up Make_Snapshot() merging by @mattroumaya in #1022
- Fix 988 even more tweaks by @mattroumaya in #1028
- Reposition dropdown to remain visible throughout report. by @samussiah in #1027
- Fix 988 - report-level site dropdown by @mattroumaya in #1023
- Update mappings to more easily integrate with safetyGraphics for gsmApp. by @samussiah in #1030
- Add
Estimate
to QTL output. by @samussiah in #1037 - Fix 905 - Create stats vignette by @Zhongkai-Wang in #1041
- Fix 639; 1025 - fix barcharts + warning during rcmd check by @mattroumaya in #1026
- tweaks by @mattroumaya in #1042
- Fix 941 - QueryRate_Map_Raw() Qual. Tests by @collleenmclaughlin in #1017
- Fix 520 - add ability to export code from workflow, lData, and lMapping by @mattroumaya in #1004
- Fix 1003 - Update IPD QTL by @Zhongkai-Wang in #1040
- Fix 1034 - Qual Scraping Function by @collleenmclaughlin in #1044
- qualification specs management by @mattroumaya in #1046
- Fix 932 - Get_Enrolled() Qual. Tests by @collleenmclaughlin in #1048
- Fix 935 - util-MergeSubjects() Qual. Test by @collleenmclaughlin in #1051
- Fix 929 - util-FilterDomain() Qual. Tests by @collleenmclaughlin in #1054
- Release v1.5.0 by @mattroumaya in #1055
Full Changelog: v1.4.1...v1.5.0
v1.4.1
v1.4.1 modifies flagging logic to avoid flagging sites with insufficient data collected.
What's Changed
- Sync
main
anddev
forv1.4.0
release by @mattroumaya in #968 - Fix 614 - denominator requirement and score/flag rules by @Zhongkai-Wang in #964
- Release v1.4.1 by @mattroumaya in #971
Full Changelog: v1.4.0...v1.4.1
v1.4.0
gsm v1.4.0
This release introduces five new KRIs, the inclusion of interactive widgets ported over from the rbm-viz
Javascript library, reporting updates, and various bug fixes and utility functions. Major changes are noted below!
Mapping/Assessment Functions for new KRIs
DataChg_Map_Raw
&DataChg_Assess
: Evaluates rate of reported data point with >1 changes.DataEntry_Map_Raw
&DataEntry_Assess
: Evaluates rate of reported Data Entry Lag >10 days.Screening_Map_Raw
&Screening_Assess
: Evaluates screen failure rate (SF) on mapped subject-level dataset to identify sites that may be over- or under-reporting patient discontinuations.QueryAge_Map_Raw
&QueryAge_Assess
: Evaluates rate of reported Query Age >30 days.QueryRate_Map_Raw
&QueryRate_Assess
: Evaluates query rates to identify sites that may be over- or under-reporting queries.
Interactive Widgets
- When running any
*_Assess()
function, visualizations that are suffixed withJS
are interactivehtmlwidgets
ported over fromrbm-viz
that can be explored in an IDE or web browser.
Reporting Updates
- Interactive visualizations are now the default in the output of
Study_Report()
. - Tables are now interactive and show flag directionality.
- Only KRIs at the site-level are supported for now. QTLs and country-level KRI reporting is not currently supported.
What's Changed
- pass thresholds to rbm-viz as a simple vector/array by @samussiah in #885
- Sync
dev
andmain
post releasev1.3.2
by @mattroumaya in #897 - Explicitly assign flags. by @samussiah in #895
- Unit Testing for NormalApprox Analyze & Flag Functions by @collleenmclaughlin in #896
- Fix 781 workflow by @mattroumaya in #898
- update tests + workflows by @mattroumaya in #903
- Fix 781 assess tests by @mattroumaya in #906
- Tweak UpdateParams by @samussiah in #907
- fix-781-update-merge: update merge by @Zhongkai-Wang in #908
- Filter
qtl0004
workflow on important PDs. by @samussiah in #910 - Fix 783 - add UpdateParams function by @mattroumaya in #823
- Fix 781 - Create new operational KRIs and update workflows by @Zhongkai-Wang in #839
- Fix 817 - Add HTMLWidgets barcharts by @mattroumaya in #883
- Fix 769 - Add CheckSnapshotInputs() by @mattroumaya in #899
- Fix 837 report by @mattroumaya in #913
- Fix 915 - add rbm-viz widgets to new KRIs by @mattroumaya in #917
- Fix 912 - Merge/join handling in mapping by @Zhongkai-Wang in #945
- Add screen fail assessment. by @samussiah in #947
- Release changes by @mattroumaya in #946
- systime-based elementId by @mattroumaya in #949
- Report tweaks by @samussiah in #952
- Report updates by @mattroumaya in #951
- Add # of participants to overview table in KRI report. by @samussiah in #957
- Release v1.4.0 by @mattroumaya in #958
Full Changelog: v1.3.2...v1.4.0
v1.3.2
gsm v1.3.2
This minor release includes updates to the data model that is passed to Gismo via Make_Snapshot()
- All CTMS metadata is passed through via
lMeta$status_study
andlMeta$status_site
config_schedule
/status_schedule
are removed as inputs/outputs toMake_Snapshot()
What's Changed
- Sync
dev
withrelease v1.3.1
by @mattroumaya in #886 - Update metadata,
Make_Snapshot()
data model, and unit tests by @mattroumaya in #889 - Release v1.3.2 by @mattroumaya in #893
Full Changelog: v1.3.1...v1.3.2
v1.3.1
gsm v1.3.1
This minor release adds a data frame to the output/data model of Make_Snapshot()
that includes parameters and values for QTL analyses.
What's Changed
- Sync
dev
withrelease v1.3.0
by @mattroumaya in #879 - Minor reporting + documentation updates by @mattroumaya in #878
- Fix #864 - QTL Pipeline Updates by @jwildfire in #873
- Fix bounds step parameter and resolve issue plotting incomplete set of bounds in scatter plot. by @samussiah in #884
- Release v1.3.1 by @mattroumaya in #880
Full Changelog: v1.3.0...v1.3.1
v1.3.0
gsm v1.3.0
This release introduces new and refined statistical methods for qualified assessments.
- A new statistical method
Analyze_NormalApprox
is now the default method used for the Adverse Event (AE), Disposition (DISP), Lab Abnormality (LB), and Protocol Deviation (PD) assessments. - Additionally,
Flag_NormalApprox
flags values, andAnalyze_NormalApprox_PredictBounds
creates upper and lower-boundaries for data visualization when a normal approximation is used. - QTLs are now supported for Disposition and Protocol Deviation assessments by providing a QTL workflow for
Study_Assess()
orMake_Snapshot()
. - Country-level workflow YAML files are now available in
inst/workflow/country_workflow
. - Significant documentation and vignette updates, including the Cookbook vignette, Contributor Guidelines, and a new Step-by-Step Analysis vignette.
What's Changed
- Main by @mattroumaya in #799
- Fix 793 - Update Data Spec Table by @mattroumaya in #800
- tidyselect updates by @mattroumaya in #805
- Fix 797 - Remove config + update contributor guidelines by @mattroumaya in #798
- Fix #554: Update verbiage by @mattroumaya in #768
- Fix 790 - Data Analysis Vignette by @collleenmclaughlin in #802
- Update report and charts. by @samussiah in #807
- update tests and docs by @mattroumaya in #814
- Fix unit tests for new stats methods by @mattroumaya in #820
- Fix 811 - Added Snapshot Date to results_summary of Make_Snapshot() by @collleenmclaughlin in #819
- Fix 706 - Finalize Lab KRI Workflow by @mattroumaya in #816
- Fix 635 - Add country to grouping by @mattroumaya in #803
- Fix 596 - Updated Source Data for Study_Assess() Unit Tests by @collleenmclaughlin in #821
- Add QTL Analysis by @mattroumaya in #806
- Add funnel plot methods by @Zhongkai-Wang in #812
- add snapshot gsm_analysis_date by @mattroumaya in #831
- Fix 813 - report tweaks by @mattroumaya in #826
- Fix 825 - arrange map functions by @mattroumaya in #834
- add country mappings by @mattroumaya in #835
- Fix 630 - Updates to Data Pipeline Vignette by @collleenmclaughlin in #809
- add to unit tests by @mattroumaya in #841
- Fix 766 - More Vignette Updates by @collleenmclaughlin in #815
- Fix 771 ffwd by @mattroumaya in #842
- Fix 771 - New & Updated Unit Tests by @collleenmclaughlin in #836
- Fix 791 tweaks by @mattroumaya in #844
- Fix 791 - Updated Assess() Unit Tests/Added Helper Functions by @collleenmclaughlin in #824
- Fix 794 and Fix 818 - Update Documentation by @mattroumaya in #840
- Fix 833 fixes by @mattroumaya in #845
- Fix 833 - Refine new stats methods by @Zhongkai-Wang in #838
- Fix 718 - add unit tests for
Disp_Map_Raw()
by @mattroumaya in #847 - Fix 810 by @jwildfire in #851
- Fix-854 Fix PredictBounds by @Zhongkai-Wang in #858
- Resolve issues discovered rerunning
{gsm}
on pilot studies. by @samussiah in #860 - Fix 853 - Clean up stats documentation for v1.3 release by @Zhongkai-Wang in #862
- Fix 852 - Clean up
inst
by @mattroumaya in #861 - documentation updates by @mattroumaya in #872
- Release v1.3.0 by @mattroumaya in #868
Full Changelog: v1.2.0...v1.3.0
v1.2.0
gsm v1.2.0
This release includes qualified functionality for the following KRIs:
- Lab Abnormality
- Disposition
- Adverse Event
- Protocol Deviation
Notable updates include:
- Addition of the
Make_Snapshot()
function, which allows a user to run multiple assessments on a given study, as well as create metadata needed as the inputs to the Gismo web app. - The
Flag()
function has been split intoFlag_Poisson()
andFlag_Fisher()
functions to simplify flagging logic based on the type of statistical model that is being used. - The
Transform_EventCount()
function has been split intoTransform_Rate()
andTransform_Count()
to be used based on the metric that is being evaluated. *_Assess()
functions have been refactored based on refinements to the data model. Notable changes include removing alllTags
, and generally paring back some of the metadata captured in the assess functions which is either no longer needed, or will happen outside of the assessment function.
What's Changed
- Sync
v1.1.0
release withdev
by @mattroumaya in #678 - Fix #646 + #677: update documentation + remove dfBounds from flowchart by @mattroumaya in #680
- Fix #686 - LB_Map_Raw() counts refactor by @mattroumaya in #687
- Qualification Specs for LB_Assess by @kodesiba in #690
- Fix #637 - Sunset
Visualize_Count()
by @mattroumaya in #695 - Fix #685 - Add workflows for kri0001 - kri0008 by @mattroumaya in #691
- Fix #698 - add flagging on KRI for LB stats methods by @mattroumaya in #699
- Fix #655 - Functionalize lAssess by @mattroumaya in #701
- Qc lb test cases by @kodesiba in #702
- Fix #684 - update contributor guidelines by @mattroumaya in #704
- Fix #611: Update library to be compatible with updates to rawplus data standard in clindata. by @samussiah in #700
- remove individual mappings by @mattroumaya in #712
- Update overall discontinuation rate; remove bug in
Study_AssessmentReport
. by @samussiah in #716 - Fix #711 - update unit tests for mapping functions by @mattroumaya in #717
- V1.3 proto by @jwildfire in #710
- Fix #719 - refactor PD_Assess() by @mattroumaya in #725
- remove unused function by @mattroumaya in #734
- get Study_Assess() running by @mattroumaya in #732
- Assess Refactor + Remove Obsolete Stats Functions by @mattroumaya in #728
- Fix 739 - update CI and docs by @mattroumaya in #740
- Fix 742 by @collleenmclaughlin in #743
- Update disposition mapping with discontinuation rather than completion. by @samussiah in #746
- Qualification Specification Updates for Assess Functions by @kodesiba in #748
- Fix #747 - Remove N from Assess() Functions by @collleenmclaughlin in #753
- Fix #609 Updated - Create separate
Flag_()
functions based on methods used by @jwildfire in #758 - Fix 755 by @jwildfire in #756
- Fix #724 - Update Unit Tests for release v1.2 by @mattroumaya in #741
- Fix #763: update unit tests by @mattroumaya in #767
- Fix #737 -
Make_Snapshot()
by @mattroumaya in #738 - Fix #772 - Update default thresholds for Fisher's used in
_Assess
functions for consistency by @Zhongkai-Wang in #774 - Fix 770 - update metadata by @mattroumaya in #773
- Fix 776 by @samussiah in #777
- Qualification Test Updates for Assess Functions by @kodesiba in #775
- update meta by @mattroumaya in #780
Full Changelog: v1.1.0...v1.2.0
v1.1.0
gsm v1.1.0
This release includes qualified functionality for the Disposition Assessment and experimental functionality for the Lab Abnormality assessment.
Additionally, updates include:
- Mapping functions include custom grouping functionality by columns for
SiteID
,StudyID
, orRegion
/CustomGroupID
. This allows for Study (QTL) and Site (KRI) assessments to be run. Analyze_Identity()
allows for nominal and statistical assessments for all Assess functions.- New utility functions
MakeStratifiedAssessment()
andConsolidateStrata()
allow for stratified assessments to be run. Visualize_Score()
provides a standard visualization for Score or KRI.Visualize_Workflow()
provides a flowchart with a high-level overview of the data pipeline for a given assessment.
What's Changed
- Merge v1.0.1 into dev. by @samussiah in #553
- update silver potato URL by @mattroumaya in #564
- Stratification prototype by @jwildfire in #555
- Check with dim by @jwildfire in #565
- draft qualification report riskmetric section by @kodesiba in #559
- Update cookbook + clear checks by @mattroumaya in #569
- Fix 387 assess by @mattroumaya in #571
- disp_map_raw refactor by @jwildfire in #578
- Allow Study (QTL), Site (KRI) and custom groupings by @jwildfire in #581
- Add explicit aesthetic that maps to tooltip in {plotly}. by @samussiah in #584
- Fix #387 - Migrate + Rename + Update
Disp_Map_Raw()
by @mattroumaya in #562 - Fix #475 - add flowchart by @mattroumaya in #545
- Fix 589 - update snapshots and define global vars by @mattroumaya in #590
- Fix 586 Reorganize Qualification Tests by @kodesiba in #587
- Fix 463 - support for nominal and statistical assessments by @mattroumaya in #574
- Fix #592 - remove clindata::mapping_rawplus by @mattroumaya in #598
- Fix #607 - rename fontawesome icons by @mattroumaya in #608
- Fix #460 - Support Site/Country/Study level assessments by @mattroumaya in #573
- Add workflow that assess PDs by category. by @samussiah in #606
- Fix 570 - update
MakeStratifiedAssessment()
to return NULL by @mattroumaya in #605 - Fix #594 - pass through dfBounds by @mattroumaya in #612
- Fix 610 - flag on KRI in chisq and fisher by @mattroumaya in #613
- Fix #600 - add
strMethod = "identity"
toDisp_Assess()
by @mattroumaya in #625 - Fix #622: update unit tests + data by @mattroumaya in #624
- Fix 633 quali workflow by @kodesiba in #645
- Fix #566 - Faceted charts for stratified analysis by @jwildfire in #567
- Fix 541 updates by @mattroumaya in #649
- Add lab abnormality KRI by @samussiah in #617
- Fix 579 - Visualize_Score() by @mattroumaya in #620
- Fix #585 - add dynamic tooltips by @mattroumaya in #632
- Fix #634 - Update Disposition by @mattroumaya in #641
- Refactor strGroupCol in Assessment functions by @jwildfire in #638
- QC v1.1.0 specs by @kodesiba in #653
- Fix 660 - Arrange Analyze_Identity() output by @mattroumaya in #662
- Fix #661: Debug study report. by @samussiah in #663
- fix site/group counts in report by @samussiah in #664
- documentation + unit test updates by @mattroumaya in #668
- Fix 658 by @Zhongkai-Wang in #669
- Qc v1.1.0 test cases by @kodesiba in #671
- Release v1.1.0 by @mattroumaya in #656
New Contributors
- @Zhongkai-Wang made their first contribution in #669
Full Changelog: v1.0.1...v1.1.0
v1.0.1
Release Notes
This release explicitly captures the KRI of interest as part of the data model, standardizing the input to and output from the analysis functions. View a full list of resolved issues here.
What's Changed
- update pkgdown workflow trigger by @kodesiba in #512
- Fix #472 by @ge-li in #513
- Fixes for
RunAssessment
andStudy_AssessmentReport
by @mattroumaya in #509 - Fix #496 - add labels in data spec header by @ge-li in #518
- Fix #434 - return correct
bStatus
by @mattroumaya in #523 - Fix #412 - add
@importFrom
where missing by @mattroumaya in #519 - fix #498 by @samussiah in #525
- fix #435 by @samussiah in #524
- Fix #529 - make
cli_alert_info("...")
affect bybQuiet
inMergeSubjects()
by @ge-li in #532 - updates to data pipeline vignette. by @jwildfire in #526
- Fix #515 - set default logical value to
FALSE
inutil-parse_data_spec.R
by @ge-li in #531 - fix #521: Add function parameters to assessment workflows. by @samussiah in #534
- update qualification tests for KRI update by @kodesiba in #535
- Fix #462 - capture KRI and other associated metadata by @mattroumaya in #527
- Fix #530 - Update Vignettes by @mattroumaya in #537
- Fix #536 - change filepath name by @mattroumaya in #544
- Fix #517 - update documentation by @mattroumaya in #538
- Update unit tests by @samussiah in #546
- QC AE and PD assessments by @samussiah in #551
- Release v1.0.1 QC Updates by @mattroumaya in #552
- Release v1.0.1 by @samussiah in #550
New Contributors
Full Changelog: v1.0.0...v1.0.1