Releases: Gilead-BioStats/gsm
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
v1.0.0
Release Notes
This release includes qualified functionality for Adverse Event and Protocol Deviation Assessments.
Additionally, updates include:
Study_Assess()
now has an argumentlSubjFilters
that filters subject-level data when running multiple assessments.Study_AssessmentReport()
is more concise, and now displays a yellow icon for checks that were not run.- Statistical models now include informative messages when
bQuiet
is FALSE. - Documentation and vignettes have been thoroughly reviewed and improved.
What's Changed
- Release v0.4.1 by @samussiah in #453
- Main by @samussiah in #455
- Fix #393 - re-implement
lSubjFilters
inStudy_Assess()
by @mattroumaya in #456 - fix #458 by @samussiah in #459
- Update qualification report PR section by @kodesiba in #464
- Fix #465 - add CONTRIBUTING.md by @mattroumaya in #471
- fix #481 by @jwildfire in #482
- Fix #432 - Updates for
Study_AssessmentReport()
by @mattroumaya in #470 - fix #476 in RunStep by @mattroumaya in #480
- update OS and r versions in CMD check actions by @kodesiba in #485
- Update CONTRIBUTING.md by @kodesiba in #487
- display metadata table by @mattroumaya in #488
- Fix stats by @samussiah in #478
- update readme by @mattroumaya in #489
- Fix 483 by @jwildfire in #484
- Fix #491 - add lifecycle badge by @mattroumaya in #492
- update Contributing.md by @jwildfire in #490
- Readme updates by @jwildfire in #493
- Fix 494 - export rank_chg by @mattroumaya in #495
- Spedits by @samussiah in #500
- add vignettes by @jwildfire in #497
- Release v1.0.0 by @mattroumaya in #501
- Release v1.0.0 rc2 by @mattroumaya in #507
Full Changelog: v0.4.1...v1.0.0
v0.4.1
gsm v0.4.1
v0.4.1 largely addresses function documentation and squashes a few bugs. View a complete list of resolved issues here.
What's Changed
- Main by @jwildfire in #414
- fix #406 by @samussiah in #421
- Fix #427: updates to
_pkgdown.yaml
by @mattroumaya in #430 - add trigger on PR to main to qualificaiton report by @kodesiba in #426
- Fix 423 pkgdown by @kodesiba in #428
- Fix #413 by @mattroumaya in #431
- Fix 437 by @mattroumaya in #440
- Fix #420 and Fix #425 by @mattroumaya in #429
- Fix #419 - updates for study functions by @mattroumaya in #438
- fix #433 - view table option for
Study_AssessmentReport()
by @mattroumaya in #439 - add action and move build function to R file by @kodesiba in #445
- Fix #425 & Fix #413 - update
CheckInputs()
by @mattroumaya in #446 - Fix 415 by @samussiah in #441
- Fix 450 by @mattroumaya in #452
Full Changelog: v0.4.0...v0.4.1
v0.4.0
gsm v0.4.0
This release includes a refactor to the gsm data workflow in preparation for a v1 release. Updates include:
*_Map_Raw()
functions have default input parameters from{clindata}
*_Map_Raw()
and*_Assess()
functions now have options for verbose workflow commenting (whenbQuiet == FALSE
), and an option to return an error log (bReturnChecks == TRUE
)- Default
Mappings
andSpecifications
now saved as metadata instead of hard-coded in functions. Seeinst/mappings/
andinst/specs/
in this package orclindata::mapping_rawplus
- Added support for a study-level data pipeline with reporting via a new
Study_Assess()
function, which depends on supportingStudy_*()
functions and a series of utility functions (CheckInputs()
,RunAssessment()
, andRunStep()
)
What's Changed
- add IE and Consent qualification tests by @kodesiba in #328
- Fix #324, correct typos in documentation by @mattroumaya in #325
- Fix #322, slight refactor for list creation in assess functions by @mattroumaya in #326
- Fix #320 - add is_mapping_valid() to AE_Map_Adam() + update tests by @mattroumaya in #329
- fix #317 - refactor unit tests by @mattroumaya in #343
- pilot unit test refactor for AE_Map_Raw + workflow template by @mattroumaya in #337
- Fix #344 clindata update by @mattroumaya in #346
- Fix #345 - ID column to character in mergeSubjects by @mattroumaya in #350
- update PR template by @mattroumaya in #357
- Fix 341 spec functions by @kodesiba in #348
- Add study-level assessment workflows by @jwildfire in #334
- Fix 353 bquiet by @mattroumaya in #354
- Fix #351 - standardize
vUniqueCols
check inis_mapping_valid
by @mattroumaya in #352 - Fix #355 - suppress messages in unit tests by @mattroumaya in #356
- add FilterDomain util function. fix #360 by @jwildfire in #361
- Fix #359 - add/update unit tests by @mattroumaya in #367
- standardize util naming by @jwildfire in #371
- cli for is_mapping_valid by @mattroumaya in #375
- workflow refactor by @mattroumaya in #373
- Fix 363 364 readme pkgdown by @kodesiba in #368
- Study_Assess Workflow Refactor by @jwildfire in #377
- Workflow v3 - updates for all map and assess by @mattroumaya in #385
- add pkgdown github workflow by @kodesiba in #381
- Workflow v3 quali by @kodesiba in #386
- Study_Assess Workflow refactor - Take 3 by @jwildfire in #384
- Fix #321 - check length of lTags and squash if > 1 by @mattroumaya in #383
- Fix #391 - remove listed IDs from MergeSubjects by @mattroumaya in #395
- Fix #388 - Update report and report analysis functions by @mattroumaya in #397
- fix #323, fix #362, and fix #389 by @mattroumaya in #396
- fix #400 by @samussiah in #404
- Release v0.4.0 by @mattroumaya in #399
New Contributors
- @samussiah made their first contribution in #404
Full Changelog: v0.3.0...v0.4.0