Skip to content

Releases: insightsengineering/teal

v1.1.0

17 Nov 13:58
4274680

Choose a tag to compare

Deprecations and removals

  • Removed ui_teal_with_splash, srv_teal_with_splash, new_tdata, tdata2env, get_code_tdata, join_keys.tdata, get_metadata,
    as_tdata, landing_popup_module and show_rcode_modal that were deprecated in 0.16.0.

New features

  • init and srv_teal have new reporter parameter, that allows to pre-define teal.reporter::Reporter object to be
    used for storing the content of the report. You can also globally disable reporting by setting reporter = NULL
    (and disable = TRUE in ui_teal for cases when ui_teal is used as shiny module).

What's Changed

  • call plot() to render the plot by @donyunardi in #1584
  • Add option to move sidebar to the right by @vedhav in #1590
  • 📑 Reporter Refactor: Adds support for new teal_report and teal_card class by @averissimo in #1541
  • remove unnecessary call by @gogonzo in #1598
  • Cheatsheet by @chizapoth in #1595
  • delete wrong @return by @gogonzo in #1602
  • Show/Hide reporter UI when teal UI is generated by renderUI by @vedhav in #1606
  • Add show r code to main ui of teal by @averissimo in #1592
  • Fixes remotes section in description by @averissimo in #1610
  • Fix the style for the broken modules tree by @vedhav in #1618
  • handle show R code button visibility with verbatim_popup_srv by @m7pr in #1616
  • Add comprehensive test coverage for teal_modifiers.R and init.R to improve package coverage by @Copilot in #1623
  • include teal-slices yaml in the Data filtering section by @gogonzo in #1634
  • Restore reporter cards by @gogonzo in #1635
  • Teal app driver changes by @gogonzo in #1633
  • Update report in custom modules vignette for new teal.reporter by @llrs-roche in #1593
  • Reuse module's label as default Card's name by @m7pr in #1636
  • Simplify after function by @llrs-roche in #1630
  • Fix inconsistent error tooltip colors between reporter and source code modules by @Copilot in #1639
  • docs: update documentation with new teal.reporter option by @osenan in #1640
  • Fixes integration tests by @averissimo in #1644
  • improve covr tests + remove deprecated functions by @m7pr in #1646
  • Enhance documentation for teal module reporting by @m7pr in #1648
  • [skip vbump] Release candidate v1.1.0 by @llrs-roche in #1649

New Contributors

  • @Copilot made their first contribution in #1623
  • @osenan made their first contribution in #1640

Full Changelog: v1.0.0...v1.1.0

v1.0.0

20 Aug 09:53
75dd87b

Choose a tag to compare

Breaking changes

  • The reporter_previewer_module() is deprecated and will be removed in the future release. The custom server_args values can be set using options():
    • teal.reporter.nav_buttons to control which buttons will be displayed in the "Report" drop-down.
    • teal.reporter.rmd_output to customize the R Markdown outputs types for the report.
    • teal.reporter.rmd_yaml_args to customize the widget inputs in the download report modal.
    • teal.reporter.global_knitr to customize the global knitr options for the report.

Enhancement

  • Improved the layout and appearance of the app using bslib components.
  • General repositioning of key navigation components across the app:
    • Modules: The module navigation is moved from a nested tab selection to a "Module" drop-down selection. The module selection can be done from the nested button of modules.
    • Reporter: The Report previewer is no longer displayed as yet another teal module, it is placed inside a "Report" drop-down right next to the "Module" drop-down. The Report previewer is a modal that displays the added report cards. The "Report" drop-down also contains other global report options like download/load/reset the Report.
    • Teal Data Module: The UI created by the teal_data_module() is now placed inside a modal that can only be closed when it returns teal_data.

What's Changed

New Contributors

Full Changelog: v0.16.0...v1.0.0

v0.16.0

24 Feb 03:36
3c8ffab

Choose a tag to compare

New features

  • Possible to call ui_teal and srv_teal directly in any application by delivering data argument as a reactive returning teal_data object (#669).
  • Since introduction of ui_teal and srv_teal functions, the id argument in init is being deprecated (#1438).
  • Introduce ui_session_info and srv_session_info shiny module to create the user session info and teal app lockfile download button.
  • Introduced teal_transform_module to provide a way to interactively modify data delivered to teal_module's server and to decorate module outputs, along with a vignette to demonstrate its usage (#1228, #1384).
  • Introduced a new argument once = FALSE in teal_data_module to possibly reload data during a run time.
  • Possibility to download lockfile to restore app session for reproducibility (#479).
  • Datasets which name starts with . are ignored when module's datanames is set as "all".
  • Added warning when reserved datanames, such as all and .raw_data are being used.
  • Added add_custom_server() to allow adding custom server logic to the main shiny server function of a teal app.

Breaking changes

  • Setting datanames() on data passed to teal application no longer has effect. In order to change teal_module's
    datanames one should modify module$datanames.
  • landing_popup_module() is deprecated. Please use add_landing_modal() function to add a landing popup for your teal application.
  • teal no longer re-export %>%. Please load library(magrittr) instead or use |> from base.
  • build_app_title will be removed in the future release. Please use the modify_title() function to change the title for your teal application.
  • The title, header, and footer arguments of the init() function are deprecated. Please use the modify_title, modify_header, and modify_footer respectively.

Enhancement

  • Enhanced a system of data validation and a display of error messages.
  • Easier way of to call javascript events by setting $(document).ready(function() { ... }) (#1114).
  • Provided progress bar for modules loading and data filtering during teal app startup.
  • Filter mapping display has a separate icon in the tab.
  • Environment of the data passed to the teal_module's server consists unfiltered datasets contained in .raw_data.

What's Changed

Read more

v0.16.0-rc2: 1494 fix note (#1495)

18 Feb 20:13
6daa390

Choose a tag to compare

fixes #1494 
RHUB workflow
https://github.com/insightsengineering/teal/actions/runs/13372139467

v0.15.2

07 Mar 23:33
06a0a58

Choose a tag to compare

Bug fixes

  • Fixed a bug in handling datanames of modules that crashed module-specific applications when filtering child datasets.

What's Changed

Full Changelog: v0.15.1...v0.15.2

v0.15.1

22 Feb 23:26
bcef4f9

Choose a tag to compare

Bug fixes

  • Fixed a bug that stopped the module_specific feature when a teal module specified datanames of length more than 1.

Miscellaneous

  • Updated links in vignettes

v0.15.0

09 Feb 16:23
e3a369b

Choose a tag to compare

New features

  • Added landing_popup_module function which creates a module that will display a popup when the app starts. The popup will block access to the app until it is dismissed.
  • Filter state snapshots can now be uploaded from file. See ?snapshot.
  • Added as_tdata function to facilitate migration of modules to the new teal_data class.
  • Added build_app_title function to facilitate adding favicons to app title.

Breaking changes

  • data argument in init now accepts only teal_data and teal_data_module.
  • tdata has been deprecated and replaced with teal_data. Support for tdata passed to the data argument in module(server) will be removed in the next release.
  • module(ui) argument no longer accepts data and datasets arguments. All data dependent logic should be set in the server function.
  • module(server) argument deprecated datasets argument. teal_modules' server functions should accept data (teal_data) instead.
  • Changed the order of formal arguments in init. filter now comes directly after modules, before title.

Miscellaneous

  • Enhanced a module validation checks so that it won't throw messages about data argument unnecessarily.
  • Added argument to teal_slices and made modifications to init to enable tagging teal_slices with an app id to safely upload snapshots from disk.
  • FilteredData no longer stores pre-processing code in specific slots. Code is now attached as attribute. Adjusted appropriately.

Bug fixes

  • Removed Report previewer module from mapping matrix display in filter manager.
  • Specified minimal version of package dependencies.

v0.14.0

14 Aug 13:42
bf6262b

Choose a tag to compare

New features

  • Enabled module specific filter panel. See module_specific in teal::teal_slices documentation.
  • Enabled capturing and resetting application filter state with snapshots. See ?snapshot.
  • Enabled reporter_previewer_module to customize default values through srv_args.
  • Enabled passing own reporter_previewer_module in a list of modules to override default one.

Breaking changes

  • Specifying filter argument in teal::init requires teal_slices object now. Details in documentation of teal::init.
  • Soft deprecated filters argument in module and replaced it with datanames. Details in documentation of teal::module

Miscellaneous

  • Removed scda package dependency from examples.

What's Changed

Full Changelog: v0.13.0...v0.14.0

v0.13.0

22 May 18:10
9b5498d

Choose a tag to compare

Breaking changes

  • The use of datasets argument in modules has been deprecated and will be removed in a future release. Please use data argument instead. data is of type tdata; see "Creating custom modules" vignettes and function documentation of teal::new_tdata for further details.
  • Due to deprecation of chunks in teal.code, the teal framework now uses their replacement (qenv) instead. The documentation in teal has been updated to reflect this and custom modules written with chunks should be updated to use qenv.
  • Due to deprecation of chunks in teal.code, get_rcode, get_rcode_srv, and get_rcode_ui have been removed.

New features

  • Added the validate_inputs function that transfers input validation messages to app output.
  • modules argument of init accepts teal_module type of object. There is no need to wrap up a single module in modules() or list().
  • Updated module_nested_tabs so that only active modules are calculated in a teal app.

Miscellaneous

  • Updated examples to use scda.2022.
  • Added R session information into a link in the footer of teal applications.
  • Added data hashing step using rlang instead of digest package to calculate the hash (which has been moved from teal.data and teal.slice). There is now an explicit hashing check in the reproducible code output.
  • Removed deprecated functions: root_modules, default_filter, bookmarkableShinyApp, as well as deprecated logging mechanism, including the functions log_app_usage and .log.
  • Updated the "Teal and Bootstrap Themes" vignette to provide more details customizing a teal app with bslib::run_with_themer.
  • Removed outdated diagram from srv_nested_tabs documentation.
  • Changed default values of header and footer arguments in init to empty text.

What's Changed

New Contributors

Full Changelog: v0.12.0...v0.13.0

v0.12.0

14 Oct 01:25
19e1529

Choose a tag to compare

New features

  • Added the support for custom bslib bootstrap themes in teal::init apps, please read more in the new teal-bs-themes vignette.

Enhancements

  • Added the option to choose which variables can be filtered in the filter panel by using the filterable attributes for the per-dataset lists in the filter argument of init.
  • Updated teal_module to have data argument which receives a list of reactive filter data with "code" and "join_keys" attributes.
  • Updated teal_module to have filter_panel_api argument which receives a FilterPanelAPI object.
  • Updated the internals of module_teal to reflect changes in teal.slice.
  • Updated vignettes and README content.

Breaking changes

  • Updated teal_module to no longer receive datasets object in the ... argument. In order to use datasets in the teal_module please specify datasets explicitly.
  • Deprecated merge_expression argument in get_rcode_srv function and removed it in get_rcode function.
  • Deprecated session argument in get_rcode function.

Miscellaneous

  • Enhanced the burger button so it is disabled when the filter panel is not used.

What's Changed

Full Changelog: v0.11.1...v0.12.0