Skip to content

Releases: insightsengineering/teal.modules.clinical

v0.9.1 cran

27 Apr 23:51
73902e4
Compare
Choose a tag to compare

Enhancements

  • Updated tm_g_forest_rsp and tm_g_forest_tte to use refactored version of g_forest. Plots are now displayed as ggplot objects instead of grob objects. Added parameters font_size and rel_width_forest to control font size and width of plot relative to table, respectively.
  • Updated tm_t_summary_by to allow NULL input to paramcd argument.
  • Updated tm_g_km to use refactored version of g_km. Plots are now displayed as ggplot objects instead of grob objects. Added parameters rel_height_plot, font_size, control_annot_surv_med, and control_annot_coxph to control height of plot relative to table, font size, median survival time table size, and Cox-PH table size, respectively.
  • Added the control argument to tm_t_binary_outcome to control settings for the analysis (methods, confidence intervals, and odds ratios) within the module.

Miscellaneous

  • Replaced instances of deprecated na_level argument to tern functions with na_str.
  • Replaced argument/list element name strata instead of strat in all tern function calls following the deprecation of this argument/name within tern.
  • Removed formatters from dependencies and replaced the use of its functions relating to variable labels with functions from teal.data.

What's Changed

Full Changelog: v0.9.0...v0.9.1

v0.9.0 cran

26 Feb 01:36
c2db189
Compare
Choose a tag to compare

Breaking Changes

  • Adapted all modules to use teal_data objects.
  • Module arguments that previously accepted inputs from teal.transform::choices_selected() or teal.transform::data_extract_spec() now only accept input from teal.transform::choices_selected(). The affected modules are: tm_a_gee, tm_a_mmrm, tm_g_ci, tm_g_forest_rsp, tm_g_forest_tte, tm_g_ipp, tm_g_km, tm_g_lineplot, tm_g_pp_adverse_events, tm_g_pp_patient_timeline, tm_g_pp_therapy, tm_g_pp_vitals, tm_t_abnormality, tm_t_abnormality_by_worst_grade, tm_t_ancova, tm_t_binary_outcome, tm_t_coxreg, tm_t_events, tm_t_events_by_grade, tm_t_events_patyear, tm_t_events_summary, tm_t_exposure, tm_t_logistic, tm_t_mult_events, tm_t_pp_basic_info, tm_t_pp_laboratory, tm_t_pp_medical_history, tm_t_pp_prior_medication, tm_t_shift_by_arm, tm_t_shift_by_arm_by_worst, tm_t_shift_by_grade, tm_t_smq, tm_t_summary, tm_t_summary_by, and tm_t_tte

Enhancements

  • Updated the documentation and vignettes to demonstrate method to pass teal_data object to teal::init().
  • Added parameter sort_freq_col to tm_t_events to allow the user to select column to use when sorting by decreasing frequency.
  • Added parameter incl_overall_sum to tm_t_events to allow the user to choose whether overall summary rows are included at the top of the table.
  • Updated the documentation and vignettes to demonstrate method to pass teal_data object to teal::init().
  • Added default_total_label and set_default_total_label functions to get and set default total column label (total_label) for modules.
  • Implemented tern::default_na_str and tern::set_default_na_str functions to get and set default missing value replacement string (na_level) for modules.

Bug fixes

  • Fixed bug in tm_g_lineplot forcing module to initialize with a table.

Miscellaneous

  • Deprecated the aval argument in tm_t_pp_laboratory and tm_g_pp_vitals and replaced it with the aval_var argument.
  • Deprecated the avalu argument in tm_t_pp_laboratory and replaced it with the avalu_var argument.
  • Deprecated the base_var argument in tm_g_ipp, tm_t_shift_by_arm, and template_shift_by_arm_by_worst and replaced it with the baseline_var argument.
  • Specified minimal version of package dependencies.
  • Replaced usage of deprecated summarize_vars function with analyze_vars.
  • Reduced package dependencies (removed tidyr, rlang, magrittr and styler).

What's Changed

Read more

v0.8.16

14 Aug 14:36
1fd76e0
Compare
Choose a tag to compare

Enhancements

  • Added more informative error message when grade mapping error occurs in tm_t_abnormality_by_worst_grade.
  • Fixed label indentation in tm_t_abnormality_by_worst_grade.
  • Added total_label argument to enable customization of the "All Patients" column/row label in the following modules: tm_a_mmrm, tm_t_abnormality, tm_t_abnormality_by_worst_grade, tm_t_binary_outcome, tm_t_events, tm_t_events_by_grade, tm_t_events_patyear, tm_t_events_summary, tm_t_exposure, tm_t_mult_events, tm_t_shift_by_arm, tm_t_shift_by_arm_worst, tm_t_shift_by_grade, tm_t_smq, tm_t_summary, tm_t_summary_by, and tm_t_tte.
  • Increased default width of tm_g_forest_tte plot to prevent overlapping text.
  • Improve default annotation table sizing in tm_g_km.

Miscellaneous

  • Updated control_incidence_rate parameter names in tm_t_events_patyear from time_unit_input and time_unit_output to input_time_unit and num_pt_year, respectively, after parameter names were changed in tern.

What's Changed

New Contributors

Full Changelog: v0.8.14...v0.8.16

v0.8.15

31 May 23:27
Compare
Choose a tag to compare

Breaking changes

  • Replaced chunks with simpler qenv class.
  • Replaced datasets argument containing FilteredData with the new arguments data (tdata object) and filter_panel_api (FilterPanelAPI).

Enhancements

  • Replaced synthetic_cdisc_data with refactored synthetic_cdisc_dataset function to speed up dataset loading in tests/examples.
  • Added new GEE module tm_a_gee.
  • Added interface for selecting an interaction term to tm_t_ancova.
  • Updated encoding input checks to use shinyvalidate::InputValidator for better UI experience. Previously used shiny::validate.
  • Added option to tm_a_mmrm to allow for Kenward-Roger adjustments of standard errors and p-values.
  • Added option to choose facet scale options in tm_g_barchart_simple.
  • Added label parameter to cs_to_select_spec/cs_to_des_select and cs_to_filter_spec/cs_to_des_filter to allow the user to customize the label printed over the selection field.
  • Updated tm_t_coxreg module after refactoring summarize_coxreg in tern to fix indentation.
  • Updated tm_t_exposure module to use new function analyze_patients_exposure_in_cols to fix table structure.

Bug fixes

  • Fixed bug causing overlapping bars in tm_g_barchart_simple.
  • Fixed bug for figures in svg format.
  • Fixed bug in tm_t_summary and tm_t_summary_by preventing users from specifying the numeric_stats argument.

Miscellaneous

  • Updated package Suggests to use scda.2022 rather than scda.2021.
  • Removed unused argument param from tm_g_pp_vitals.
  • Removed optimizer choice from tm_a_mmrm since we can always use the automatically determined optimizer.
  • Created datasets to use in examples/tests for adsl, adae, adaette, adcm, adeg, adex, adlb, admh, adqs, adrs, adtte, and advs. These datasets are stored in the data folder and accessible via the tmc_ex_* prefix.
  • Updated all examples and tests to use datasets from the teal.modules.clinical package instead of scda datasets.
  • Updated tests to use testthat 3rd edition and replaced all applicable tests with snapshot testing.
  • Implemented the lubridate package for date variables in internal data.
  • Changed default value of plot_width in tm_g_forest_rsp to prevent clutter.

What's Changed

New Contributors

Full Changelog: v0.8.14...v0.8.15

v0.8.14

14 Oct 01:26
bdc9683
Compare
Choose a tag to compare

Enhancements

  • Updated all synthetic data for tests to version rcd_2022_02_28.
  • Reverted missing data checkbox in tm_t_summary (encoding and filtering should be separate).
  • Implemented a new widget that allows dragging and dropping to select comparison groups.
  • Added the teal.reporter functionality to all modules.
  • Enhanced the tm_t_pp_medical_history module to use the table_with_settings module and return an rtables object.
  • Implemented nestcolor in examples, refactored tm_g_barchart_simple to allow use of nestcolor.
  • Added more descriptive title/labels and visit name subtitle to tm_g_ci.
  • Updated tm_a_mmrm column name when deselecting treatment from "all obs" to "All Patients", added subtitles and footnotes.
  • Added a title and parameter category subtitle to tm_t_exposure, cleaned up labels.
  • Added titles and worse flag variable subtitles to tm_t_shift_by_grade and tm_t_shift_by_arm_by_worst.
  • Added a footnote to tm_t_events_patyear with CI method.
  • Added a subtitle and footnotes to tm_g_km.
  • Added Stratified Analysis CI method option panel to tm_t_binary_outcome.
  • Added validation for covariate/visit conflicts to tm_a_mmrm.
  • Remove unnecessary brackets from header in tm_t_exposure.
  • Hid footnotes in tm_g_km and tm_t_tte when "Compare Treatments" is off.

Bug fixes

  • Fixed bug in tm_g_barchart_simple which prevented graph from showing.
  • Fixed broken example for tm_t_abnormality_by_worst_grade.
  • Fixed bug in tm_a_mmrm which prevented table headers from displaying.
  • Fixed bug in tm_g_forest_rsp when deselecting endpoint.
  • Fixed bug in tm_t_binary_outcome that crashed the app when deselecting all paramcd.
  • Fixed teal.reporter card names for tm_t_smq.
  • Fixed bug in tm_t_shift_by_arm_by_worst by adding validations for choosing different endpoint values.
  • Fixed bug in tm_t_coxreg preventing footnotes from displaying for univariate models.

Miscellaneous

  • Added nestcolor dependency and replaced deprecated function tern::color_palette with nestcolor::color_palette.

What's Changed

New Contributors

Full Changelog: v0.8.13...v0.8.14

v0.8.13

09 Jun 14:31
3425a1d
Compare
Choose a tag to compare

Enhancements

tm_g_pp_adverse_events

  • Updated the position of the labels.
  • Updated the plot to render the color legend.

tm_t_summary_by

  • Enhanced the module to support the geometric mean in the encoding panel.

tm_t_summary

  • Updated and added a footnote.
  • Enhanced the module to support geometric mean in the encoding panel.
  • Updated the module to display the checkboxes for numeric variables statistics only when numeric variables are part of the selected.
  • Updated validations to warn users when using a dataset with non unique identifiers or when selecting variables with non supported types (i.e. Date, POSIXt).
  • Added a checkbox to remove the column generated by missing values.

Other modules

  • Updated tm_t_binary_outcome to enable an option to apply a continuity correction in the Newcombe method
  • Simplified the show R code for tm_g_pp_patient_timeline module.
  • Improved the names of the code chunks shown in Debug Info.
  • Improved the validation if treatment variable is not a factor.

Bug fixes

  • Updated the validation to account for the error when multiple variables are not selected in tm_g_pp_patient_timeline module.

Miscellaneous

  • Added a pkgdown template to the documentation.
  • Updated package authors.

v0.8.11

12 Feb 00:27
5f0462c
Compare
Choose a tag to compare

Breaking changes

  • Updated tm_t_abnormality due to changes in count_abnormal that abnormal argument is taking list as input now.
  • Changed the tm_g_pp_patient_timeline parameter, cmtrt, to cmdecod.

New features

  • New module tm_t_abnormality_by_worst_grade was added for the analysis of laboratory test results with highest grade post-baseline.
  • Enhanced tm_t_ancova to include selected parameter(s), visit(s) and the analysis variable in title of the table.
  • New module tm_g_lineplot was added for creating line plots.
  • Enhanced tm_t_logistic to include selected parameter in title of the table.
  • Enhanced tm_g_forest_rsp to include selected parameter in title of the table.
  • Enhanced tm_g_forest_tte to include selected parameter in title of the table.
  • Enhanced tm_g_pp_patient_timeline with bold axes labels and integer values on the axis.
  • Enhanced tm_g_ipp to allow users not to display AVALU in the title nor in the y axis.

Enhancements

  • Added support for logging with the logger package and added info level logs upon initialization of a module.
  • Added default_responses argument to tm_t_binary_outcome and tm_g_forest_rsp to allow the user to specify default selected responses and possible response levels.
  • Updated tm_t_binary_outcome to show only the selected responses in the output table when "Show All Selected Response Categories" is checked.
  • Added rsp_table argument to tm_t_binary_outcome to allow the user to initialize the module matching the RSPT01 STREAM template.
  • Added support for custom arguments for ggplot2::labs and ggplot2::theme in plot based modules.
  • Added support for custom arguments for rtables::basic_table in table based modules.
  • Updated tm_t_binary_outcome to enable an option to apply a continuity correction in the Wilson method.

Miscellaneous

  • Updated R version requirement to >= 3.6.
  • Refactored calls to the defunct teal.devel::data_extract_input into calls to its replacement teal.devel::data_extract_ui.
  • Updated modules to use new data_merge_module interface provided by teal.devel and removed usage of the now deprecated function teal.devel::get_input_order.
  • Updated tm_t_binary_outcome module to add a template and removed the now deprecated module tm_t_rsp.
  • Removed utils.nest dependency and replaced calls with checkmate equivalents.

Bug Fixes

  • Fixed bug in tm_g_pp_therapy where if the cmstdy or cmendy argument is of type integer causes the plot to crash.

v0.8.10

13 Oct 00:01
4a74905
Compare
Choose a tag to compare

New features

  • New module tm_t_smq was added for the analysis of adverse events by Standardized MedDRA Query.
  • New module tm_t_shift_by_grade was added for the analysis of grade laboratory abnormalities.
  • New module tm_t_exposure was added for the analysis of duration of exposure for risk management plan.
  • New module tm_t_shift_by_arm that can display shift table of ECG interval data.

Bug fixes

  • Corrected tm_a_mmrm to be able to consider the treatment variable in additional interactions.
  • Fixed tm_t_binary_outcome and tm_t_rsp so that correct CI estimation method is chosen for Proportions Difference in Stratified Analysis (i.e. Wald-type confidence interval with CMH weights).

Enhancements

  • Added validation checks to tm_t_rsp and tm_t_binary_outcome for stratification errors when filters are applied.
  • Added tm_g_km validation check for plot tables font size.
  • Enhanced tm_g_km to add the selected paramcd in the plot title.
  • tm_t_events now can display layouts with two nested column as treatment variables. The same pruning and sorting options can be applied.
  • Previously package helper functions were never exported. These functions have now been exported so they can be utilized.
  • tm_t_events_by_grade now can display grading groups in nested columns with col_by_grade option. In addition, module now supports pruning and sorting options similar to tm_t_events.
  • Used format_count_fraction to fix formatting inconsistency in tm_t_events_summary.
  • Updated count_occurrences vars argument in tm_t_shift_by_grade.
  • Updated tm_t_pp_laboratory to display 4 decimals by default.

Miscellaneous

  • Updated LICENCE and README with new package references.
  • Added error_on_lint: TRUE to .lintr.
  • Removed insert_rrow and updated usage of count_patients_by_flags in tm_t_events_summary.
  • Changed how the package calls functions from the dplyr package. The functions should be now fully specified (e.g. dplyr::filter).

v0.8.9

19 Aug 22:14
Compare
Choose a tag to compare
  • Added a capability to remember the order of user input to some encoding UI elements. The inputs with tracking enabled are marked with a double arrow icon. The affected modules are: tm_t_summary, tm_t_summary_by, tm_g_forest_rsp, tm_g_forest_tte, tm_t_events_summary, tm_t_abnormality, tm_t_mult_events.
  • Added a new argument numeric_stats to tm_t_summary and tm_t_summary_by to control displayed summary statistics for numeric variables.
  • Added a new argument drop_zero_levels to tm_t_summary_by so that rows with all zeros can be dropped from result
    table.
  • Split tm_g_patient_profile tabs into 8 separate new modules.
  • Added the option to select patient ID from the filter panel for all the modules of patient profile.
  • Added an additional validation for tm_g_patient_timeline when the plot is empty.
  • Enhanced tm_a_mmrm to work without the treatment variable.
  • Added the option to choose the number of decimal places for rounding in tm_t_pp_laboratory.
  • Added a check box to tm_g_pp_patient_timeline hiding/showing relative study days on the x-axis.
  • Added a title with patient's id to plots in patient profile modules.
  • Made the grey error message in tm_g_forest_tte more informative when the Endpoint column was deselected in the left-hand encoding panel.
  • Added the twenty-fifth and seventy-fifth quantile to summary statistics in tm_t_summary.
  • Added an interaction p-value column for tm_t_coxreg.
  • Added an additional validation for tm_t_ancova when selected covariate variables contain just one level.
  • Added an additional validation for tm_t_events_patyear when the events variable is empty.
  • Changed the description of the font size input in Additional plot settings (tm_g_km) to more precisely represent what it controls.
  • Enhanced tm_t_logistic so that interaction choices depend on the selected covariates.
  • Enhanced tm_t_rsp so that strata input is only visible when treatments are compared.
  • Fixed Get R Code output of tm_t_pp_laboratory to return identical HTML formatted table as displayed in the app.
  • Added an additional validation for tm_t_coxreg to ensure treatment, strata and covariate variables do not overlap.
  • Limited the label repel feature in tm_g_pp_patient_timeline to X-axis for a more consistent look.
  • Updated tm_t_summary_by so that paramcd is not required when analyzing ADSL variables.
  • Updated tm_t_coxreg so that it can work when there is no covariate selected.
  • Updated tm_a_mmrm so that it can work when treatment variable is not selected.
  • Updated tm_g_forest_tte so that total number of events are also shown in the table.
  • Updated tm_t_events_summary to work with pooled studies.
  • Updated tm_t_coxreg to validate the at level.
  • Updated tm_t_logistic to validate the at level.
  • Added an additional validation for tm_t_binary_outcome and tm_t_rsp to ensure strata variable
    contains more than one level when just one strata variable is selected.
  • Updated the warning message when all statistics are deselected in tm_t_summary and tm_t_summary_by explaining at least one statistic has to be selected.

v0.8.8

19 Aug 22:14
Compare
Choose a tag to compare
  • Added the option to download and expand tables.
  • In tm_g_km added support for downloading images and updated x-axis label to be shown in title case.
  • For tm_g_patient_profile:
    • Added a slider for the font size in plots.
    • Added persistence for selected table lengths.
    • The timeline plot now supports more edge cases.
    • In vitals tab, removed unused label text legend, updated plot to display stable colors per levels, cleared x-axis limit and fixed legend to update when filtering. Also added a note to clarify the supported horizontal lines cases.
    • Updated adverse events tab to show a warning message instead of an empty plot when data is empty.
    • Fixed PARAMCD selected levels for current patient.
  • For tm_t_tte:
    • Updated the pre-processing code inside template_tte so that a dataset without any events still produces a table.
    • Updated code to use correct denominator for duration of response endpoints.
  • For tm_t_summary:
    • Modified the parameter arm_var to accept more than one column. When two columns are selected for arm_var, then the second variable will be nested under the first one.
    • Added argument show_labels to template_summary so that the label for a single summary variable is shown in the table.
  • Added a new parameter conf_arg to tm_t_rsp to be consistent with other efficacy modules.
  • Added validate statement in tm_g_ipp module to print message when Timepoint Variable drop down is deselected.
  • Removed header definition in tm_g_forest_rsp and tm_g_forest_tte as there is now a default header in g_forest.
  • Fixed validate statement in tm_t_coxreg so that models without strata and using likelihood tests return a result.
  • Clarified functionality of drop_arm_levels for tm_t_summary and tm_t_summary_by. In the encodings panel, the checkbox will only be shown when the parent dataset and analysis dataset are different.
  • Replaced the remaining two observe function calls with observeEvent to optimize performance.
  • Fixed grammar in the "Select a patient's id" error message in the tm_g_patient_profile.
  • Fixed the font_size default of the templates to be 12L instead of a vector of 3 integers and cleaned associated unnecessary code.
  • Fixed deprecated function warning in tm_g_barchart_simple.
  • Fixed subgroup_var definition truncation in tm_g_forest_rsp and tm_g_forest_tte.
  • Clarified "Type of Regression" related labeling in the encoding panel from tm_t_coxreg.
  • Added a validation for the case when all rows are filtered out in the therapy tab of tm_g_patient_profile.
  • Updated the internals of the modules to read data from the correct field of the filter_spec objects.
  • Fixed the reactivity between the filter panel and the PARAMCD variable levels input in tm_g_patient_profile vitals tab so that the plot does not get reset when filtering.
  • Updated the vitals plot tab in tm_g_patient_profile to drop NA entries in the plot.