{teal} module returns a teal_report object that extends from teal_data
#1541
+583
−133
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,91 @@ | ||||||
| #' Executes modifications to the result of a module | ||||||
| #' | ||||||
| #' Primarily used to modify the output object of module to change the containing | ||||||
| #' report. | ||||||
| #' @param x (`teal_data`) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| #' @param ui (`function(id, elem, ...)`) function to receive output (`shiny.tag`) from `x$ui` | ||||||
| #' @param server (`function(input, output, session, data, ...)`) function to receive output data from `x$server` | ||||||
| #' @param ... additional argument passed to `ui` and `server` by matching their formals names. | ||||||
| #' @return A `teal_report` object with the result of the server function. | ||||||
| #' @export | ||||||
| after <- function(x, | ||||||
| ui = function(id, elem) elem, | ||||||
| server = function(input, output, session, data) data, | ||||||
| ...) { | ||||||
|
Comment on lines
+5
to
+14
There was a problem hiding this comment. Since I think should be updated to and to ? |
||||||
| # todo: make a method for teal_app and remove teal_extend_server? | ||||||
| checkmate::assert_multi_class(x, "teal_module") | ||||||
| if (!is.function(ui) || !all(names(formals(ui)) %in% c("id", "elem"))) { | ||||||
| stop("ui should be a function of id and elem") | ||||||
| } | ||||||
| if (!is.function(server) || !all(names(formals(server)) %in% c("input", "output", "session", "data"))) { | ||||||
| stop("server should be a function of `input` and `output`, `session`, `data`") | ||||||
| } | ||||||
|
Comment on lines
+20
to
+22
There was a problem hiding this comment. Are those checks even working if we pass server function without <teal_module> |> after(
server = function(data) {
teal.reporter::teal_card(data) <- c(
teal.reporter::teal_card(data),
"# added content",
"This content has been added through `after`"
)
data
}
) |
||||||
|
|
||||||
| additional_args <- list(...) | ||||||
| new_x <- x # because overwriting x$ui/server will cause infinite recursion | ||||||
| new_x$ui <- .after_ui(x$ui, ui, additional_args) | ||||||
| new_x$server <- .after_server(x$server, server, additional_args) | ||||||
| new_x | ||||||
| } | ||||||
|
|
||||||
| .after_ui <- function(x, y, additional_args) { | ||||||
| # add `_`-prefix to make sure objects are not masked in the wrapper functions | ||||||
| `_x` <- x # nolint: object_name. | ||||||
| `_y` <- y # nolint: object_name. | ||||||
| new_x <- function(id, ...) { | ||||||
| original_args <- as.list(environment()) | ||||||
| if ("..." %in% names(formals(`_x`))) { | ||||||
| original_args <- c(original_args, list(...)) | ||||||
| } | ||||||
| ns <- NS(id) | ||||||
| original_args$id <- ns("wrapped") | ||||||
| original_out <- do.call(`_x`, original_args, quote = TRUE) | ||||||
|
|
||||||
| wrapper_args <- c( | ||||||
| additional_args, | ||||||
| list(id = ns("wrapper"), elem = original_out) | ||||||
| ) | ||||||
| do.call(`_y`, args = wrapper_args[names(formals(`_y`))]) | ||||||
| } | ||||||
| formals(new_x) <- formals(x) | ||||||
| new_x | ||||||
| } | ||||||
|
|
||||||
| .after_server <- function(x, y, additional_args) { | ||||||
| # add `_`-prefix to make sure objects are not masked in the wrapper functions | ||||||
| `_x` <- x # nolint: object_name. | ||||||
| `_y` <- y # nolint: object_name. | ||||||
| new_x <- function(id, ...) { | ||||||
| original_args <- as.list(environment()) | ||||||
| original_args$id <- "wrapped" | ||||||
| if ("..." %in% names(formals(`_x`))) { | ||||||
| original_args <- c(original_args, list(...)) | ||||||
| } | ||||||
| moduleServer(id, function(input, output, session) { | ||||||
| original_out <- if (all(c("input", "output", "session") %in% names(formals(`_x`)))) { | ||||||
| original_args$module <- `_x` | ||||||
| do.call(shiny::callModule, args = original_args) | ||||||
| } else { | ||||||
| do.call(`_x`, original_args) | ||||||
| } | ||||||
| original_out_r <- reactive( | ||||||
| if (is.reactive(original_out)) { | ||||||
| original_out() | ||||||
| } else { | ||||||
| original_out | ||||||
| } | ||||||
| ) | ||||||
| wrapper_args <- utils::modifyList( | ||||||
| additional_args, | ||||||
| list(id = "wrapper", input = input, output = output, session = session) | ||||||
| ) | ||||||
| reactive({ | ||||||
| req(original_out_r()) | ||||||
| wrapper_args$data <- original_out() | ||||||
| do.call(`_y`, wrapper_args[names(formals(`_y`))], quote = TRUE) | ||||||
| }) | ||||||
| }) | ||||||
| } | ||||||
| formals(new_x) <- formals(x) | ||||||
| new_x | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that this is a really bad name that can mean anything. It feels very much async related. Please reassess the name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to let you know @pawelru - this is a function that edits/manipulates
teal_data(now extended toteal_reportclass) after it was returned by module'sserver. It is applied on a module level.So basically it is:
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about
modify_teal_moduleoredit_teal_module?Then, we'll have
.modify/edit_teal_module_uiand.modify/edit_teal_module_srvEDIT: I saw the comment that this was previously called
modify_reactive_output.