Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config/Needs/verdepcheck cleanup; init() cleanup #1313

Merged
merged 9 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,12 @@ RdMacros:
Config/Needs/verdepcheck: rstudio/shiny, insightsengineering/teal.data,
insightsengineering/teal.slice, mllg/checkmate,
HenrikBengtsson/future, jeroen/jsonlite, r-lib/lifecycle,
daroczig/logger, tidyverse/magrittr, rstudio/promises, rstudio/renv,
r-lib/rlang, daattali/shinyjs, insightsengineering/teal.logger,
daroczig/logger, rstudio/promises, rstudio/renv,
r-lib/rlang, daattali/shinyjs, insightsengineering/teal.code, insightsengineering/teal.logger,
insightsengineering/teal.reporter, insightsengineering/teal.widgets,
rstudio/bslib, yihui/knitr, bioc::MultiAssayExperiment, r-lib/R6,
rstudio/rmarkdown, rstudio/shinyvalidate,
insightsengineering/teal.code, r-lib/testthat, r-lib/withr,
yaml=vubiostat/r-yaml
rstudio/rmarkdown, tidyverse/rvest, rstudio/shinytest2, rstudio/shinyvalidate,
r-lib/testthat, r-lib/withr, yaml=vubiostat/r-yaml
pawelru marked this conversation as resolved.
Show resolved Hide resolved
Config/Needs/website: insightsengineering/nesttemplate
Encoding: UTF-8
Language: en-US
Expand Down
55 changes: 27 additions & 28 deletions R/init.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,29 @@
#' End-users: This is the most important function for you to start a
#' `teal` app that is composed of `teal` modules.
#'
#' @details
#' When initializing the `teal` app, if `datanames` are not set for the `teal_data` object,
#' defaults from the `teal_data` environment will be used.
pawelru marked this conversation as resolved.
Show resolved Hide resolved
#'
#' @param data (`teal_data` or `teal_data_module`)
#' For constructing the data object, refer to [teal_data()] and [teal_data_module()].
#' For constructing the data object, refer to [teal_data()] and [teal_data_module()].
#' If `datanames` are not set for the `teal_data` object, defaults from the `teal_data` environment will be used.
#' @param modules (`list` or `teal_modules` or `teal_module`)
#' nested list of `teal_modules` or `teal_module` objects or a single
#' Nested list of `teal_modules` or `teal_module` objects or a single
#' `teal_modules` or `teal_module` object. These are the specific output modules which
#' will be displayed in the `teal` application. See [modules()] and [module()] for
#' more details.
#' @param filter (`teal_slices`)
#' Specifies the initial filter using [teal_slices()].
#' @param title (`shiny.tag` or `character(1)`)
#' The browser window title. Defaults to a title "teal app" with the icon of NEST.
#' @param filter (`teal_slices`) Optionally,
#' specifies the initial filter using [teal_slices()].
#' @param title (`shiny.tag` or `character(1)`) Optionally,
#' the browser window title. Defaults to a title "teal app" with the icon of NEST.
#' Can be created using the `build_app_title()` or
#' by passing a valid `shiny.tag` which is a head tag with title and link tag.
#' @param header (`shiny.tag` or `character(1)`)
#' The header of the app.
#' @param footer (`shiny.tag` or `character(1)`)
#' The footer of the app.
#' @param id (`character`) optional
#' string specifying the `shiny` module id in cases it is used as a `shiny` module
#' @param header (`shiny.tag` or `character(1)`) Optionally,
#' the header of the app.
#' @param footer (`shiny.tag` or `character(1)`) Optionally,
#' the footer of the app.
#' @param id (`character`) Optionally,
#' a string specifying the `shiny` module id in cases it is used as a `shiny` module
#' rather than a standalone `shiny` app. This is a legacy feature.
#' @param landing_popup (`teal_module`) optional
#' A `landing_popup_module` to show up as soon as the teal app is initialized.
#' @param landing_popup (`teal_module`) Optionally,
pawelru marked this conversation as resolved.
Show resolved Hide resolved
#' a `landing_popup_module` to show up as soon as the teal app is initialized.
pawelru marked this conversation as resolved.
Show resolved Hide resolved
#'
#' @return Named list containing server and UI functions.
#'
Expand All @@ -45,13 +42,12 @@
#'
#' @examples
#' app <- init(
#' data = teal_data(
#' new_iris = transform(iris, id = seq_len(nrow(iris))),
#' new_mtcars = transform(mtcars, id = seq_len(nrow(mtcars))),
#' code = "
#' data = within(
#' teal_data(),
#' {
#' new_iris <- transform(iris, id = seq_len(nrow(iris)))
#' new_mtcars <- transform(mtcars, id = seq_len(nrow(mtcars)))
#' "
#' }
#' ),
#' modules = modules(
#' module(
Expand Down Expand Up @@ -89,7 +85,7 @@
#' ),
#' title = "App title",
#' header = tags$h1("Sample App"),
#' footer = tags$p("Copyright 2017 - 2023")
#' footer = tags$p("Sample footer")
#' )
#' if (interactive()) {
#' shinyApp(app$ui, app$server)
Expand Down Expand Up @@ -166,9 +162,8 @@ init <- function(data,
if (length(landing) == 1L) {
landing_popup <- landing[[1L]]
modules <- drop_module(modules, "teal_module_landing")
# TODO: verify the version before release.
lifecycle::deprecate_soft(
when = "0.16",
when = "0.15.3",
what = "landing_popup_module()",
details = paste(
"Pass `landing_popup_module` to the `landing_popup` argument of the `init` ",
Expand Down Expand Up @@ -249,8 +244,12 @@ init <- function(data,
res <- list(
ui = function(request) {
ui_teal(
id = ns("teal"), data = if (inherits(data, "teal_data_module")) data,
modules = modules, title = title, header = header, footer = footer
id = ns("teal"),
data = if (inherits(data, "teal_data_module")) data,
modules = modules,
title = title,
header = header,
footer = footer
)
pawelru marked this conversation as resolved.
Show resolved Hide resolved
},
server = function(input, output, session) {
Expand Down
44 changes: 20 additions & 24 deletions man/init.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/module_bookmark_manager.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/module_filter_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/module_init_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions man/module_teal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/module_teal_module.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions man/module_teal_with_splash.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/modules_depth.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading