Implement reporter buttons and simple previewer inside "simple shiny"/NEST App

[Polkas]

linked to insightsengineering/NEST-roadmap#11

When Simple Previewer, reporter buttons are ready we have to create example apps for nonNEST and NEST scenario.

DEMO for End Users and Business partners.

This have to be done before UAT.

[nikolas-burkoff]

Please also create an issue in coredev tasks to add the created sample app to teal.gallery (don't add it yet as once we add it we will need to release teal.reporter which we may not want to do this increment)

[nikolas-burkoff]

So I would separate this into two different tasks, one to get the reporter working in teal apps (i.e. via teal::init) and one to get it working with specific tmg/tmc modules.

My overriding principle for getting the reporter into teal::init is that the app developer should not need to know anything about the reporter therefore - for now I propose:

• Reporter class gets created somewhere inside teal::init
• teal modules can (but do not have to) have a reporter argument:

tm_file_viewer_srv <- function(id,...)
tm_variable_browser_srv <- function(id, datasets, ...)

tm_outlier_srv <- function(id, datasets, reporter, ...){
    reporter$do_stuff()
}

tm_outlier_ui <- function(id, ...){
  standard_layout(  
     above_encoding_panel = add_reporter_ui(ns("report_ui")),  # e.g.
    ...
}

• when teal::init (or its appropriate children) actually creates the modules, it can check if any of them have a reporter argument (a bit annoying with nested modules true) and if so it adds an additional (teal) module onto the end which shows the report previewer

Note also worth keeping insightsengineering/teal#624 in mind as a future requirement - therefore inside modules with reporter we may want to make it so that if you are running the module outside of teal::init then you do not have to give a reporter object if you don't want to - or some other clever idea

[kpagacz]

Where to put the previewer module is a bit of a problem - teal demands a particular set of arguments to a module that a previewer almost certainly doesn't need in its entirety. Maybe it's time to make teal modules more liberal?

[nikolas-burkoff]

@kpagacz we have this insightsengineering/teal#535 which should make it easier to create teal modules

[nikolas-burkoff]

Note also worth keeping insightsengineering/teal#624 in mind as a future requirement - therefore inside modules with reporter we may want to make it so that if you are running the module outside of teal::init then you do not have to give a reporter object if you don't want to - or some other clever idea

[Polkas]

The Nik answer not raise the important aspect of how to turn off/on the reporter functionality, for the whole app and each module.
When we turn off the reporter for the app it should be hidden everywhere even in the each module UI.
Should our modules have an additional argument like reporter = TRUE, so we could hide the functionality for a specific module.
So we should control existence of the reporter from one place not a many which will be hard to maintain and understand.
In the current proposition the reporter always live inside the teal app which I do not think is the best idea nevertheless could be needed.

[gogonzo]

Current conclusion is:

• If any of the modules passed to teal has a reporter argument then create a Reporter object somewhere in teal::init (probably srv_teal)
• add reporter-previewer to the list of teal_modules (please decide whether at the beginning or at the end)
• Pass the reporter to the ui_nested_tabs.teal_module and srv_nested_tabs.teal_module if the module has a reporter argument in the formals.
• Write tests
• Vignette in other issue Vignette - teal with reporter teal#632

[nikolas-burkoff]

Note @pawelru @arkadiuszbeer once this is done then teal.reporter will be a dependency of teal so will need to be released and open sourced when teal is

[pawelru]

Note @pawelru @arkadiuszbeer once this is done then teal.reporter will be a dependency of teal so will need to be released and open sourced when teal is

Are we sure we want to add it right before planned release? Or it's intended to stay in the feature branch?

[Polkas]

I am very happy about @nikolas-burkoff implementaion insightsengineering/teal#635 (comment)

Looks like we are home. I think we should be ready, still depending how many capacity will be allocated on the teal.reporter.