1187 decorate output@main #1357

gogonzo · 2024-09-30T08:21:56Z

…main

…er creation - some documentation - some todo's

gogonzo · 2024-10-09T12:10:59Z

R/modules.R

@@ -315,7 +313,12 @@ modules <- function(..., label = "root") {

 #' @rdname teal_modules
 #' @export
-format.teal_module <- function(x, indent = 0, ...) {
+format.teal_module <- function(x, ...) {


removed indent from the module() documentation. It is completely unnecessary to display indent in the public docs.

gogonzo · 2024-10-09T13:01:04Z

R/module_nested_tabs.R

@@ -262,7 +256,7 @@ srv_teal_module.teal_module <- function(id,
    )

    is_transformer_failed <- reactiveValues()
-    transformed_teal_data <- srv_transform_data(
+    transformed_teal_data <- srv_teal_transform_module(


I think this name is more accurate and more straighforward.
teal_transform_module is consumed by ui_teal_transform_module and srv_teal_transform_module

gogonzo · 2024-10-09T13:04:28Z

R/modules.R

@@ -48,14 +48,12 @@ setOldClass("teal_modules")
 #' @param server_args (named `list`) with additional arguments passed on to the server function.
 #' @param ui_args (named `list`) with additional arguments passed on to the UI function.
 #' @param x (`teal_module` or `teal_modules`) Object to format/print.
-#' @param indent (`integer(1)`) Indention level; each nested element is indented one level more.
-#' @param transformers (`list` of `teal_data_module`) that will be applied to transform the data.
+#' @param transformers (`list` of `teal_transform_module`) that will be applied to transform module's data input.


We need to rather link transformers with decorators and don't refer teal_transform_module to teal_data_module.

…_data_module

kpagacz · 2024-10-14T13:34:12Z

R/teal_transform_module.R

+#' Some [`teal_modules`] enables app developer to inject custom shiny module to modify displayed output.
+#' To handle these `decorators` inside of your module use [ui_teal_transform_module()] and [srv_teal_transform_module].
+#' (todo: write more about how to handle decorators: they need to go through ui_args/srv_args and then be consumed by
+#' ui/srv_teal_transform_module()... . Alternatively, decorators could be a [module()]'s argument)


A reference to the vignette would be nice here :)

kpagacz · 2024-10-14T13:34:35Z

R/teal_transform_module.R

+#' @description
+#' `r lifecycle::badge("experimental")`
+#'
+#' `teal_transform_module` creates a shiny-module to transform data in a `teal` application.


That's not entirely true, now it also supports output decoration!

kpagacz · 2024-10-14T13:45:24Z

R/teal_transform_module.R

+#' # Decorating `teal` module's output
+#'
+#' `teal_transform_module`'s purpose is to modify any object created in [`teal.data::teal_data`]. It means that an
+#' app-developer can use `teal_transform_module` to modify data but also outputted tables, listings and graphs.


Suggested change

#' app-developer can use `teal_transform_module` to modify data but also outputted tables, listings and graphs.

#' app-developer can use `teal_transform_module` to modify not only data but also tables, listings and graphs.

kpagacz · 2024-10-14T13:48:00Z

R/teal_transform_module.R

+#' `teal_transform_module`'s purpose is to modify any object created in [`teal.data::teal_data`]. It means that an
+#' app-developer can use `teal_transform_module` to modify data but also outputted tables, listings and graphs.
+#' Some [`teal_modules`] enables app developer to inject custom shiny module to modify displayed output.
+#' To handle these `decorators` inside of your module use [ui_teal_transform_module()] and [srv_teal_transform_module].


Suggested change

#' To handle these `decorators` inside of your module use [ui_teal_transform_module()] and [srv_teal_transform_module].

#' To handle these `decorators` inside of your module, use [ui_teal_transform_module()] and [srv_teal_transform_module].

kpagacz · 2024-10-14T14:17:44Z

R/teal_transform_module.R

+#' ```
+#'
+#' Above can be simplified to presented below, where `level` will be automatically substituted with
+#' respective input matched by its name.


Suggested change

#' respective input matched by its name.

#' the respective input matched by its name.

kpagacz · 2024-10-14T14:18:05Z

R/teal_transform_module.R

+#' # `server` as a language
+#'
+#' Server function in `teal_transform_module` must return `reactive` containing [teal.data::teal_data] object.
+#' Consider sinmple transformer which doesn't require any advanced reactivity, example `server` might have a


Suggested change

#' Consider sinmple transformer which doesn't require any advanced reactivity, example `server` might have a

#' Consider a simple transformer, which doesn't require any advanced reactivity, example `server` might have a

kpagacz · 2024-10-14T14:20:54Z

R/teal_transform_module.R

+#' `shiny` module server function; that takes `id` and `data` argument,
+#' where the `id` is the module id and `data` is the reactive `teal_data` input.
+#' The server function must return reactive expression containing `teal_data` object.
+#' To simplify use [make_teal_transform_server()].


Suggested change

#' To simplify use [make_teal_transform_server()].

#' To simplify, use [make_teal_transform_server()].

kpagacz · 2024-10-14T14:21:29Z

R/teal_transform_module.R

+#'
+#' A factory function to simplify creation of a [`teal_transform_module`]'s server. Specified `expr`
+#' is wrapped in a shiny module function and output can be passed to the `server` argument in
+#' [teal_transform_module()] call. Such server function can be linked with ui and values from the


Suggested change

#' [teal_transform_module()] call. Such server function can be linked with ui and values from the

#' [teal_transform_module()] call. Such a server function can be linked with ui and values from the

kpagacz · 2024-10-14T14:24:37Z

R/teal_transform_module.R

+#' app-developer can use `teal_transform_module` to modify data but also outputted tables, listings and graphs.
+#' Some [`teal_modules`] enables app developer to inject custom shiny module to modify displayed output.
+#' To handle these `decorators` inside of your module use [ui_teal_transform_module()] and [srv_teal_transform_module].
+#' (todo: write more about how to handle decorators: they need to go through ui_args/srv_args and then be consumed by


You can write or you can just link to the vignette which contains an example of the proper handling. It's actually better to link than to write. Just add one sentence about - as a module developer, you can see to learn how to properly handle the decorators inside your module.

kpagacz · 2024-10-14T14:27:56Z

R/teal_transform_module.R

+#'
+#' `teal_transform_module` creates a shiny-module to transform data in a `teal` application.
+#'
+#' # Transforming `teal` module's input


Might be good to mention the advantages of using the transform modules for these tasks. They come with error handling out of the box, etc. It's their biggest selling point and it's what stands them apart from just embedding app dev-supplied shiny modules into a module.

dependabot-preview bot added 4 commits September 26, 2024 15:07

WIP

b74d1f6

init

6835c18

WIP

9fc5923

Merge branch 'main' into 1187_decorate_output@main

9bc0405

gogonzo marked this pull request as draft September 30, 2024 08:22

github-actions bot and others added 7 commits September 30, 2024 08:23

[skip style] [skip vbump] Restyle files

9f4e6dd

multiple outputs

fa117d1

Merge remote-tracking branch 'origin/main' into 1187_decorate_output@…

ed29e78

…main

reshuffle validation of teal_transform_module

c214c25

don't display UI if not specified

5f7ab79

Dispatch in teal_transform_module constructor

898015f

- make_teal_transform_server to simplify teal_transform_module's serv…

b5cb59f

…er creation - some documentation - some todo's

gogonzo commented Oct 9, 2024

View reviewed changes

move teal_transform_module to a new file instead of keeping with teal…

30bb248

…_data_module

kpagacz reviewed Oct 14, 2024

View reviewed changes

gogonzo mentioned this pull request Oct 16, 2024

[Feature Request]: Finalize decorate POC #1383

Open

gogonzo added 2 commits October 30, 2024 12:43

Merge branch 'main' into 1187_decorate_output@main

dfce86b

post merge fixes

1c75925

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1187 decorate output@main #1357

1187 decorate output@main #1357

gogonzo commented Sep 30, 2024

gogonzo Oct 9, 2024

gogonzo Oct 9, 2024

gogonzo Oct 9, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024 •

edited

Loading

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

kpagacz Oct 14, 2024

	#' app-developer can use `teal_transform_module` to modify data but also outputted tables, listings and graphs.
	#' app-developer can use `teal_transform_module` to modify not only data but also tables, listings and graphs.

	#' To handle these `decorators` inside of your module use [ui_teal_transform_module()] and [srv_teal_transform_module].
	#' To handle these `decorators` inside of your module, use [ui_teal_transform_module()] and [srv_teal_transform_module].

	#' respective input matched by its name.
	#' the respective input matched by its name.

	#' Consider sinmple transformer which doesn't require any advanced reactivity, example `server` might have a
	#' Consider a simple transformer, which doesn't require any advanced reactivity, example `server` might have a

	#' To simplify use [make_teal_transform_server()].
	#' To simplify, use [make_teal_transform_server()].

	#' [teal_transform_module()] call. Such server function can be linked with ui and values from the
	#' [teal_transform_module()] call. Such a server function can be linked with ui and values from the

1187 decorate output@main #1357

Are you sure you want to change the base?

1187 decorate output@main #1357

Conversation

gogonzo commented Sep 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kpagacz Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kpagacz Oct 14, 2024 •

edited

Loading