Changelog

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
• Introduced teal_transform_module to provide a way to interactively modify data delivered to teal_module’s server. #1228
• 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
• Introduced a function set_datanames() to change a datanames of the teal_module.
• 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.

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.
• The landing_popup_module() needs to be passed as the landing_popup argument of init instead of being passed as a module of the modules argument of init.
• teal no longer re-export %>%. Please load library(magrittr) instead or use |> from base.

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.

Bug fixes

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

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

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.

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.
• Updated the header tag style to enhance element containment.

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.

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.

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.

Enhancements

• Added new function reporter_previewer_module to wrap the teal.reporter package previewer functionality as a teal module.
• Updated teal to support modules which include reporting. If any module which supports reporting is included then a reporter_previewer_module is included.
• Added default arguments to module() and the server argument is now a function where the second argument can be ... or datasets.

Breaking changes

• Deprecated bookmarkableShinyApp. In future releases the teal framework will stop supporting shiny bookmarking (which has not officially been supported); it may be officially supported in the future. Note the filter panel in teal.slice retains its ability to save and restore its state if used in a standalone shiny app with bookmarking.

Miscellaneous

• Added a template to the pkgdown configuration.
• Removed unneeded shinytest app tests.
• Updated package authors.
• Added package vignettes.

New features

• A simple new teal module named example_module has been included in the package.

Breaking changes

• teal package has been split into multiple smaller packages, see above.
• Deprecated root_modules function, users should use modules directly inside init.
• Due to deprecation of root_modules any label argument to modules must be explicitly named. For example modules("lab", mod1, mod2) should be replaced with modules(label = "lab", mod1, mod2).

Miscellaneous

• Minor changes to internals of teal: main module panel now has fixed shiny name root and the active tab is named active_tab not Active_tab.
• MultiAssayExperiment is now suggested packages, not required. Objects dependent on MultiAssayExperiment are changed to lazy-load this now suggested package.

Bug fixes

• Showing R Code no longer shows reproducibility warning message if reproducibility check has passed.

Breaking changes

• Changed the HTML identifiers of teal modules - now each nested module receives its own shiny namespace.
• Deprecated all functions related to connectors that have been moved to their own separate packages.
• Removed raw_dataset, raw_dataset_connector, named_dataset, named_dataset_file, named_dataset_connector, relational_dataset, relational_dataset_file, relational_dataset_connector, key, as_cdisc, as_cdisc_relational.
• Removed rcd_connection and rcd_data; scda_dataset_connectors can be passed into cdisc_data and teal_data directly.
• Replaced rcd_dataset_connector and rcd_cdisc_dataset_connector with scda_dataset_connector and scda_cdisc_dataset_connector respectively.
• Renamed teal_show_js_log option into teal.show_js_log to match options naming convention.
• Removed %is_in% and stop_shiny internal utility functions.

New features

Bug fixes

• choices_selected now correctly removes duplicates from the array passed to its choices parameter.
• Fixed call returned by FilterState in case of using MultiAssayExperiment::subsetByColData. Now single condition for variable containing NA values is !is.na(var) & var == <condition>.
• Fixed data loading of DatasetConnector being dependent on other Dataset or DatasetConnector objects.
• Fixed restoring a bookmarked filter state of teal application.
• Refactored module_nested_tabs to fix the issue with the filter panel not reacting to an input change in a nested module.
• updateOptionalSelectInput no longer sets input to NULL when logical value is passed to selected.
• Fixed setting JoinKeys when key name between two Dataset object differs.
• Fixed printing of the JavaScript console logs to the R console when teal.show_js_log = TRUE.

Miscellaneous

• Soft-deprecate mae_dataset() in favor of more general dataset() constructor.
• Added a vignette describing the modifications to teal applications users can apply using R options.
• Added default values to the label argument of select_spec and filter_spec.
• Added validation to FilteredDataset::get_data to accept logical input only.
• Changed references to outdated functions of teal.devel in the documentation.
• Introduced a Teal prefix to all public R6 classes to avoid name collisions with other packages.
• Removed dependency on utils.nest and replaced its functionality in teal with equivalents from the checkmate package and base R.
• Replaced the old shiny server functions of DataConnection, RelationalDataConnector, DatasetConnector, and RelationalData with the shiny::moduleServer equivalents.
• Running a teal application via ui_teal_with_splash and srv_teal_with_splash is now no longer recommended because it doesn’t support new features (e.g. logging, bookmarking). Use init instead.
• Updated the R version requirement to >= 4.0.
• Updated the “filter panel collapse” icon to remove warnings when using shiny version >= 1.7.
• Removed some of the non-exported, debugging modules.
• Updated the footer tag style to be less visible.

New features

• Allow passing MultiAssayExperiment to the teal::init using mae_dataset function or through the connectors.
• Refactored filter panel to use MultiAssayExperiment objects. Filters can be set on a subject level (colData of MAE object) and on a experiment level (colData and rowData of an assay).
• Added cdse_dataset_connector to create delayed data objects from CDSE.
• Added datasetdb_dataset_connector to create delayed data objects from DataSetDB.
• Added ricepass_connection to create delayed data objects from entimICE via ricepass.
• Refactor of the filter panel:
  • Simplified setting of initial filter state without need to specify “choices” or “range” named list element depending on the variable class.
  • Dataset type determines an appearance and a functionality of related filters and filters summary.
  • Datasets are passed (by reference) from DDL to FilteredData skipping extracting data and their attributes.
  • Redesigned variable filter labels in “Active Filter Variables” panel.
  • Fully testable server functions.

Bug fixes

• Fixed the bug caused by calling mutate_dataset multiple times on the same DatasetConnector or Dataset object.
• Fixed a bug that caused the output of get_code function to not reproduce its raw data set.
• Changed filter_spec to allow no variable selection upon app initialization, where the first possible value was previously selected.

Enhancements

• modules parameter of teal::init function can also receive a list except root_modules function call.
• Added split and merge methods to the JoinKeys object.
• Added all_choices() as a possible argument to the selected parameter of filter_spec, select_spec and choices_selected indicating that all choices are selected.
• The append method of a CodeClass object has been modified to print a warning message when the argument does not result in any code being added because it is duplicated.
• Implemented delayed functionality to the mutate method of the Dataset and DatasetConnector objects.
• Modified teal_data to return a CDISCData object whenever any of its arguments is a type of CDISCData object.
• Updated filters to show both levels of a logical variable TRUE/FALSE even if one is missing from the original array.

Miscellaneous

• Updated LICENCE and README with new package references.
• Added a method get_hash to the Dataset class returning the MD5 hash of the object stored inside the Dataset object.
• Replaced random.cdisc.data with scda in examples and tests.
• Implemented functionality to store JoinKeys in Dataset and DatasetConnector classes.
• Added error_on_lintr: TRUE to .lintr
• The pipe operator %>% is now exported such that downstream code and packages can use it.
• Removed hyperlinks to the rice package from the documentation.

Enhancements

• Added informational stop message when using mutate_data with RelationalDataConnector.
• Modified as_cdisc to behave similarly to cdisc_dataset when called on a Dataset object.
• Changed the displayed format of the data name and the column name in data_extract_spec UI elements. Both are now compressed to <data name>.<column name> if they don’t change during runtime of the app.
• Added ADSAFTTE to the list of recognized ADaM dataset names.
• Added another example to data_extract_spec’s doc string showcasing app users can choose a variable used for filtering in the encoding panel.
• Added CSS styling to tool tips in teal modules.

Bug fixes

• Fixed an edge case error when creating a filter on variable with all missing values crashed the app.
• Fixed a bug that crashes app whenever a Date or datetime column is selected from a filter_spec.

Enhancements

• Released snowflake connection and connectors.
• Changed ordering of datasets to be more intuitive (topologically first for CDISC datasets only and then according to input datasets order).
• When closing a teal app (ending a user shiny session), all DataConnections will now try to close their connections.
• Added ADHY keys to configuration file.
• Extended the filter_spec function: the parameter choices is no longer mandatory (the function will take all possible choices by default) and the vars parameter additionally accepts the choices_selected and allows to change the variables for filtering using the UI elements in the encoding panel.

Bug fixes

• Cleaned up imports in the package.
• Modified value_choices function to handle edge case when "NA" and NA values exist in the character column that choices are derived from.
  
• Fixed issue with cloning Callable class.

New Features

• Support for data-standard independent input and filtering. That includes refactor of the all data and dataset structures together with refactor of FilteredData class.
• New JoinKeys class (with join_keys() constructors and join_key() constructor for its elements) to store joining key columns between datasets.
• Refactored the most basic dataset() constructor, added cdisc_dataset() constructor and as_cdisc() conversion function.
• Soft-deprecate removed class constructors and obsolete functions (e.g. keys()).
• Added get_keys() and set_keys() functions to extract and manipulate datasets primary keys respectively.
• Unexported filtered_data_new, filtered_data_set and filtered_data_set_filters.

Bug fixes

• Duplicated lines of code passed to teal::cdisc_dataset and other teal::RelationalDataset constructors should now be shown when getting the code from teal::cdisc_data objects and other teal::RelationalData objects.
• Added ability to press “Enter” key without having to set focus to the Submit button for delayed data loading.
• Allow variable_choices to use datasets with missing labels.
• Fixed bug that ignores input of NULL to selected argument of select_spec function.

Enhancements

• Added button to remove all active filters from the Filter Panel.

New Features

• Added python_dataset_connector to create delayed data objects from python scripts or directly from python code.
• NOTE: python_dataset_connector is not yet ready to be deployed on RSConnect because it does not contain numpy and pandas, which are Python libraries used in python_dataset_connector.
• Added support for filtering on Date and Datetime variables in the Filter Panel.
• Added buttons for date and datetime filter widgets to reset the value to the original.
• Added new function check_key_duplicates, which creates a short summary about rows with duplicated primary key (row numbers and the number of duplicates)

Enhancements

• Fixed lack of labels for character and factor variables in the Filter Panel.
• All variables are now displayed in module_filter_panel, not only those of types numeric, logical, factor, character and Date
• Fixed mutate_data to accept the whole scope of objects for vars.
• Clarified teal::init function documentation to state that custom CSS loading code with htmltools::htmlDependency should be included in the header argument rather than inside UI arguments of modules.
• Enabled empty select field inside data_extract_spec.
• Added new argument drop_keys to filter_spec to decide whether to drop or keep keys columns on single filter on those columns.
• Added a new optional argument keys to variable_choices. keys specifies the names of the variables, which should have the new key icon shown next to them in the variable drop down menus in the left-hand side encoding panels instead of the icon appropriate for their original R variable type. variable_choices now also works with RelationalDataset and RelationalDatasetConnector objects.

Miscellaneous

• Removed include_factors option in get_class_colnames in RawDataset.

Refactor of FilteredData (for developers)

• FilteredData is now fully reactive. Now filtered data is lazy evaluated as per need. This further opens the door to bookmarking teal apps (bookmarking currently works for the right filtering panel, but we will make this feature more sophisticated in a future release, each module must be reviewed and adapted if it contains reactiveValues).
• Datasets and materialized connectors are provided to FilteredData by set_datasets_data function located in init_datasets.R file.
• Renamed get_dataset() method to get_data().
• Renamed get_filter_call() method to get_filter_expr(); returns an expression rather than a list.
• Removed argument isolate from get_data() method and similar methods. You must isolate it yourself as needed. If you want to temporarily deactivate shiny errors due to missing errors, you can set options(shiny.suppressMissingContextError = TRUE). In general, avoid isolate as this breaks reactivity.
• We added a development module to add several filters at once, e.g. safety filters. This is to be evaluated before it is converted into a proper module and made available to end-users.

New features

• tm_scatterplot module.
• tm_table module.

Changes

• All tabs arguments were renamed to modules.
• tab_item function is now called module.
• tab_items function is now called modules.
• tabs function was removed.
• variable_browser_item is now called tm_variable_browser.
• data_table_item is now called tm_data_table.
• datasets argument is automatically added to the server functions specified with module. Hence teal_datasets has been removed as a server_args element.