Releases: insightsengineering/teal
Releases · insightsengineering/teal
v1.1.0
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_moduleandshow_rcode_modalthat were deprecated in 0.16.0.
New features
initandsrv_tealhave newreporterparameter, that allows to pre-defineteal.reporter::Reporterobject to be
used for storing the content of the report. You can also globally disable reporting by settingreporter = NULL
(anddisable = TRUEinui_tealfor cases whenui_tealis 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_reportandteal_cardclass 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
renderUIby @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_srvby @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
Full Changelog: v1.0.0...v1.1.0
v1.0.0
Breaking changes
- The
reporter_previewer_module()is deprecated and will be removed in the future release. The customserver_argsvalues can be set usingoptions():teal.reporter.nav_buttonsto control which buttons will be displayed in the "Report" drop-down.teal.reporter.rmd_outputto customize the R Markdown outputs types for the report.teal.reporter.rmd_yaml_argsto customize the widget inputs in the download report modal.teal.reporter.global_knitrto customize the globalknitroptions for the report.
Enhancement
- Improved the layout and appearance of the app using
bslibcomponents. - 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 returnsteal_data.
What's Changed
- Remove incorrect changelog item (2/2) by @vedhav in #1502
- Implement bslib and use Bootstrap 5 by @vedhav in #1503
- after bslib changes by @gogonzo in #1506
- Final UI and bslib changes by @vedhav in #1510
- Improve the teal sidebar by @vedhav in #1517
- update snapshot manager button title by @donyunardi in #1519
- Fix link to a renamed section by @llrs-roche in #1538
- Fix failing checks by @llrs-roche in #1549
- fix scheduled jobs by @m7pr in #1550
- chore: bump teal.logger dependency to 0.4.0 and remove from Remotes by @m7pr in #1554
- Redesign the teal modules by @vedhav in #1548
- added nina by @kumamiao in #1558
- Update DESCRIPTION for r-lib/mirai and r-lib/nanonext by @shikokuchuo in #1564
- Update screenshots to new UI by @llrs-roche in #1560
- Updates public API calls from
teal.slicethat fixes R6finalize()messages by @averissimo in #1567 - Redesign and change position of reporter options by @vedhav in #1562
- Fix
TealAppDrivernamespace due to changes in tab navigation by @vedhav in #1570 - Fixes TealAppDriver & implement regression tests by @averissimo in #1559
- Update the reproducibility section of "Including Data in teal Applications" vignette's by @llrs-roche in #1553
- Update gif instead of shinylive by @llrs-roche in #1569
- Final UI/UX changes by @vedhav in #1571
- Vignette changes by @vedhav in #1572
- Remove extra space when the data tab is removed when
once = TRUEby @vedhav in #1573 - Update vignettes with the latest screenshots by @vedhav in #1574
- Update lifecycle badges by @m7pr in #1575
- obtain a named list from environment by @gogonzo in #1576
- dont display data button when once = TRUE by @gogonzo in #1579
- eval_code/within.teal_data_module ignores once value by @gogonzo in #1578
- fix shinytest2 by @gogonzo in #1580
- [skip vbump] upversion v1.0.0 by @donyunardi in #1583
New Contributors
- @kumamiao made their first contribution in #1558
- @shikokuchuo made their first contribution in #1564
Full Changelog: v0.16.0...v1.0.0
v0.16.0
New features
- Possible to call
ui_tealandsrv_tealdirectly in any application by deliveringdataargument as areactivereturningteal_dataobject (#669). - Since introduction of
ui_tealandsrv_tealfunctions, theidargument ininitis being deprecated (#1438). - Introduce
ui_session_infoandsrv_session_infoshiny module to create the user session info and teal app lockfile download button. - Introduced
teal_transform_moduleto provide a way to interactively modify data delivered toteal_module'sserverand to decorate module outputs, along with a vignette to demonstrate its usage (#1228, #1384). - Introduced a new argument
once = FALSEinteal_data_moduleto 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 whenmodule'sdatanamesis set as"all". - Added warning when reserved
datanames, such asalland.raw_dataare 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()ondatapassed to teal application no longer has effect. In order to changeteal_module's
datanamesone should modifymodule$datanames. landing_popup_module()is deprecated. Please useadd_landing_modal()function to add a landing popup for your teal application.tealno longer re-export%>%. Please loadlibrary(magrittr)instead or use|>frombase.build_app_titlewill be removed in the future release. Please use themodify_title()function to change the title for your teal application.- The
title,header, andfooterarguments of theinit()function are deprecated. Please use themodify_title,modify_header, andmodify_footerrespectively.
Enhancement
- Enhanced a system of data validation and a display of error messages.
- Easier way of to call
javascriptevents 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
datapassed to theteal_module's server consists unfiltered datasets contained in.raw_data.
What's Changed
- Create CLA Workflow by @cicdguy in #1134
- Inherit core workflow secrets by @cicdguy in #1141
- 445 unify html tags by @kartikeyakirar in #1122
- 52 standardise optional notation by @kartikeyakirar in #1121
- Introduce shinytest2 by @vedhav in #1127
- 503
$get_html_rvestmethod forTealAppDriverby @m7pr in #1158 - 503 shinytest2 for session info link in bottom of the page by @m7pr in #1145
- 503 shinytest2 for
Show R codemodal by @m7pr in #1146 $active_module_element_textmethodTealAppDriverby @m7pr in #1167- 503 shinytest2 fixes bug with setting numeric range by @averissimo in #1152
- register teal.logger handlers; replace few loggers with base by @pawelru in #1081
- 503 shinytest2 for
teal_data_moduleby @averissimo in #1148 - Update bootstrap-themes-in-teal.Rmd by @abodoni in #1170
- 503 Applying suggestions by @averissimo in #1161
- 503 shinytest2 for
landing_popup_moduleby @m7pr in #1138 - Migrate to new API calls on
TealAppDriverby @averissimo in #1174 - add wrapper for wait_for_value for output value. by @kartikeyakirar in #1172
- 1163 extend
TealAppDriver$new()andTealAppDriver$click()with$wait_for_idle()calls by @m7pr in #1171 - 898 save app state version 3 by @chlebowa in #1011
- Adds extra parameters to methods that call
TealAppDriver$set_inputs(shinytest2) by @averissimo in #1175 - Expose method in
TealAppDriverthat checks if elements are visible by @averissimo in #1182 - vbump teal.data by @pawelru in #1194
- update wait time to 5 secs by @donyunardi in #1196
- Adds double colon prefix to
platform_variant()by @averissimo in #1198 - Tests wait for idle by default after setting module input by @averissimo in #1200
- Fixes bug on set_module_input by @averissimo in #1201
- 1203 rename
TealAppDriver$set_module_inputtoTealAppDriver$set_active_module_inputby @m7pr in #1204 - add link to the video by @donyunardi in #1206
- Fixes integration tests when Chrome >=105 is not installed by @donyunardi in #1202
- New methods for
TealAppDriver:get_active_module_*ws_outputby @m7pr in #1208 - Support Load Reporter by @Polkas in #1120
- Workflow propagation by @walkowif in #1144
- Fix shinytest2 app init on R 4.4.0+ by @vedhav in #1211
- vbump the
teal.reporterdependency by @vedhav in #1213 - Extend the table fetcher to handle DT tables too by @vedhav in #1210
- 1128 remove fluff in imports by @m7pr in #1214
- 1154 deprecation for
show_rcode_modalby @m7pr in #1217 - A method to check for page stability when shiny is not busy by @vedhav in #1222
- Fix the integration tests by alternative by @vedhav in #1237
- Improve progress bars by @chlebowa in #1236
- progress bars follow-up by @chlebowa in #1241
- Bumps
{rmarkdown}minimal version by @averissimo in #1221 module_tealdocumentation update by @kartikeyakirar in #1227- modify
hideSidebarandshowSidebarfuncitons to work in embedded apps by @chlebowa in #1239 - 479 add
renv::snapshot()for.lockfilewithfuture+shiny::ExtendedTaskby @m7pr in #1232 - Update bootstrap-themes-in-teal.Rmd by @Alexandra01 in #1252
- Update teal-options.Rmd by @pawelru in #1254
- fix
noSuggestscheck by @pawelru in #1259 - Workflow propagations by @walkowif in #1285
- add refs to rhub workflow by @pawelru in #1291
- Feature branch PR by @gogonzo in #1253
- Always position the teal util icons in the same place by @vedhav in #1296
- get_teal_bs_theme(): use checkmate for throw and check by @pawelru in #1318
- Config/Needs/verdepcheck cleanup; init() cleanup by @pawelru in #1313
- docs: correct get_client_timezone return value by @pawelru in #1314
- vbump deps by @pawelru in #1326
- check reactive using custom checkmate extension by @pawelru in #1324
- 1299 do not show datanames error if there are transformers passed to modules by @m7pr in #1319
- update readme by @pawelru in #1331
- datanames slot in
teal_transform_module(ignore@datanames) by @gogonzo in #1334 - vbump teal.logger by @pawelru in #1343
- Workflow propagations by @walkowif in #1332
module()$datanames: unifycombined_datanamesno matter what's the length oftransformersby @m7pr in #1344- 479 mirai lockfile@main by @gogonzo in #1263
- Change name of the raw (unfiltered object) by @gogonzo in #1342
- increase timeout for ci by @donyunardi in #1355
- 1304 handover error@main by @gogonzo in #1341
- Run GitHub Actions with
setup-r-dependenciesinstallation st...
v0.16.0-rc2: 1494 fix note (#1495)
fixes #1494 RHUB workflow https://github.com/insightsengineering/teal/actions/runs/13372139467
v0.15.2
Bug fixes
- Fixed a bug in handling
datanamesof modules that crashed module-specific applications when filtering child datasets.
What's Changed
- 1110 when no filters provided, report card should notify about it by @m7pr in #1111
- add options for strict testing by @pawelru in #1102
- Use
teal.data::get_codeinstead ofteal.data:::get_code_dependencyby @m7pr in #1090 - name specific lintr in utils.R by @m7pr in #1118
- audit linter exceptions by @chlebowa in #1119
- 1125 bug fix@main by @chlebowa in #1126
- describe last patch in NEWS by @chlebowa in #1129
- Enables module-specific filters on
initexample by @averissimo in #1133 - [skip vbump] upversion v0.15.2 by @donyunardi in #1137
Full Changelog: v0.15.1...v0.15.2
v0.15.1
Bug fixes
- Fixed a bug that stopped the
module_specificfeature when atealmodule specifieddatanamesof length more than 1.
Miscellaneous
- Updated links in vignettes
v0.15.0
New features
- Added
landing_popup_modulefunction 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_tdatafunction to facilitate migration of modules to the newteal_dataclass. - Added
build_app_titlefunction to facilitate adding favicons to app title.
Breaking changes
dataargument ininitnow accepts onlyteal_dataandteal_data_module.tdatahas been deprecated and replaced withteal_data. Support fortdatapassed to thedataargument inmodule(server)will be removed in the next release.module(ui)argument no longer acceptsdataanddatasetsarguments. All data dependent logic should be set in the server function.module(server)argument deprecateddatasetsargument.teal_modules' server functions should acceptdata(teal_data) instead.- Changed the order of formal arguments in
init.filternow comes directly aftermodules, beforetitle.
Miscellaneous
- Enhanced a
modulevalidation checks so that it won't throw messages aboutdataargument unnecessarily. - Added argument to
teal_slicesand made modifications toinitto enable taggingteal_sliceswith an app id to safely upload snapshots from disk. FilteredDatano longer stores pre-processing code in specific slots. Code is now attached as attribute. Adjusted appropriately.
Bug fixes
- Removed
Report previewermodule from mapping matrix display in filter manager. - Specified minimal version of package dependencies.
v0.14.0
New features
- Enabled module specific filter panel. See
module_specificinteal::teal_slicesdocumentation. - Enabled capturing and resetting application filter state with snapshots. See
?snapshot. - Enabled
reporter_previewer_moduleto customize default values throughsrv_args. - Enabled passing own
reporter_previewer_modulein a list of modules to override default one.
Breaking changes
- Specifying
filterargument inteal::initrequiresteal_slicesobject now. Details in documentation ofteal::init. - Soft deprecated
filtersargument inmoduleand replaced it withdatanames. Details in documentation ofteal::module
Miscellaneous
- Removed
scdapackage dependency from examples.
What's Changed
- 835 - get_rcode_*() starts new code chunks in newlines by @m7pr in #836
- documentation typo in get_rcode by @m7pr in #841
- Update workflows by @walkowif in #820
- Update workflows by @walkowif in #842
- Rewrite unclear sentence in creating-custom-modules.Rmd by @m7pr in #854
- Workflow propagations by @walkowif in #855
- Decouple scda by @gogonzo in #858
- extend default report previewer by @gogonzo in #849
- Refactor of the filter panel by @gogonzo in #851
- 355 rename module_add to allow_add by @kartikeyakirar in #863
- Move TealReportCard to teal by @gogonzo in #865
- 298 reset button by @chlebowa in #859
- typo in creating-custom-modules.Rmd by @m7pr in #853
- 382 rename internal functions by @chlebowa in #868
- restart auto by @gogonzo in #873
- restart auto by @gogonzo in #874
- fix r-universe deployment by @gogonzo in #875
- Update install by @gogonzo in #876
- 870 some bugs@main by @chlebowa in #872
- 818 documentation cleanup by @m7pr in #869
- 867 modify mapping matrix by @chlebowa in #879
- 769 replace filters argument by @chlebowa in #877
- handling initial teal_slice by @gogonzo in #880
- fix by @gogonzo in #881
- 884 disappear cog icon by @chlebowa in #886
- add placeholders to managers by @chlebowa in #887
- 410 note experimental by @chlebowa in #888
- update install guide; add getting help; pkg name lowercase by @pawelru in #890
- move gif to man dir by @pawelru in #894
- release 0.14.0 [skip vbump] [skip spelling] by @donyunardi in #897
Full Changelog: v0.13.0...v0.14.0
v0.13.0
Breaking changes
- The use of
datasetsargument inmoduleshas been deprecated and will be removed in a future release. Please usedataargument instead.datais of typetdata; see "Creating custom modules" vignettes and function documentation ofteal::new_tdatafor further details. - Due to deprecation of
chunksinteal.code, thetealframework now uses their replacement (qenv) instead. The documentation intealhas been updated to reflect this and custom modules written withchunksshould be updated to useqenv. - Due to deprecation of
chunksinteal.code,get_rcode,get_rcode_srv, andget_rcode_uihave been removed.
New features
- Added the
validate_inputsfunction that transfers input validation messages to app output. modulesargument ofinitacceptsteal_moduletype of object. There is no need to wrap up a single module inmodules()orlist().- Updated
module_nested_tabsso 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
tealapplications. - Added data hashing step using
rlanginstead ofdigestpackage to calculate the hash (which has been moved fromteal.dataandteal.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 functionslog_app_usageand.log. - Updated the "Teal and Bootstrap Themes" vignette to provide more details customizing a
tealapp withbslib::run_with_themer. - Removed outdated diagram from
srv_nested_tabsdocumentation. - Changed default values of
headerandfooterarguments ininitto empty text.
What's Changed
- [skip vbump] Dev version with 9xxx by @arkadiuszbeer in #763
- use scda.2022 by @nikolas-burkoff in #766
- Add sessionInfo by @nikolas-burkoff in #767
- Teal refactor by @nikolas-burkoff in #768
- Add coverage badge by @walkowif in #772
- Enable checks for
workflow_dispatchevent by @walkowif in #773 - add hashing by @mhallal1 in #774
- Fix failing test by @gogonzo in #777
- 757 remove deprecated@main by @chlebowa in #780
- remove root_modules function by @donyunardi in #754
- Remove soft-deprecated function log_app_usage and .log by @chlebowa in #781
- Remove soft deprecated function
bookmarkableShinyAppby @chlebowa in #782 shinyvalidateimprovements by @chlebowa in #786shinyvalidateimprovements reopened by @chlebowa in #788- Badges and contribution guidelines by @insights-engineering-bot in #790
- docs by @mhallal1 in #791
- convert check to assert by @pawelru in #795
- Update bootstrap vignette by @asbates in #798
- Fix deprecation warning in tests by @nikolas-burkoff in #797
- fix failing tests on R 4.3 by @gogonzo in #800
- fix bug in
validate_inputsby @chlebowa in #793 - Add diagram, update NEWS by @donyunardi in #801
- Update check as-cran and default landing page by @walkowif in #805
- teal reactivity solution 2 by @mhallal1 in #806
- add teal.gallery ref to readme by @pawelru in #810
- Documentation fixes for release review by @asbates in #819
- 723 default header@main by @chlebowa in #824
- Revert removal of get_rcode by @asbates in #828
- release 0.13.0 [skip vbump] by @donyunardi in #832
New Contributors
- @walkowif made their first contribution in #772
- @donyunardi made their first contribution in #754
- @asbates made their first contribution in #798
Full Changelog: v0.12.0...v0.13.0
v0.12.0
New features
- Added the support for custom
bslibbootstrap themes inteal::initapps, please read more in the newteal-bs-themesvignette.
Enhancements
- Added the option to choose which variables can be filtered in the filter panel by using the
filterableattributes for the per-dataset lists in thefilterargument ofinit. - Updated
teal_moduleto havedataargument which receives a list of reactive filter data with"code"and"join_keys"attributes. - Updated
teal_moduleto havefilter_panel_apiargument which receives aFilterPanelAPIobject. - Updated the internals of
module_tealto reflect changes inteal.slice. - Updated vignettes and README content.
Breaking changes
- Updated
teal_moduleto no longer receivedatasetsobject in the...argument. In order to usedatasetsin theteal_moduleplease specifydatasetsexplicitly. - Deprecated
merge_expressionargument inget_rcode_srvfunction and removed it inget_rcodefunction. - Deprecated
sessionargument inget_rcodefunction.
Miscellaneous
- Enhanced the burger button so it is disabled when the filter panel is not used.
What's Changed
- [skip vbump] by @gogonzo in #666
- Contribution guide updates by @insights-engineering-bot in #671
- 443 rcycle@main by @Polkas in #637
- changes for filter panel constuctor by @nikolas-burkoff in #670
- docs: replaced links to github with links to API pkgdown sites by @kpagacz in #675
- revert - full input cycle by @Polkas in #677
- 654 pass reactive data@main by @gogonzo in #674
- DESC and README by @denisovan31415 in #684
- Update Rbuildignore and add auto-updates by @insights-engineering-bot in #685
- fix test by @mhallal1 in #688
- filter_panel_api by @mhallal1 in #692
- Fix when
module(..., filters = NULL)by @gogonzo in #694 - feat: added support for events from the filter panel by @kpagacz in #681
- Update pre-commit config to detect
_pkgdown.y[a]mlby @insights-engineering-bot in #699 - Update staged_dependencies.yaml for teal.modules.helios by @danielinteractive in #696
- pass join keys object into the module by @nikolas-burkoff in #697
- Update font awesome icon labels for FA 6 by @cicdguy in #704
- Remove _FILTERED by @nikolas-burkoff in #702
- Update documentation workflow by @insights-engineering-bot in #706
- review css by @Polkas in #703
- update vignettes by @mhallal1 in #705
- Update including-mae-data-in-teal.Rmd by @nikolas-burkoff in #725
- add set filter by @nikolas-burkoff in #724
- Update check.yaml by @arkadiuszbeer in #723
- fix R cmd check --as-cran by @nikolas-burkoff in #730
- teal - bs345 by @Polkas in #727
- NEWS by @mhallal1 in #745
- Update teal.Rmd by @Polkas in #759
- [skip vbump] Release for version 0.12.0 by @insights-engineering-bot in #761
Full Changelog: v0.11.1...v0.12.0