Review exported functionalities

insightsengineering / teal

Exploratory Web Apps for Analyzing Clinical Trial Data

https://insightsengineering.github.io/teal/

Other

181 stars 39 forks source link

Review exported functionalities #1007

Open pawelru opened 11 months ago

pawelru commented 11 months ago

Please review exported functionalities and decide which one to un-export. Please edit this post to list those object and update codebase / docs accordingly. Please watch out for docs references from outside of teal (e.g. direct refs or inheritParams).

List of objects

ui_teal_with_splash, srv_teal_with_splash These are wrappers on ui_teal / srv_teal which are not exported. Users should use init. No usage outside of teal
...

averissimo commented 11 months ago

Chipping in with a possible usage for those 2 functions can be used to integrate teal within a shiny app _(or as an alternative exporting ui_teal/src_teal instead)_.

These 2 functions were used with Rhino (which is now part of pharmaverse). Here's a sample app that uses those functions and is easily deployed to Posit Connect.

This example is only a proof-of-concept on how to package {teal} as well as allowing for CSS/JS customization, unit testing of custom logic and end-2-end testing via Cypress2.

I don't think we should directly support these use cases, but exposing these 2 functions might foster and promote new ways of using {teal} especially with seamless integration in "bigger" Shiny Apps.

m7pr commented 8 months ago

show_rcode_modal looks like is not longer used https://github.com/insightsengineering/teal/issues/1154