From c0eb9b23a4993648e9e70931acf534d121f61bde Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 25 Oct 2023 14:28:50 +0000 Subject: [PATCH] Update pkgdown documentation 7c10cfaa26744e619a93947646674cfb4a7725ad --- main/404.html | 12 +- main/CODE_OF_CONDUCT.html | 12 +- main/CONTRIBUTING.html | 12 +- main/LICENSE-text.html | 12 +- main/SECURITY.html | 12 +- .../adding-support-for-reporting.html | 12 +- main/articles/blueprint/actors.html | 12 +- main/articles/blueprint/dataflow.html | 12 +- main/articles/blueprint/ddl.html | 12 +- main/articles/blueprint/filter_panel.html | 12 +- main/articles/blueprint/index.html | 12 +- main/articles/blueprint/intro.html | 12 +- .../blueprint/module_encapsulation.html | 12 +- main/articles/blueprint/products_map.html | 12 +- main/articles/blueprint/qenv.html | 12 +- main/articles/creating-custom-modules.html | 12 +- main/articles/filter-panel.html | 12 +- .../articles/including-adam-data-in-teal.html | 12 +- .../including-general-data-in-teal.html | 12 +- main/articles/including-mae-data-in-teal.html | 12 +- main/articles/index.html | 12 +- main/articles/preprocessing-data.html | 12 +- main/articles/teal-bs-themes.html | 12 +- main/articles/teal-options.html | 12 +- main/articles/teal.html | 12 +- main/authors.html | 12 +- main/index.html | 12 +- main/news/index.html | 17 +- main/pkgdown.yml | 2 +- main/pull_request_template.html | 12 +- main/reference/TealReportCard.html | 12 +- main/reference/TealSlicesBlock.html | 12 +- main/reference/append_module.html | 18 +- main/reference/calculate_hashes.html | 12 +- main/reference/deep_copy_filter.html | 12 +- main/reference/dot-datasets_to_data.html | 12 +- main/reference/example_cdisc_data.html | 12 +- main/reference/example_datasets.html | 12 +- main/reference/example_module.html | 12 +- main/reference/example_modules.html | 12 +- main/reference/filter_calls_module.html | 12 +- main/reference/filter_manager_module_srv.html | 12 +- main/reference/get_client_timezone.html | 12 +- main/reference/get_code_tdata.html | 12 +- main/reference/get_datasets_code.html | 12 +- main/reference/get_join_keys.html | 12 +- main/reference/get_metadata.html | 12 +- main/reference/get_rcode_libraries.html | 12 +- main/reference/get_teal_bs_theme.html | 12 +- main/reference/include_css_files.html | 12 +- main/reference/include_js_files.html | 12 +- main/reference/include_teal_css_js.html | 12 +- main/reference/index.html | 28 ++- main/reference/init.html | 12 +- main/reference/is_arg_used.html | 12 +- main/reference/landing_popup_module.html | 201 ++++++++++++++++++ main/reference/matrix_to_mapping.html | 12 +- main/reference/module.html | 12 +- main/reference/module_filter_manager.html | 12 +- .../module_filter_manager_modal.html | 12 +- main/reference/module_management.html | 142 +++++++++++++ main/reference/module_nested_tabs.html | 12 +- main/reference/module_tabs_with_filters.html | 12 +- main/reference/module_teal.html | 12 +- main/reference/modules.html | 12 +- main/reference/modules_depth.html | 12 +- main/reference/reexports.html | 12 +- main/reference/report_card_template.html | 12 +- main/reference/reporter_previewer_module.html | 21 +- main/reference/run_js_files.html | 12 +- main/reference/show_rcode_modal.html | 12 +- main/reference/slices_restore.html | 12 +- main/reference/slices_store.html | 12 +- main/reference/snapshot_manager_module.html | 12 +- main/reference/srv_teal_with_splash.html | 12 +- main/reference/tdata.html | 12 +- main/reference/tdata2env.html | 12 +- main/reference/teal-package.html | 12 +- main/reference/teal_slices.html | 12 +- main/reference/ui_teal_with_splash.html | 12 +- main/reference/unfold_mapping.html | 12 +- main/reference/validate_has_data.html | 12 +- main/reference/validate_has_elements.html | 12 +- main/reference/validate_has_variable.html | 12 +- main/reference/validate_in.html | 12 +- main/reference/validate_inputs.html | 12 +- main/reference/validate_n_levels.html | 12 +- main/reference/validate_no_intersection.html | 12 +- main/reference/validate_one_row_per_id.html | 12 +- main/search.json | 2 +- main/sitemap.xml | 6 + 91 files changed, 464 insertions(+), 957 deletions(-) create mode 100644 main/reference/landing_popup_module.html create mode 100644 main/reference/module_management.html diff --git a/main/404.html b/main/404.html index 920af6a50a..b690be052c 100644 --- a/main/404.html +++ b/main/404.html @@ -25,7 +25,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse
+ + + + + +
+
+
+

Landing Popup Module

+ Source: R/landing_popup_module.R +
landing_popup_module.Rd
+
+ +
+

Creates a landing welcome popup for teal applications.

+

This module is used to display a popup dialog when the application starts. +The dialog blocks the access to the application and must be closed with a button before the application is viewed.

+
+ +
+

Usage

+ 
landing_popup_module(
+  label = "Landing Popup",
+  title = NULL,
+  content = NULL,
+  buttons = modalButton("Accept")
+)
+
+ +
+

Arguments

+
label
+

character(1) the label of the module.

+ + +
title
+

character(1) the text to be displayed as a title of the popup.

+ + +
content
+

The content of the popup. Passed to ... of shiny::modalDialog. Can be a character +or a list of shiny.tags. See examples.

+ + +
buttons
+

shiny.tag or a list of tags (tagList). Typically a modalButton or actionButton. See examples.

+ +
+
+

Value

+ + +

A teal_module (extended with teal_landing_module class) to be used in teal applications.

+
+ +
+

Examples

+ 
app1 <- teal::init(
+  data = teal.data::dataset("iris", iris),
+  modules = teal::modules(
+    teal::landing_popup_module(
+      content = "A place for the welcome message or a disclaimer statement.",
+      buttons = modalButton("Proceed")
+    ),
+    example_module()
+  )
+)
+#> [INFO] 2023-10-25 14:27:28.9447 pid:889 token:[] teal Initializing landing_popup_module
+#> module "Landing Popup" server function takes no data so "datanames" will be ignored
+if (interactive()) {
+  shinyApp(app1$ui, app1$server)
+}
+
+app2 <- teal::init(
+  data = teal.data::dataset("iris", iris),
+  modules = teal::modules(
+    teal::landing_popup_module(
+      title = "Welcome",
+      content = tags$b(
+        "A place for the welcome message or a disclaimer statement.",
+        style = "color: red;"
+      ),
+      buttons = tagList(
+        modalButton("Proceed"),
+        actionButton("read", "Read more",
+          onclick = "window.open('http://google.com', '_blank')"
+        ),
+        actionButton("close", "Reject", onclick = "window.close()")
+      )
+    ),
+    example_module()
+  )
+)
+#> [INFO] 2023-10-25 14:27:29.0210 pid:889 token:[] teal Initializing landing_popup_module
+#> module "Landing Popup" server function takes no data so "datanames" will be ignored
+
+if (interactive()) {
+  shinyApp(app2$ui, app2$server)
+}
+
+
+
+
+ + +
+ + + + + + + diff --git a/main/reference/matrix_to_mapping.html b/main/reference/matrix_to_mapping.html index 24bd5e40d0..c66290afae 100644 --- a/main/reference/matrix_to_mapping.html +++ b/main/reference/matrix_to_mapping.html @@ -16,7 +16,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse
+ + + + + +
+
+
+

Extract/Remove module(s) of specific class

+ Source: R/modules.R +
module_management.Rd
+
+ +
+

Given a teal_module or a teal_modules, return the elements of the structure according to class.

+
+ +
+

Usage

+ 
extract_module(modules, class)
+
+drop_module(modules, class)
+
+ +
+

Arguments

+
modules
+

teal_modules

+ + +
class
+

The class name of teal_module to be extracted or dropped.

+ +
+
+

Value

+ + +

For extract_module, a teal_module of class class or teal_modules containing modules of class class. +For drop_module, the opposite, which is all teal_modules of class other than class.

+ + +

teal_modules

+ + +
+ +
+ + +
+ + + + + + + diff --git a/main/reference/module_nested_tabs.html b/main/reference/module_nested_tabs.html index fa7e27d236..1e0a9c3433 100644 --- a/main/reference/module_nested_tabs.html +++ b/main/reference/module_nested_tabs.html @@ -10,7 +10,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse