Mohammed Ali
-2025-04-14
+2025-09-02
Source:vignettes/announcement_addin.Rmd
announcement_addin.RmdDownloaded File
Theme Configuration
Builder
+downloadableReactTable
+Module
diff --git a/docs/articles/applicationReset-module.html b/docs/articles/applicationReset-module.html
index 479d7bc4..e66bb8a0 100644
--- a/docs/articles/applicationReset-module.html
+++ b/docs/articles/applicationReset-module.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Using the appReset Shiny Module
Mohammed
Ali
- 2025-04-14
+ 2025-09-02
Source: vignettes/applicationReset-module.Rmd
applicationReset-module.Rmd
@@ -250,6 +253,8 @@ Sample ApplicationTheme Configuration
Builder
+
downloadableReactTable
+Module
diff --git a/docs/articles/downloadFile-module.html b/docs/articles/downloadFile-module.html
index 758b265e..00640e6a 100644
--- a/docs/articles/downloadFile-module.html
+++ b/docs/articles/downloadFile-module.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Using the downloadFile Shiny Module
Dr. Connie
Brett
- 2025-04-14
+ 2025-09-02
Source: vignettes/downloadFile-module.Rmd
downloadFile-module.Rmd
@@ -225,6 +228,11 @@ downloadFileAdditional ResourcesTheme Configuration
Builder
+
downloadableReactTable
+Module
diff --git a/docs/articles/downloadablePlot-module.html b/docs/articles/downloadablePlot-module.html
index c5528aba..986b4432 100644
--- a/docs/articles/downloadablePlot-module.html
+++ b/docs/articles/downloadablePlot-module.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Using the downloadablePlot Shiny Module
Dr. Connie
Brett
- 2025-04-14
+ 2025-09-02
Source: vignettes/downloadablePlot-module.Rmd
downloadablePlot-module.Rmd
@@ -310,6 +313,8 @@ Additional ResourcesTheme Configuration
Builder
+
downloadableReactTable
+Module
diff --git a/docs/articles/downloadableReactTable-module.html b/docs/articles/downloadableReactTable-module.html
new file mode 100644
index 00000000..98f07036
--- /dev/null
+++ b/docs/articles/downloadableReactTable-module.html
@@ -0,0 +1,389 @@
+
+
+
+
+
+
+
+Using downloadableReactTable Shiny Module • periscope2
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Using downloadableReactTable Shiny Module
+ Mohammed
+Ali
+
+ 2025-09-02
+
+ Source: vignettes/downloadableReactTable-module.Rmd
+ downloadableReactTable-module.Rmd
+
+
+
+
+
+
+Overview
+
+
+Purpose
+
+The document explains how to use
+downloadableReactTable shiny module in periscope2
+applications.
+
+
+Features
+
+
+- Ability to display and download datasets.
+- Table rows selection can be multiple, single or none (the default)
+
+- When selection mode is enabled an additional column will be added to
+the table
+- The selection controls will be radio buttons for single row
+selection and checkboxes for “multiple” rows selection mode
+
+
+- Returns a reactive expression containing named list with two
+elements: selected_rows and
+table_state
+
+- Supports full-table searching including regular expressions
+- Columns are sort-able in both directions
+- Configurable table “window” (viewing area) height with infinite
+vertical scrolling (no paging by default)
+- Supports rownames
+- Requires minimal code (see the Usage section for details)
+- Uses downloadFile Shiny Module functionality to
+ensure consistent download functionality for table data.
+-
+downloadFile button will be hidden if
+
downloadableReactTable parameter
+download_data_fxns or downloadableReactTableUI
+parameter downloadtypes is empty
+
+
+
+
+Usage
+
+
+Shiny Module Overview
+
+Shiny modules consist of a pair of functions that modularize, or
+package, a small piece of reusable functionality. The UI function is
+called directly by the user to place the UI in the correct location (as
+with other shiny UI objects). The module server function that is called
+only once to set it up using the module name as a function inside the
+server function (i.e. user-local session scope. The first function
+argument is a string that represents the module id (the same id used in
+module UI function). Additional arguments can be supplied by the user
+based on the specific shiny module that is called. There can be
+additional helper functions that are a part of a shiny module.
+The downloadableReactTable Shiny Module is a part of
+the periscope2 package and consists of the following
+functions:
+
+-
+downloadableReactTableUI - the UI function to place
+the table in the application
+-
+downloadableReactTable - the server function to be
+called inside server_local.R.
+
+
+
+downloadableReactTableUI
+
+The downloadableReactTableUI function is called from
+the ui.R (or equivalent) file in the location where the table should be
+placed. This is similar to other UI element placement in shiny.
+The downloadableReactTableUI looks like:
+
+
+
+The downloadableReactTableUI function takes the unique object ID for
+the UI object.
+The next two arguments (downloadtypes and hovertext) are passed to
+the downloadFileButton and set the file types the button will allow the
+user to request and the downloadFileButton’s tooltip text.
+
+# Inside ui_body.R or ui_sidebar.R
+
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")
+
+
+downloadableReactTable
+
+The downloadableReactTable function is called
+directly. The call consists of the following:
+
+- the unique object ID that was provided to downloadableTableUI when
+creating the UI object
+- the logging logger to be used
+-
+file_name_root is an optional character, function
+or reactive expression providing downloadable file name
+- the root (prefix) of the downloaded file name to be used in the
+browser as a character string or a reactive expression that returns a
+character string
+-
+download_data_fxns named list of functions or
+reactive expressions that provide the data to the downloadFileButton
+(see below).
+
+- It is important that the types of files to be downloaded are matched
+to the correct data function in the list.
+
+- The function/reactive expression names are unquoted - they will be
+called at the time the user initiates a download (see requirements
+below).
+- The download functions or reactive expressions can all be the same
+or different from each other and/or the one provided to
+table_data. This allows finer control over what the
+user can view vs. download if desired. For example you can allow a user
+to view a smaller subset of data but download an expanded dataset, or
+perhaps download a redacted version of data, etc.
+
+
+- This module also supports most of reactable table options for
+further customization. See the example below.
+
+Data Function or Reactive Expression
+Requirements
+
+- If a function is provided it must be parameter-less (require NO
+parameters). No parameters will be provided when a function is called to
+retrieve the plot or data. Reactive expressions cannot take parameters
+by definition.
+- The function or reactive expression must return an appropriate data
+format for the file type.
+- For instance: csv/tsv/xlsx types require data that is convertible to
+a tabular type, to various download types see the downloadFile module
+help or vignette.
+- For the visible table data the return value must be able to be
+converted to tabular format
+- Since the function or reactive expression is called at the time the
+user requests the data it is recommended that reactive expressions are
+used to provide dynamic values from the application to create the
+table.
+
+Reactive Return Value
+
+- The server function returns a reactive expression containing named
+list with two elements:
+
+-
+selected_rows: data.frame of current selected
+rows.
+
+* Note that this is the data, not references, rownumbers, etc from the table -- it is the actual, visible, table row data. This allows the developer to use this more easily to update another table, chart, etc. as desired.
+
+-
+table_state: a list of the current table state. The
+list keys are (“page”, “pageSize”, “pages”, “sorted” and
+“selected”)
+
+
+- It is acceptable to ignore the return value as well if this
+functionality is not needed. Simply do not assign the result to a
+variable.
+
+Customization Options
+downloadableReactTable module can be customized using
+reactable function arguments(see ?reactable::reactable).
+These options can be sent as a named options via the server function,
+see example below.
+
+# Inside server_local.R
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ showSortable = TRUE,
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+
+# NOTE: table_state is the reactive return value, captured for later use
+
+
+Sample Application
+
+For a complete running shiny example application using the
+downloadableReactTable module you can create and run a
+periscope2 sample application using:
+
+library(periscope2)
+
+app_dir = tempdir()
+create_new_application(name = 'mysampleapp', location = app_dir, sample_app = TRUE)
+runApp(paste(app_dir, 'mysampleapp', sep = .Platform$file.sep))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/articles/downloadableTable-module.html b/docs/articles/downloadableTable-module.html
index 357ad2d5..8aa96057 100644
--- a/docs/articles/downloadableTable-module.html
+++ b/docs/articles/downloadableTable-module.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Using the downloadableTable Shiny Module
Dr. Connie
Brett
- 2025-04-14
+ 2025-09-02
Source: vignettes/downloadableTable-module.Rmd
downloadableTable-module.Rmd
@@ -369,6 +372,8 @@ Additional ResourcesTheme Configuration
Builder
+
downloadableReactTable
+Module
diff --git a/docs/articles/figures/downloadableReactTable-1.png b/docs/articles/figures/downloadableReactTable-1.png
new file mode 100644
index 00000000..3d2266dc
Binary files /dev/null and b/docs/articles/figures/downloadableReactTable-1.png differ
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 3d79b0f4..472b0975 100644
--- a/docs/articles/index.html
+++ b/docs/articles/index.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -95,6 +98,8 @@ All vignettes
Using the downloadablePlot Shiny Module
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
Using the downloadFile Shiny Module
diff --git a/docs/articles/logViewer-module.html b/docs/articles/logViewer-module.html
index 0d1e4b00..ed2098e5 100644
--- a/docs/articles/logViewer-module.html
+++ b/docs/articles/logViewer-module.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Using the logViewer Shiny Module
Mohammed
Ali
- 2025-04-14
+ 2025-09-02
Source: vignettes/logViewer-module.Rmd
logViewer-module.Rmd
@@ -140,6 +143,16 @@ Features
Many actions are automatically logged by the framework and it is
easy for developers to add additional items as they see fit.
+Filtering logs by setting log_level argument as desired in
+set_app_parameters
+
+- “DEBUG” will log logdebug, loginfo, logwarn, and logerror
+messages
+- “INFO” will log loginfo, logwarn, and logerror messages
+- “WARNING” will log logwarn and logerror messages
+- “ERROR” will log logerror messages
+
+
It is important to note that the log rolls over for each session and
is reset if using the appReset module.
@@ -217,6 +230,8 @@ Additional ResourcesTheme Configuration
Builder
+
downloadableReactTable
+Module
diff --git a/docs/articles/migrate_to_v0_2_0.html b/docs/articles/migrate_to_v0_2_0.html
index 0d3072a6..7b0a124a 100644
--- a/docs/articles/migrate_to_v0_2_0.html
+++ b/docs/articles/migrate_to_v0_2_0.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/articles/new-application.html b/docs/articles/new-application.html
index fb6fb404..e27464ab 100644
--- a/docs/articles/new-application.html
+++ b/docs/articles/new-application.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Creating a new framework-based application
Dr. Connie
Brett
- 2025-04-14
+ 2025-09-02
Source: vignettes/new-application.Rmd
new-application.Rmd
@@ -789,6 +792,8 @@ www/img
Builder
Theme Configuration
Builder
+downloadableReactTable
+Module
diff --git a/docs/articles/themeBuilder_addin.html b/docs/articles/themeBuilder_addin.html
index 439fab93..f0294835 100644
--- a/docs/articles/themeBuilder_addin.html
+++ b/docs/articles/themeBuilder_addin.html
@@ -32,7 +32,7 @@
@@ -60,6 +60,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,7 +111,7 @@ Theme Configuration Builder
Mohammed
Ali
- 2025-04-14
+ 2025-09-02
Source: vignettes/themeBuilder_addin.Rmd
themeBuilder_addin.Rmd
@@ -280,6 +283,8 @@ Downloaded Configuration File Usage
logViewer Module
applicationReset
Module
+downloadableReactTable
+Module
diff --git a/docs/authors.html b/docs/authors.html
index 7a9911b8..47b4b538 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -108,13 +111,13 @@ Citation
Ali M (2025).
periscope2: Enterprise Streamlined 'shiny' Application Framework Using 'bs4Dash'.
-R package version 0.2.4, http://periscopeapps.org:3838, https://github.com/Aggregate-Genius/periscope2.
+R package version 0.3.0, http://periscopeapps.org:3838, https://github.com/Aggregate-Genius/periscope2.
@Manual{,
title = {periscope2: Enterprise Streamlined 'shiny' Application Framework Using 'bs4Dash'},
author = {Mohammed Ali},
year = {2025},
- note = {R package version 0.2.4, http://periscopeapps.org:3838},
+ note = {R package version 0.3.0, http://periscopeapps.org:3838},
url = {https://github.com/Aggregate-Genius/periscope2},
}
diff --git a/docs/index.html b/docs/index.html
index c2113cc5..7f4d5b0a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -33,7 +33,7 @@
@@ -61,6 +61,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -115,7 +118,7 @@ OverviewPredefined but flexible templates for new Shiny applications with a default bs4Dash layout
Separation by file of functionality that exists in one of the three shiny scopes: global, server-global, and server-local
Generated applications are organized in an easy to follow and maintain folder structure based on files functionality
-Off-the-shelf and ready to be used modules (‘Table Downloader’, ‘Plot Downloader’, ‘File Downloader’ and ‘Reset Application’
+Off-the-shelf and ready to be used modules (‘Table/React Table Downloader’, ‘Plot Downloader’, ‘File Downloader’ and ‘Reset Application’
Different methods and tools to alert users and add useful information about application UI and server operations
Application logger with different levels and a UI tool to display and review recorded application logs
Application look and feel can be customized easily via ‘www/periscope_style.yaml’ or more advanced via ‘www/css/custom.css’
@@ -231,7 +234,11 @@ Periscope2 Modules
periscope2
- 0.2.4
+ 0.3.0
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -85,7 +88,21 @@ Changelog
-periscope2 0.2.4
+periscope2 0.3.0
+
+New Features
+- Added new module ?downloadableReactTable based on reactable package and downloadFile module
+
+
+Enhancements
+- Added openxlsx2 support while keeping openxlsx to support legacy apps and backwards compatibility. writexl package is used as last resort.
+- Updated ?logViewerOutput module to display log data using ?downloadableReactTable.
+- Added loglevel filtering according to level chosen- Added loglevel filtering according to level chosen
+- Added new feature to ?downloadFile module to control whether row names are to be written for tabular data.
+
+
+
+periscope2 0.2.42025-04-14
Enhancements
- Updated
set_app_parameters method documentation to displayed html tags correctly
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index ae405c81..a7c6f493 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -6,10 +6,11 @@ articles:
announcement-module: announcement-module.html
applicationReset-module: applicationReset-module.html
downloadablePlot-module: downloadablePlot-module.html
+ downloadableReactTable-module: downloadableReactTable-module.html
downloadableTable-module: downloadableTable-module.html
downloadFile-module: downloadFile-module.html
logViewer-module: logViewer-module.html
migrate_to_v0_2_0: migrate_to_v0_2_0.html
new-application: new-application.html
themeBuilder_addin: themeBuilder_addin.html
-last_built: 2025-04-14T11:09Z
+last_built: 2025-09-03T05:05Z
diff --git a/docs/reference/add_ui_body.html b/docs/reference/add_ui_body.html
index c221244a..519d77f1 100644
--- a/docs/reference/add_ui_body.html
+++ b/docs/reference/add_ui_body.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/add_ui_footer.html b/docs/reference/add_ui_footer.html
index eaf2d230..8a6e188d 100644
--- a/docs/reference/add_ui_footer.html
+++ b/docs/reference/add_ui_footer.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/add_ui_header.html b/docs/reference/add_ui_header.html
index 499e31eb..4b622156 100644
--- a/docs/reference/add_ui_header.html
+++ b/docs/reference/add_ui_header.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/add_ui_left_sidebar.html b/docs/reference/add_ui_left_sidebar.html
index d99e64fd..15acdb31 100644
--- a/docs/reference/add_ui_left_sidebar.html
+++ b/docs/reference/add_ui_left_sidebar.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/add_ui_right_sidebar.html b/docs/reference/add_ui_right_sidebar.html
index b5da2b94..6b3fa7d3 100644
--- a/docs/reference/add_ui_right_sidebar.html
+++ b/docs/reference/add_ui_right_sidebar.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/announcementConfigurationsAddin.html b/docs/reference/announcementConfigurationsAddin.html
index 693f0578..22b26d60 100644
--- a/docs/reference/announcementConfigurationsAddin.html
+++ b/docs/reference/announcementConfigurationsAddin.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/appReset.html b/docs/reference/appReset.html
index 738d23ef..51fabd09 100644
--- a/docs/reference/appReset.html
+++ b/docs/reference/appReset.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/appResetButton.html b/docs/reference/appResetButton.html
index 64e9a7c9..f865f676 100644
--- a/docs/reference/appResetButton.html
+++ b/docs/reference/appResetButton.html
@@ -20,7 +20,7 @@
@@ -46,6 +46,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/createPSAlert.html b/docs/reference/createPSAlert.html
index ad4c560a..49afe05e 100644
--- a/docs/reference/createPSAlert.html
+++ b/docs/reference/createPSAlert.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/create_application.html b/docs/reference/create_application.html
index b072fd4d..24b8e69e 100644
--- a/docs/reference/create_application.html
+++ b/docs/reference/create_application.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -218,25 +221,25 @@ Examples
# sample app named 'mytestapp' created in a temp dir
location <- tempdir()
create_application(name = 'mytestapp', location = location, sample_app = TRUE)
-#> periscope2 application mytestapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application mytestapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/mytestapp'), TRUE)
# sample app named 'mytestapp' with a right sidebar using a custom icon created in a temp dir
location <- tempdir()
create_application(name = 'mytestapp', location = location, sample_app = TRUE, right_sidebar = TRUE)
-#> periscope2 application mytestapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application mytestapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/mytestapp'), TRUE)
# blank app named 'myblankapp' created in a temp dir
location <- tempdir()
create_application(name = 'myblankapp', location = location)
-#> periscope2 application myblankapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application myblankapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/myblankapp'), TRUE)
# blank app named 'myblankapp' without a left sidebar created in a temp dir
location <- tempdir()
create_application(name = 'myblankapp', location = location, left_sidebar = FALSE)
-#> periscope2 application myblankapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application myblankapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/myblankapp'), TRUE)
diff --git a/docs/reference/create_left_sidebar.html b/docs/reference/create_left_sidebar.html
index 590b78fc..dd2aaa19 100644
--- a/docs/reference/create_left_sidebar.html
+++ b/docs/reference/create_left_sidebar.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/create_right_sidebar.html b/docs/reference/create_right_sidebar.html
index c5cbf3dc..be481434 100644
--- a/docs/reference/create_right_sidebar.html
+++ b/docs/reference/create_right_sidebar.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/downloadFile.html b/docs/reference/downloadFile.html
index a949eef1..9331c5ae 100644
--- a/docs/reference/downloadFile.html
+++ b/docs/reference/downloadFile.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -99,7 +102,8 @@ downloadFile module server function
logger = NULL,
filenameroot = "download",
datafxns = NULL,
- aspectratio = 1
+ aspectratio = 1,
+ row_names = TRUE
)
@@ -132,6 +136,11 @@ Arguments
1 = square, 1.3 = 4:3, 0.5 = 1:2). Where not applicable for a download type
it is ignored (e.g. data downloads).
+
+row_names
+logical value indicating whether row names are to be written
+for tabular data. Where not applicable for a download type it is ignored.
Value
@@ -177,7 +186,7 @@ Examples
logger = "",
filenameroot = "mydownload1",
datafxns = list(csv = reactiveVal(iris)),
- aspectratio = 1)
+ row_names = FALSE)
# multiple download types
downloadFile(id = "object_id2",
logger = "",
diff --git a/docs/reference/downloadFileButton.html b/docs/reference/downloadFileButton.html
index 61b1d085..5d992a64 100644
--- a/docs/reference/downloadFileButton.html
+++ b/docs/reference/downloadFileButton.html
@@ -20,7 +20,7 @@
@@ -46,6 +46,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -174,7 +177,7 @@ Examples
logger = "",
filenameroot = "mydownload1",
datafxns = list(csv = reactiveVal(iris)),
- aspectratio = 1)
+ row_names = FALSE)
# multiple download types
downloadFile(id = "object_id2",
logger = "",
diff --git a/docs/reference/downloadFile_AvailableTypes.html b/docs/reference/downloadFile_AvailableTypes.html
index 7a6476e6..573a1a83 100644
--- a/docs/reference/downloadFile_AvailableTypes.html
+++ b/docs/reference/downloadFile_AvailableTypes.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/downloadFile_ValidateTypes.html b/docs/reference/downloadFile_ValidateTypes.html
index f37569ab..76c1733c 100644
--- a/docs/reference/downloadFile_ValidateTypes.html
+++ b/docs/reference/downloadFile_ValidateTypes.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/downloadablePlot.html b/docs/reference/downloadablePlot.html
index 6eb200d7..891ef861 100644
--- a/docs/reference/downloadablePlot.html
+++ b/docs/reference/downloadablePlot.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -190,9 +193,9 @@ Examples
download_plot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example ") +
xlab("wt") +
ylab("mpg")
diff --git a/docs/reference/downloadablePlotUI.html b/docs/reference/downloadablePlotUI.html
index 21ae0b5c..854ebf12 100644
--- a/docs/reference/downloadablePlotUI.html
+++ b/docs/reference/downloadablePlotUI.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -226,9 +229,9 @@ Examples
download_plot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example ") +
xlab("wt") +
ylab("mpg")
diff --git a/docs/reference/downloadableReactTable.html b/docs/reference/downloadableReactTable.html
new file mode 100644
index 00000000..0d207525
--- /dev/null
+++ b/docs/reference/downloadableReactTable.html
@@ -0,0 +1,276 @@
+
+downloadableReactTable module server function — downloadableReactTable • periscope2
+
+
+
+
+
+
+
+
+
+
+ downloadableReactTable module server function
+ Source: R/downloadableReactTable.R
+ downloadableReactTable.Rd
+
+
+
+ Server-side function for the downloadableReactTableUI.
+
+
+
+ downloadableReactTable(
+ id,
+ table_data,
+ selection_mode = NULL,
+ pre_selected_rows = NULL,
+ file_name_root = "data_file",
+ download_data_fxns = NULL,
+ pagination = FALSE,
+ table_height = 600,
+ show_rownames = FALSE,
+ columns_filter = FALSE,
+ global_search = TRUE,
+ row_highlight = TRUE,
+ row_striping = TRUE,
+ table_options = list(),
+ logger = NULL
+)
+
+
+
+ Arguments
+
+
+- id
+the ID of the Module's UI element
- table_data
+reactive expression (or parameter-less function) that acts as table data source
- selection_mode
+to enable row selection, set selection_mode value to either "single" for single row
+selection or "multiple" for multiple rows selection, case insensitive. Any other value will
+disable row selection. Row selection will be enabled by radio buttons in "single" selection
+and checkboxes in "multiple" selection (default = NULL)
- pre_selected_rows
+reactive expression (or parameter-less function) provides the rows indices of the rows to
+be selected when the table is rendered. If selection_mode is disabled, this parameter will
+have no effect. If selection_mode is "single" only the first row index will be used (default = NULL)
- file_name_root
+the base name used for user-downloaded file. It can be either a character string
+a reactive expression or a function returning a character string (default = 'data_file')
- download_data_fxns
+a named list of functions providing the data as return values.
+The names for the list should be the same names as the ones used in the
+downloadableReactTableUI (default = NULL)
- pagination
+to enable table pagination (default = FALSE)
- table_height
+max table height in pixels. Vertical scroll will be shown after that height value
- show_rownames
+enable displaying rownames as a separate column (default = FALSE)
- columns_filter
+enable the filtering input on each column in the table (default = FALSE)
- global_search
+enable table global searching input to search and filter in all columns at once
+(default = TRUE)
- row_highlight
+enable highlighting rows upon mouse hover (default = TRUE)
- row_striping
+add zebra-striped style to table rows (default = TRUE)
- table_options
+optional table formatting parameters check ?reactable::reactable for options full list.
+Also see example below to see how to pass options (default = list())
- logger
+logger to use (default = NULL)
+
+ Value
+ A named list of two elements:
selected_rows: data.frame of current selected rows
table_state: a list of the current table state. The list keys are
+("page", "pageSize", "pages", "sorted" and "selected").
+Review ?reactable::getReactableState for more info.
+
+ Shiny Usage
+
+
+This function is not called directly by consumers - it is accessed in
+server.R using the same id provided in downloadableReactTableUI:
+downloadableReactTable(id)
+
+
+ See also
+
+
+
+
+ Examples
+ if (interactive()) {
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+ shinyApp(
+ ui = fluidPage(fluidRow(column(
+ width = 12,
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")))),
+ server = function(input, output) {
+ table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+ })
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reference/downloadableReactTableUI.html b/docs/reference/downloadableReactTableUI.html
new file mode 100644
index 00000000..8edd37f2
--- /dev/null
+++ b/docs/reference/downloadableReactTableUI.html
@@ -0,0 +1,238 @@
+
+downloadableReactTable module UI function — downloadableReactTableUI • periscope2
+
+
+
+
+
+
+
+
+
+
+ downloadableReactTable module UI function
+ Source: R/downloadableReactTable.R
+ downloadableReactTableUI.Rd
+
+
+
+ downloadableReactTable module is extending ?reactable package table functions by creating
+a custom high-functionality table paired with downloadFile button.
+The table has the following default functionality:search, highlight functionality, infinite scrolling, sorting by columns and
+returns a reactive dataset of selected items and table current state.
+
+
+
+ downloadableReactTableUI(id, downloadtypes = NULL, hovertext = NULL)
+
+
+
+ Arguments
+
+
+
+
+ Value
+ list of downloadFileButton UI and reactable table and hidden inputs for contentHeight option
+
+
+ Details
+ downloadFile button will be hidden if downloadableReactTableUI parameter
+downloadtypes is empty
+
+
+ Table Features
+
+
+Consistent styling of the table
downloadFile module button functionality built-in to the table (it will be shown only if downloadtypes is defined)
Ability to show different data from the download data
Table is automatically fit to the window size with infinite
+y-scrolling
Table search functionality including highlighting built-in
Multi-select built in, including reactive feedback on which table
+items are selected
+
+ Example
+
+
+downloadableReactTableUI("mytableID", c("csv", "tsv"),
+"Click Here")
+
+
+ Notes
+
+
+When there are no rows to download in any of the linked downloaddatafxns the
+button will be hidden as there is nothing to download.
+
+
+ Shiny Usage
+
+
+Call this function at the place in ui.R where the table should be placed.
+Paired with a call to downloadableReactTable(id, ...)
+in server.R
+
+
+ See also
+
+
+
+
+ Examples
+ if (interactive()) {
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+ shinyApp(
+ ui = fluidPage(fluidRow(column(
+ width = 12,
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")))),
+ server = function(input, output) {
+ table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ showSortable = TRUE,
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+ })
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/reference/downloadableTable.html b/docs/reference/downloadableTable.html
index daa4272c..50fee61b 100644
--- a/docs/reference/downloadableTable.html
+++ b/docs/reference/downloadableTable.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/downloadableTableUI.html b/docs/reference/downloadableTableUI.html
index 8867e2e4..969af537 100644
--- a/docs/reference/downloadableTableUI.html
+++ b/docs/reference/downloadableTableUI.html
@@ -19,7 +19,7 @@
@@ -45,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/get_url_parameters.html b/docs/reference/get_url_parameters.html
index d6b77367..9bde4aa2 100644
--- a/docs/reference/get_url_parameters.html
+++ b/docs/reference/get_url_parameters.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/index.html b/docs/reference/index.html
index f358f82f..2a7aacab 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -159,6 +162,14 @@ All functions downloadablePlotUI()
downloadablePlot module UI function
+
+
+ downloadableReactTable module server function
+
+
+ downloadableReactTable module UI function
diff --git a/docs/reference/load_announcements.html b/docs/reference/load_announcements.html
index b16b3ae7..54bd7551 100644
--- a/docs/reference/load_announcements.html
+++ b/docs/reference/load_announcements.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/logViewerOutput.html b/docs/reference/logViewerOutput.html
index 5c61fff1..b006d291 100644
--- a/docs/reference/logViewerOutput.html
+++ b/docs/reference/logViewerOutput.html
@@ -1,6 +1,7 @@
-Display app logs — logViewerOutput • periscope2 Display app logs — logViewerOutput • periscope2
@@ -18,7 +19,7 @@
@@ -44,6 +45,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -87,8 +91,9 @@ Display app logs
- Creates a shiny table with table containing logged user actions. Table contents are auto updated whenever a user action is
-logged. The id must match the same id configured in server.R file upon calling fw_server_setup method
+ Display app log data in downloadableReactTable table containing logged user actions. Table contents are auto updated
+whenever a user action is logged. User can search for logs, sort them by time and download them in CSV or TSV format.
+The id must match the same id configured in server.R file upon calling fw_server_setup method
@@ -105,7 +110,7 @@ Arguments
Value
- shiny tableOutput instance
+ downloadableReactTableUI instance
Table columns
@@ -143,7 +148,28 @@ Examples
# Inside ui_body add the log viewer box to your box list
logViewerOutput('logViewerId')
-#> <div id="logViewerId-logViewerId" class="shiny-html-output"></div>
+#> [[1]]
+#> <div class="shiny-panel-conditional" data-display-if="output.displayButton" data-ns-prefix="logViewerId-logViewerId-">
+#> <span id="logViewerId-logViewerId-reactTableButtonDiv" class="periscope-downloadable-react-table-button" style="">
+#> <span class="btn-group" data-toggle="tooltip" data-placement="top" title="Download application logs">
+#> <button aria-expanded="false" aria-haspopup="true" class="btn btn-default action-button dropdown-toggle periscope-download-btn" data-toggle="dropdown" id="logViewerId-logViewerId-reactTableButtonID-downloadFileList" type="button action">
+#> <i class="far fa-copy" role="presentation" aria-label="copy icon"></i>
+#> </button>
+#> <ul class="dropdown-menu" id="logViewerId-logViewerId-reactTableButtonID-testList">
+#> <li>
+#> <a aria-disabled="true" class="shiny-download-link disabled periscope-download-choice" download href="" id="logViewerId-logViewerId-reactTableButtonID-csv" tabindex="-1" target="_blank">csv</a>
+#> </li>
+#> <li>
+#> <a aria-disabled="true" class="shiny-download-link disabled periscope-download-choice" download href="" id="logViewerId-logViewerId-reactTableButtonID-tsv" tabindex="-1" target="_blank">tsv</a>
+#> </li>
+#> </ul>
+#> </span>
+#> </span>
+#> </div>
+#>
+#> [[2]]
+#> <div class="reactable html-widget html-widget-output shiny-report-size html-fill-item" data-reactable-output="logViewerId-logViewerId-reactTableOutputID" id="logViewerId-logViewerId-reactTableOutputID" style="width:auto;height:auto;"></div>
+#>
diff --git a/docs/reference/logging-entrypoints.html b/docs/reference/logging-entrypoints.html
index a696fe57..111425c9 100644
--- a/docs/reference/logging-entrypoints.html
+++ b/docs/reference/logging-entrypoints.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/periscope2.html b/docs/reference/periscope2.html
index f7d82eee..ba853cc6 100644
--- a/docs/reference/periscope2.html
+++ b/docs/reference/periscope2.html
@@ -21,7 +21,7 @@
@@ -47,6 +47,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/set_app_parameters.html b/docs/reference/set_app_parameters.html
index c935d94e..17cac068 100644
--- a/docs/reference/set_app_parameters.html
+++ b/docs/reference/set_app_parameters.html
@@ -17,7 +17,7 @@
@@ -43,6 +43,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
@@ -122,7 +125,7 @@ Arguments
log_level
-Designating the log level to use for the user log as 'DEBUG','INFO', 'WARN' or 'ERROR' (default = 'DEBUG')
Designating the log level to use for the user log as 'DEBUG','INFO', 'WARNING' or 'ERROR' (default = 'DEBUG')
app_version
diff --git a/docs/reference/themeConfigurationsAddin.html b/docs/reference/themeConfigurationsAddin.html
index cc93464c..431f5dfb 100644
--- a/docs/reference/themeConfigurationsAddin.html
+++ b/docs/reference/themeConfigurationsAddin.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/reference/ui_tooltip.html b/docs/reference/ui_tooltip.html
index 0a3d3c91..f5f933c1 100644
--- a/docs/reference/ui_tooltip.html
+++ b/docs/reference/ui_tooltip.html
@@ -18,7 +18,7 @@
@@ -44,6 +44,9 @@
Using the downloadablePlot Shiny Module
+
+ Using downloadableReactTable Shiny Module
+
Using the downloadableTable Shiny Module
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index d7dd9a40..19a48ff5 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -5,6 +5,7 @@
/articles/applicationReset-module.html /articles/downloadFile-module.html /articles/downloadablePlot-module.html /articles/downloadableReactTable-module.html /articles/downloadableTable-module.html /articles/index.html /articles/logViewer-module.html /reference/downloadFile_ValidateTypes.html /reference/downloadablePlot.html /reference/downloadablePlotUI.html /reference/downloadableReactTable.html /reference/downloadableReactTableUI.html /reference/downloadableTable.html /reference/downloadableTableUI.html /reference/get_url_parameters.html \n action time \n Be Sure to Remember to Log ALL user actions 02-19-2022 14:03 \n Sample Title (click for an info pop-up) started with log level <DEBUG> 02-19-2022 14:03 \n Application Reset requested by user. Resetting in 5 seconds 02-19-2022 14:04 \n
"
+ {"x":{"tag":{"name":"Reactable","attribs":{"data":{"action":["Be Sure to Remember to Log ALL user actions","Sample Title (click for an info pop-up) started with log level ","Application Reset requested by user. Resetting in 5 seconds"],"time":["02-19-2022 14:03","02-19-2022 14:03","02-19-2022 14:04"]},"columns":[{"id":"action","name":"action","type":"character"},{"id":"time","name":"time","type":"character"}],"searchable":true,"pagination":false,"highlight":true,"striped":true,"height":"600px","dataKey":"b624cab69fef11e8d7efb72689e14787","static":false},"children":[]},"class":"reactR_markup"},"evals":[],"jsHooks":[],"deps":[]}
diff --git a/tests/testthat/sample_app_both_sidebars/program/fxn/plots.R b/tests/testthat/sample_app_both_sidebars/program/fxn/plots.R
index 01e99446..96de8aa5 100644
--- a/tests/testthat/sample_app_both_sidebars/program/fxn/plots.R
+++ b/tests/testthat/sample_app_both_sidebars/program/fxn/plots.R
@@ -14,9 +14,9 @@ attr(mtcars, "show_rownames") <- TRUE
plot2ggplot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
diff --git a/tests/testthat/sample_app_both_sidebars/program/fxn/program_helpers.R b/tests/testthat/sample_app_both_sidebars/program/fxn/program_helpers.R
index 5e0b6d64..d6d7d968 100644
--- a/tests/testthat/sample_app_both_sidebars/program/fxn/program_helpers.R
+++ b/tests/testthat/sample_app_both_sidebars/program/fxn/program_helpers.R
@@ -9,6 +9,7 @@ files_idx <- read.csv("program/data/struc_indx.csv")
rownames(app_files) <- app_files$X
app_files$X <- NULL
+app_files <- app_files %>% mutate(across(where(is.character), ~na_if(., "")))
rownames(files_idx) <- files_idx$X
files_idx$X <- NULL
@@ -32,10 +33,10 @@ load_data2 <- function() {
load_data3 <- function() {
ldf <- df %>%
- select(1:3) %>%
+ select(1:3) %>%
mutate(Total.Population.Change = as.numeric(gsub(",", "", Total.Population.Change)),
Natural.Increase = as.numeric(gsub(",", "", Natural.Increase)))
-
+
as.data.frame(ldf)
}
diff --git a/tests/testthat/sample_app_both_sidebars/program/global.R b/tests/testthat/sample_app_both_sidebars/program/global.R
index f0ec7ffb..5952b8dc 100644
--- a/tests/testthat/sample_app_both_sidebars/program/global.R
+++ b/tests/testthat/sample_app_both_sidebars/program/global.R
@@ -9,6 +9,7 @@
# to server, UI and session scopes
# ----------------------------------------
library(DT)
+library(reactable)
library(shiny)
library(periscope2)
library(waiter)
diff --git a/tests/testthat/sample_app_both_sidebars/program/server_local.R b/tests/testthat/sample_app_both_sidebars/program/server_local.R
index 2b7647bb..da48d989 100644
--- a/tests/testthat/sample_app_both_sidebars/program/server_local.R
+++ b/tests/testthat/sample_app_both_sidebars/program/server_local.R
@@ -70,6 +70,43 @@ downloadableTable("exampleDT1",
formatStyle = list(columns = c("Natural.Increase"),
backgroundColor = DT::styleInterval(c(7614, 15914, 34152),
c("lightgray", "gray", "cadetblue", "#808000")))))
+
+downloadableReactTable(id = "exampleReactTable",
+ logger = ss_userAction.Log,
+ table_data = load_data3,
+ file_name_root = "exampleReacttable",
+ download_data_fxns = list(csv = load_data3, tsv = load_data3),
+ table_options = list(
+ defaultSorted = "Total.Population.Change",
+ columnGroups = list(colGroup(name = "Statistics", columns = c("Total.Population.Change", "Natural.Increase"))),
+ columns = list(
+ Total.Population.Change = colDef(
+ name = "Change",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 0) {
+ tags$span(style = "color:red", value)
+ } else {
+ tags$span(style = "color:green", value)
+ }
+ }),
+ Natural.Increase = colDef(
+ name = "Increase",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 7614) {
+ tags$span(class = "badge bg-primary", value)
+ } else if (value <= 15914) {
+ tags$span(class = "badge bg-secondary", value)
+ } else if (value <= 34152) {
+ tags$span(class = "badge bg-info", value)
+ } else {
+ tags$span(class = "badge bg-success", value)
+ }
+ }),
+ Geographic.Area = colDef(name = "Location", filterable = TRUE))))
+
+
downloadablePlot("examplePlot2",
ss_userAction.Log,
filenameroot = "plot2_ggplot",
diff --git a/tests/testthat/sample_app_both_sidebars/program/ui_body.R b/tests/testthat/sample_app_both_sidebars/program/ui_body.R
index 84fb2d53..07f7a348 100644
--- a/tests/testthat/sample_app_both_sidebars/program/ui_body.R
+++ b/tests/testthat/sample_app_both_sidebars/program/ui_body.R
@@ -141,6 +141,47 @@ application_setup <- tabItem(tabName = "application_setup",
plot2_hover <- hoverOpts(id = "examplePlot2_hover")
+react_table_box <- box(
+ id = "react_downloader",
+ title = "React Table Downloader",
+ status = "info",
+ solidHeader = TRUE,
+ collapsible = TRUE,
+ width = 12,
+ fluidRow(column(width = 6,
+ tags$dl(tags$dt("Features"),
+ tags$ul(tags$li("React table downloader module displays tabular data in rich formatted tables using the", tags$b("`reactable`"), "package"),
+ tags$li("downloadableReactTable returns a named reactive list that can be used in the application:",
+ tags$ul(tags$li(tags$b("selected_rows"), ": data.frame of current selected rows"),
+ tags$li(tags$b("table_state"), ": a list of the current table state"))),
+ tags$li("Table data can be downloaded in different formats such as: ", tags$b("'csv'"),
+ ", ", tags$b("'tsv'"), ", ", tags$b("'txt'"), "and/or ", tags$b("'xlsx'")),
+ tags$li("User can customize downloadableReactTable modules using reactable package options."),
+ tags$li("For more information about table options please visit the",
+ tags$a("Reactable documentation", target = "_blank", href = "https://glin.github.io/reactable/"),
+ "site")
+ ))),
+ column(width = 6,
+ tags$dl(tags$dt("Setup"),
+ tags$li("Module should be configured in both UI and Server code"),
+ tags$li("In the 'body_ui.R' add the following lines:",
+ blockQuote("downloadableReactTableUI('exampleReactTable',
+ 'Download react table data'))", color = "info")),
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
+ blockQuote("downloadableReactTable('exampleReactTable',
+ ss_userAction.Log,
+ 'exampletable',
+ list(csv = load_data3, tsv = load_data3))", color = "info")),
+ tags$li("Review ", tags$b("?downloadableReactTableUI"), " and ", tags$b("?downloadableReactTable"), " for more information"),
+ tags$li("Review below table for detailed example code")))),
+ fluidRow(column(width = 12,
+ downloadableReactTableUI(id = "exampleReactTable",
+ downloadtypes = list("csv", "tsv"),
+ hovertext = "Download react table data")))
+
+)
+
+
table_downloader_box <- box(
id = "table_downloader",
title = "Table Downloader",
@@ -168,11 +209,11 @@ table_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$li("Module should be configured in both UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadableTableUI('exampleDT1',
list('csv', 'tsv'),
'Download table data'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadableTable('exampleDT1',
ss_userAction.Log,
'exampletable',
@@ -237,9 +278,9 @@ plot_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$ul(tags$li("Module should be configured in both the UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadablePlotUI('myplotID', c('png', 'csv'), 'Download Plot or Data', '300px'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadablePlot('myplotID',
ss_userAction.Log,
filenameroot = 'mydownload1',
@@ -297,6 +338,7 @@ reset_application_box <- box(
periscope_modules <- tabItem(tabName = "periscope_modules",
+ react_table_box,
table_downloader_box,
plot_downloader_box,
file_downloader_box,
diff --git a/tests/testthat/sample_app_both_sidebars/www/css/custom.css b/tests/testthat/sample_app_both_sidebars/www/css/custom.css
index f59e4811..b2bc613c 100644
--- a/tests/testthat/sample_app_both_sidebars/www/css/custom.css
+++ b/tests/testthat/sample_app_both_sidebars/www/css/custom.css
@@ -60,6 +60,11 @@ table.shiny-table {
float: left;
}
+/* Downloadable React Table */
+.periscope-downloadable-react-table-button {
+ display: inline-flex;
+}
+
/* Downloadable Plot */
.periscope-downloadable-plot { }
.periscope-downloadable-plot-button {
@@ -119,6 +124,28 @@ a:focus:not(.nav-link) {
/* END of periscope2 basic CSS*/
+/* downloadableReactTable Tooltip */
+.tooltip[data-tooltip-for="react-download-button"] .tooltip-inner {
+ background-color: #ffffff !important;
+ color: #212529 !important;
+ border: 1px solid #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::before {
+ border-top-color: #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::after {
+ content: '';
+ position: absolute;
+ bottom: 1px;
+ left: 50%;
+ margin-left: -5px;
+ border-width: 5px;
+ border-style: solid;
+ border-color: #ffffff transparent transparent transparent;
+}
+
/* ========================================================================== */
/* --- APP-SPECIFIC CUSTOM CSS ---
diff --git a/tests/testthat/sample_app_both_sidebars/www/js/custom.js b/tests/testthat/sample_app_both_sidebars/www/js/custom.js
index 728ebc18..a613b78a 100644
--- a/tests/testthat/sample_app_both_sidebars/www/js/custom.js
+++ b/tests/testthat/sample_app_both_sidebars/www/js/custom.js
@@ -20,6 +20,31 @@ setInterval(function() {
}, 100);
+function initializeReactTableTooltips() {
+ // Initialize all downloadable react table tooltips
+ $('.periscope-downloadable-react-table-button span.btn-group')
+ .tooltip()
+ .attr('data-tooltip-for', 'react-download-button');
+
+ // Add event handler only once
+ $(document).off('show.bs.tooltip.custom').on('show.bs.tooltip.custom', function(e) {
+ var $trigger = $(e.target);
+ var tooltipFor = $trigger.attr('data-tooltip-for');
+
+ if (tooltipFor) {
+ var tooltipInstance = $trigger.data('bs.tooltip');
+ var $tip = $(tooltipInstance.tip);
+ $tip.attr('data-tooltip-for', tooltipFor);
+ }
+ });
+}
+
+
+$(document).ready(function() {
+ initializeReactTableTooltips();
+});
+
+
// Resolve bs4Dash alert title and close button issues
Shiny.addCustomMessageHandler('pcreate-alert', function (message) {
// setup target
diff --git a/tests/testthat/sample_app_left_sidebar/program/fxn/plots.R b/tests/testthat/sample_app_left_sidebar/program/fxn/plots.R
index b6157c8f..c7abcc03 100644
--- a/tests/testthat/sample_app_left_sidebar/program/fxn/plots.R
+++ b/tests/testthat/sample_app_left_sidebar/program/fxn/plots.R
@@ -14,9 +14,9 @@ attr(mtcars, "show_rownames") <- TRUE
plot2ggplot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
diff --git a/tests/testthat/sample_app_left_sidebar/program/fxn/program_helpers.R b/tests/testthat/sample_app_left_sidebar/program/fxn/program_helpers.R
index 5e0b6d64..d6d7d968 100644
--- a/tests/testthat/sample_app_left_sidebar/program/fxn/program_helpers.R
+++ b/tests/testthat/sample_app_left_sidebar/program/fxn/program_helpers.R
@@ -9,6 +9,7 @@ files_idx <- read.csv("program/data/struc_indx.csv")
rownames(app_files) <- app_files$X
app_files$X <- NULL
+app_files <- app_files %>% mutate(across(where(is.character), ~na_if(., "")))
rownames(files_idx) <- files_idx$X
files_idx$X <- NULL
@@ -32,10 +33,10 @@ load_data2 <- function() {
load_data3 <- function() {
ldf <- df %>%
- select(1:3) %>%
+ select(1:3) %>%
mutate(Total.Population.Change = as.numeric(gsub(",", "", Total.Population.Change)),
Natural.Increase = as.numeric(gsub(",", "", Natural.Increase)))
-
+
as.data.frame(ldf)
}
diff --git a/tests/testthat/sample_app_left_sidebar/program/global.R b/tests/testthat/sample_app_left_sidebar/program/global.R
index f0ec7ffb..5952b8dc 100644
--- a/tests/testthat/sample_app_left_sidebar/program/global.R
+++ b/tests/testthat/sample_app_left_sidebar/program/global.R
@@ -9,6 +9,7 @@
# to server, UI and session scopes
# ----------------------------------------
library(DT)
+library(reactable)
library(shiny)
library(periscope2)
library(waiter)
diff --git a/tests/testthat/sample_app_left_sidebar/program/server_local.R b/tests/testthat/sample_app_left_sidebar/program/server_local.R
index beb90bda..cbfc91bf 100644
--- a/tests/testthat/sample_app_left_sidebar/program/server_local.R
+++ b/tests/testthat/sample_app_left_sidebar/program/server_local.R
@@ -70,6 +70,43 @@ downloadableTable("exampleDT1",
formatStyle = list(columns = c("Natural.Increase"),
backgroundColor = DT::styleInterval(c(7614, 15914, 34152),
c("lightgray", "gray", "cadetblue", "#808000")))))
+
+downloadableReactTable(id = "exampleReactTable",
+ logger = ss_userAction.Log,
+ table_data = load_data3,
+ file_name_root = "exampleReacttable",
+ download_data_fxns = list(csv = load_data3, tsv = load_data3),
+ table_options = list(
+ defaultSorted = "Total.Population.Change",
+ columnGroups = list(colGroup(name = "Statistics", columns = c("Total.Population.Change", "Natural.Increase"))),
+ columns = list(
+ Total.Population.Change = colDef(
+ name = "Change",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 0) {
+ tags$span(style = "color:red", value)
+ } else {
+ tags$span(style = "color:green", value)
+ }
+ }),
+ Natural.Increase = colDef(
+ name = "Increase",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 7614) {
+ tags$span(class = "badge bg-primary", value)
+ } else if (value <= 15914) {
+ tags$span(class = "badge bg-secondary", value)
+ } else if (value <= 34152) {
+ tags$span(class = "badge bg-info", value)
+ } else {
+ tags$span(class = "badge bg-success", value)
+ }
+ }),
+ Geographic.Area = colDef(name = "Location", filterable = TRUE))))
+
+
downloadablePlot("examplePlot2",
ss_userAction.Log,
filenameroot = "plot2_ggplot",
diff --git a/tests/testthat/sample_app_left_sidebar/program/ui_body.R b/tests/testthat/sample_app_left_sidebar/program/ui_body.R
index d1c33791..62619516 100644
--- a/tests/testthat/sample_app_left_sidebar/program/ui_body.R
+++ b/tests/testthat/sample_app_left_sidebar/program/ui_body.R
@@ -168,11 +168,11 @@ table_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$li("Module should be configured in both UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadableTableUI('exampleDT1',
list('csv', 'tsv'),
'Download table data'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadableTable('exampleDT1',
ss_userAction.Log,
'exampletable',
@@ -186,6 +186,47 @@ table_downloader_box <- box(
)
+
+react_table_box <- box(
+ id = "react_downloader",
+ title = "React Table Downloader",
+ status = "info",
+ solidHeader = TRUE,
+ collapsible = TRUE,
+ width = 12,
+ fluidRow(column(width = 6,
+ tags$dl(tags$dt("Features"),
+ tags$ul(tags$li("React table downloader module displays tabular data in rich formatted tables using the", tags$b("`reactable`"), "package"),
+ tags$li("downloadableReactTable returns a named reactive list that can be used in the application:",
+ tags$ul(tags$li(tags$b("selected_rows"), ": data.frame of current selected rows"),
+ tags$li(tags$b("table_state"), ": a list of the current table state"))),
+ tags$li("Table data can be downloaded in different formats such as: ", tags$b("'csv'"),
+ ", ", tags$b("'tsv'"), ", ", tags$b("'txt'"), "and/or ", tags$b("'xlsx'")),
+ tags$li("User can customize downloadableReactTable modules using reactable package options."),
+ tags$li("For more information about table options please visit the",
+ tags$a("Reactable documentation", target = "_blank", href = "https://glin.github.io/reactable/"),
+ "site")
+ ))),
+ column(width = 6,
+ tags$dl(tags$dt("Setup"),
+ tags$li("Module should be configured in both UI and Server code"),
+ tags$li("In the 'body_ui.R' add the following lines:",
+ blockQuote("downloadableReactTableUI('exampleReactTable',
+ 'Download react table data'))", color = "info")),
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
+ blockQuote("downloadableReactTable('exampleReactTable',
+ ss_userAction.Log,
+ 'exampletable',
+ list(csv = load_data3, tsv = load_data3))", color = "info")),
+ tags$li("Review ", tags$b("?downloadableReactTableUI"), " and ", tags$b("?downloadableReactTable"), " for more information"),
+ tags$li("Review below table for detailed example code")))),
+ fluidRow(column(width = 12,
+ downloadableReactTableUI(id = "exampleReactTable",
+ downloadtypes = list("csv", "tsv"),
+ hovertext = "Download react table data")))
+
+)
+
file_downloader_box <- box(
id = "file_downloader",
title = "File Downloader",
@@ -237,9 +278,9 @@ plot_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$ul(tags$li("Module should be configured in both the UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadablePlotUI('myplotID', c('png', 'csv'), 'Download Plot or Data', '300px'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadablePlot('myplotID',
ss_userAction.Log,
filenameroot = 'mydownload1',
@@ -297,6 +338,7 @@ reset_application_box <- box(
periscope_modules <- tabItem(tabName = "periscope_modules",
+ react_table_box,
table_downloader_box,
plot_downloader_box,
file_downloader_box,
diff --git a/tests/testthat/sample_app_left_sidebar/www/css/custom.css b/tests/testthat/sample_app_left_sidebar/www/css/custom.css
index f59e4811..586bf0c6 100644
--- a/tests/testthat/sample_app_left_sidebar/www/css/custom.css
+++ b/tests/testthat/sample_app_left_sidebar/www/css/custom.css
@@ -60,6 +60,11 @@ table.shiny-table {
float: left;
}
+/* Downloadable React Table */
+.periscope-downloadable-react-table-button {
+ display: inline-flex;
+}
+
/* Downloadable Plot */
.periscope-downloadable-plot { }
.periscope-downloadable-plot-button {
@@ -117,6 +122,28 @@ a:focus:not(.nav-link) {
color: #1F2D3D!important;
}
+/* downloadableReactTable Tooltip */
+.tooltip[data-tooltip-for="react-download-button"] .tooltip-inner {
+ background-color: #ffffff !important;
+ color: #212529 !important;
+ border: 1px solid #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::before {
+ border-top-color: #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::after {
+ content: '';
+ position: absolute;
+ bottom: 1px;
+ left: 50%;
+ margin-left: -5px;
+ border-width: 5px;
+ border-style: solid;
+ border-color: #ffffff transparent transparent transparent;
+}
+
/* END of periscope2 basic CSS*/
/* ========================================================================== */
diff --git a/tests/testthat/sample_app_left_sidebar/www/js/custom.js b/tests/testthat/sample_app_left_sidebar/www/js/custom.js
index 728ebc18..a613b78a 100644
--- a/tests/testthat/sample_app_left_sidebar/www/js/custom.js
+++ b/tests/testthat/sample_app_left_sidebar/www/js/custom.js
@@ -20,6 +20,31 @@ setInterval(function() {
}, 100);
+function initializeReactTableTooltips() {
+ // Initialize all downloadable react table tooltips
+ $('.periscope-downloadable-react-table-button span.btn-group')
+ .tooltip()
+ .attr('data-tooltip-for', 'react-download-button');
+
+ // Add event handler only once
+ $(document).off('show.bs.tooltip.custom').on('show.bs.tooltip.custom', function(e) {
+ var $trigger = $(e.target);
+ var tooltipFor = $trigger.attr('data-tooltip-for');
+
+ if (tooltipFor) {
+ var tooltipInstance = $trigger.data('bs.tooltip');
+ var $tip = $(tooltipInstance.tip);
+ $tip.attr('data-tooltip-for', tooltipFor);
+ }
+ });
+}
+
+
+$(document).ready(function() {
+ initializeReactTableTooltips();
+});
+
+
// Resolve bs4Dash alert title and close button issues
Shiny.addCustomMessageHandler('pcreate-alert', function (message) {
// setup target
diff --git a/tests/testthat/sample_app_no_both_sidebars/program/fxn/plots.R b/tests/testthat/sample_app_no_both_sidebars/program/fxn/plots.R
index 4b3d5aea..5942a824 100644
--- a/tests/testthat/sample_app_no_both_sidebars/program/fxn/plots.R
+++ b/tests/testthat/sample_app_no_both_sidebars/program/fxn/plots.R
@@ -14,9 +14,9 @@ attr(mtcars, "show_rownames") <- TRUE
plot2ggplot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
diff --git a/tests/testthat/sample_app_no_both_sidebars/program/fxn/program_helpers.R b/tests/testthat/sample_app_no_both_sidebars/program/fxn/program_helpers.R
index 5e0b6d64..d6d7d968 100644
--- a/tests/testthat/sample_app_no_both_sidebars/program/fxn/program_helpers.R
+++ b/tests/testthat/sample_app_no_both_sidebars/program/fxn/program_helpers.R
@@ -9,6 +9,7 @@ files_idx <- read.csv("program/data/struc_indx.csv")
rownames(app_files) <- app_files$X
app_files$X <- NULL
+app_files <- app_files %>% mutate(across(where(is.character), ~na_if(., "")))
rownames(files_idx) <- files_idx$X
files_idx$X <- NULL
@@ -32,10 +33,10 @@ load_data2 <- function() {
load_data3 <- function() {
ldf <- df %>%
- select(1:3) %>%
+ select(1:3) %>%
mutate(Total.Population.Change = as.numeric(gsub(",", "", Total.Population.Change)),
Natural.Increase = as.numeric(gsub(",", "", Natural.Increase)))
-
+
as.data.frame(ldf)
}
diff --git a/tests/testthat/sample_app_no_both_sidebars/program/global.R b/tests/testthat/sample_app_no_both_sidebars/program/global.R
index f0ec7ffb..5952b8dc 100644
--- a/tests/testthat/sample_app_no_both_sidebars/program/global.R
+++ b/tests/testthat/sample_app_no_both_sidebars/program/global.R
@@ -9,6 +9,7 @@
# to server, UI and session scopes
# ----------------------------------------
library(DT)
+library(reactable)
library(shiny)
library(periscope2)
library(waiter)
diff --git a/tests/testthat/sample_app_no_both_sidebars/program/server_local.R b/tests/testthat/sample_app_no_both_sidebars/program/server_local.R
index 7f5c46ab..5066c62a 100644
--- a/tests/testthat/sample_app_no_both_sidebars/program/server_local.R
+++ b/tests/testthat/sample_app_no_both_sidebars/program/server_local.R
@@ -70,6 +70,43 @@ downloadableTable("exampleDT1",
formatStyle = list(columns = c("Natural.Increase"),
backgroundColor = DT::styleInterval(c(7614, 15914, 34152),
c("lightgray", "gray", "cadetblue", "#808000")))))
+
+downloadableReactTable(id = "exampleReactTable",
+ logger = ss_userAction.Log,
+ table_data = load_data3,
+ file_name_root = "exampleReacttable",
+ download_data_fxns = list(csv = load_data3, tsv = load_data3),
+ table_options = list(
+ defaultSorted = "Total.Population.Change",
+ columnGroups = list(colGroup(name = "Statistics", columns = c("Total.Population.Change", "Natural.Increase"))),
+ columns = list(
+ Total.Population.Change = colDef(
+ name = "Change",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 0) {
+ tags$span(style = "color:red", value)
+ } else {
+ tags$span(style = "color:green", value)
+ }
+ }),
+ Natural.Increase = colDef(
+ name = "Increase",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 7614) {
+ tags$span(class = "badge bg-primary", value)
+ } else if (value <= 15914) {
+ tags$span(class = "badge bg-secondary", value)
+ } else if (value <= 34152) {
+ tags$span(class = "badge bg-info", value)
+ } else {
+ tags$span(class = "badge bg-success", value)
+ }
+ }),
+ Geographic.Area = colDef(name = "Location", filterable = TRUE))))
+
+
downloadablePlot("examplePlot2",
ss_userAction.Log,
filenameroot = "plot2_ggplot",
diff --git a/tests/testthat/sample_app_no_both_sidebars/program/ui_body.R b/tests/testthat/sample_app_no_both_sidebars/program/ui_body.R
index 488885a4..2779ba24 100644
--- a/tests/testthat/sample_app_no_both_sidebars/program/ui_body.R
+++ b/tests/testthat/sample_app_no_both_sidebars/program/ui_body.R
@@ -162,11 +162,11 @@ table_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$li("Module should be configured in both UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadableTableUI('exampleDT1',
list('csv', 'tsv'),
'Download table data'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadableTable('exampleDT1',
ss_userAction.Log,
'exampletable',
@@ -180,6 +180,48 @@ table_downloader_box <- box(
)
+
+react_table_box <- box(
+ id = "react_downloader",
+ title = "React Table Downloader",
+ status = "info",
+ solidHeader = TRUE,
+ collapsible = TRUE,
+ width = 12,
+ fluidRow(column(width = 6,
+ tags$dl(tags$dt("Features"),
+ tags$ul(tags$li("React table downloader module displays tabular data in rich formatted tables using the", tags$b("`reactable`"), "package"),
+ tags$li("downloadableReactTable returns a named reactive list that can be used in the application:",
+ tags$ul(tags$li(tags$b("selected_rows"), ": data.frame of current selected rows"),
+ tags$li(tags$b("table_state"), ": a list of the current table state"))),
+ tags$li("Table data can be downloaded in different formats such as: ", tags$b("'csv'"),
+ ", ", tags$b("'tsv'"), ", ", tags$b("'txt'"), "and/or ", tags$b("'xlsx'")),
+ tags$li("User can customize downloadableReactTable modules using reactable package options."),
+ tags$li("For more information about table options please visit the",
+ tags$a("Reactable documentation", target = "_blank", href = "https://glin.github.io/reactable/"),
+ "site")
+ ))),
+ column(width = 6,
+ tags$dl(tags$dt("Setup"),
+ tags$li("Module should be configured in both UI and Server code"),
+ tags$li("In the 'body_ui.R' add the following lines:",
+ blockQuote("downloadableReactTableUI('exampleReactTable',
+ 'Download react table data'))", color = "info")),
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
+ blockQuote("downloadableReactTable('exampleReactTable',
+ ss_userAction.Log,
+ 'exampletable',
+ list(csv = load_data3, tsv = load_data3))", color = "info")),
+ tags$li("Review ", tags$b("?downloadableReactTableUI"), " and ", tags$b("?downloadableReactTable"), " for more information"),
+ tags$li("Review below table for detailed example code")))),
+ fluidRow(column(width = 12,
+ downloadableReactTableUI(id = "exampleReactTable",
+ downloadtypes = list("csv", "tsv"),
+ hovertext = "Download react table data")))
+
+)
+
+
file_downloader_box <- box(
id = "file_downloader",
title = "File Downloader",
@@ -231,9 +273,9 @@ plot_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$ul(tags$li("Module should be configured in both the UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadablePlotUI('myplotID', c('png', 'csv'), 'Download Plot or Data', '300px'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadablePlot('myplotID',
ss_userAction.Log,
filenameroot = 'mydownload1',
@@ -291,6 +333,7 @@ reset_application_box <- box(
periscope_modules <- tabItem(tabName = "periscope_modules",
+ react_table_box,
table_downloader_box,
plot_downloader_box,
file_downloader_box,
diff --git a/tests/testthat/sample_app_no_both_sidebars/www/css/custom.css b/tests/testthat/sample_app_no_both_sidebars/www/css/custom.css
index 6e10e612..e19ef002 100644
--- a/tests/testthat/sample_app_no_both_sidebars/www/css/custom.css
+++ b/tests/testthat/sample_app_no_both_sidebars/www/css/custom.css
@@ -60,6 +60,11 @@ table.shiny-table {
float: left;
}
+/* Downloadable React Table */
+.periscope-downloadable-react-table-button {
+ display: inline-flex;
+}
+
/* Downloadable Plot */
.periscope-downloadable-plot { }
.periscope-downloadable-plot-button {
@@ -117,6 +122,28 @@ a:focus:not(.nav-link) {
color: #1F2D3D!important;
}
+
+/* downloadableReactTable Tooltip */
+.tooltip[data-tooltip-for="react-download-button"] .tooltip-inner {
+ background-color: #ffffff !important;
+ color: #212529 !important;
+ border: 1px solid #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::before {
+ border-top-color: #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::after {
+ content: '';
+ position: absolute;
+ bottom: 1px;
+ left: 50%;
+ margin-left: -5px;
+ border-width: 5px;
+ border-style: solid;
+ border-color: #ffffff transparent transparent transparent;
+}
/* END of periscope2 basic CSS*/
/* ========================================================================== */
diff --git a/tests/testthat/sample_app_no_both_sidebars/www/js/custom.js b/tests/testthat/sample_app_no_both_sidebars/www/js/custom.js
index 728ebc18..a613b78a 100644
--- a/tests/testthat/sample_app_no_both_sidebars/www/js/custom.js
+++ b/tests/testthat/sample_app_no_both_sidebars/www/js/custom.js
@@ -20,6 +20,31 @@ setInterval(function() {
}, 100);
+function initializeReactTableTooltips() {
+ // Initialize all downloadable react table tooltips
+ $('.periscope-downloadable-react-table-button span.btn-group')
+ .tooltip()
+ .attr('data-tooltip-for', 'react-download-button');
+
+ // Add event handler only once
+ $(document).off('show.bs.tooltip.custom').on('show.bs.tooltip.custom', function(e) {
+ var $trigger = $(e.target);
+ var tooltipFor = $trigger.attr('data-tooltip-for');
+
+ if (tooltipFor) {
+ var tooltipInstance = $trigger.data('bs.tooltip');
+ var $tip = $(tooltipInstance.tip);
+ $tip.attr('data-tooltip-for', tooltipFor);
+ }
+ });
+}
+
+
+$(document).ready(function() {
+ initializeReactTableTooltips();
+});
+
+
// Resolve bs4Dash alert title and close button issues
Shiny.addCustomMessageHandler('pcreate-alert', function (message) {
// setup target
diff --git a/tests/testthat/sample_app_right_sidebar/program/fxn/plots.R b/tests/testthat/sample_app_right_sidebar/program/fxn/plots.R
index b6157c8f..c7abcc03 100644
--- a/tests/testthat/sample_app_right_sidebar/program/fxn/plots.R
+++ b/tests/testthat/sample_app_right_sidebar/program/fxn/plots.R
@@ -14,9 +14,9 @@ attr(mtcars, "show_rownames") <- TRUE
plot2ggplot <- function() {
ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
diff --git a/tests/testthat/sample_app_right_sidebar/program/fxn/program_helpers.R b/tests/testthat/sample_app_right_sidebar/program/fxn/program_helpers.R
index 5e0b6d64..d6d7d968 100644
--- a/tests/testthat/sample_app_right_sidebar/program/fxn/program_helpers.R
+++ b/tests/testthat/sample_app_right_sidebar/program/fxn/program_helpers.R
@@ -9,6 +9,7 @@ files_idx <- read.csv("program/data/struc_indx.csv")
rownames(app_files) <- app_files$X
app_files$X <- NULL
+app_files <- app_files %>% mutate(across(where(is.character), ~na_if(., "")))
rownames(files_idx) <- files_idx$X
files_idx$X <- NULL
@@ -32,10 +33,10 @@ load_data2 <- function() {
load_data3 <- function() {
ldf <- df %>%
- select(1:3) %>%
+ select(1:3) %>%
mutate(Total.Population.Change = as.numeric(gsub(",", "", Total.Population.Change)),
Natural.Increase = as.numeric(gsub(",", "", Natural.Increase)))
-
+
as.data.frame(ldf)
}
diff --git a/tests/testthat/sample_app_right_sidebar/program/global.R b/tests/testthat/sample_app_right_sidebar/program/global.R
index f0ec7ffb..5952b8dc 100644
--- a/tests/testthat/sample_app_right_sidebar/program/global.R
+++ b/tests/testthat/sample_app_right_sidebar/program/global.R
@@ -9,6 +9,7 @@
# to server, UI and session scopes
# ----------------------------------------
library(DT)
+library(reactable)
library(shiny)
library(periscope2)
library(waiter)
diff --git a/tests/testthat/sample_app_right_sidebar/program/server_local.R b/tests/testthat/sample_app_right_sidebar/program/server_local.R
index df843931..3f6a703e 100644
--- a/tests/testthat/sample_app_right_sidebar/program/server_local.R
+++ b/tests/testthat/sample_app_right_sidebar/program/server_local.R
@@ -70,6 +70,43 @@ downloadableTable("exampleDT1",
formatStyle = list(columns = c("Natural.Increase"),
backgroundColor = DT::styleInterval(c(7614, 15914, 34152),
c("lightgray", "gray", "cadetblue", "#808000")))))
+
+downloadableReactTable(id = "exampleReactTable",
+ logger = ss_userAction.Log,
+ table_data = load_data3,
+ file_name_root = "exampleReacttable",
+ download_data_fxns = list(csv = load_data3, tsv = load_data3),
+ table_options = list(
+ defaultSorted = "Total.Population.Change",
+ columnGroups = list(colGroup(name = "Statistics", columns = c("Total.Population.Change", "Natural.Increase"))),
+ columns = list(
+ Total.Population.Change = colDef(
+ name = "Change",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 0) {
+ tags$span(style = "color:red", value)
+ } else {
+ tags$span(style = "color:green", value)
+ }
+ }),
+ Natural.Increase = colDef(
+ name = "Increase",
+ filterable = TRUE,
+ cell = function(value) {
+ if (value <= 7614) {
+ tags$span(class = "badge bg-primary", value)
+ } else if (value <= 15914) {
+ tags$span(class = "badge bg-secondary", value)
+ } else if (value <= 34152) {
+ tags$span(class = "badge bg-info", value)
+ } else {
+ tags$span(class = "badge bg-success", value)
+ }
+ }),
+ Geographic.Area = colDef(name = "Location", filterable = TRUE))))
+
+
downloadablePlot("examplePlot2",
ss_userAction.Log,
filenameroot = "plot2_ggplot",
diff --git a/tests/testthat/sample_app_right_sidebar/program/ui_body.R b/tests/testthat/sample_app_right_sidebar/program/ui_body.R
index e8a2df84..ede2f8f7 100644
--- a/tests/testthat/sample_app_right_sidebar/program/ui_body.R
+++ b/tests/testthat/sample_app_right_sidebar/program/ui_body.R
@@ -168,11 +168,11 @@ table_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$li("Module should be configured in both UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadableTableUI('exampleDT1',
list('csv', 'tsv'),
'Download table data'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadableTable('exampleDT1',
ss_userAction.Log,
'exampletable',
@@ -186,6 +186,48 @@ table_downloader_box <- box(
)
+
+react_table_box <- box(
+ id = "react_downloader",
+ title = "React Table Downloader",
+ status = "info",
+ solidHeader = TRUE,
+ collapsible = TRUE,
+ width = 12,
+ fluidRow(column(width = 6,
+ tags$dl(tags$dt("Features"),
+ tags$ul(tags$li("React table downloader module displays tabular data in rich formatted tables using the", tags$b("`reactable`"), "package"),
+ tags$li("downloadableReactTable returns a named reactive list that can be used in the application:",
+ tags$ul(tags$li(tags$b("selected_rows"), ": data.frame of current selected rows"),
+ tags$li(tags$b("table_state"), ": a list of the current table state"))),
+ tags$li("Table data can be downloaded in different formats such as: ", tags$b("'csv'"),
+ ", ", tags$b("'tsv'"), ", ", tags$b("'txt'"), "and/or ", tags$b("'xlsx'")),
+ tags$li("User can customize downloadableReactTable modules using reactable package options."),
+ tags$li("For more information about table options please visit the",
+ tags$a("Reactable documentation", target = "_blank", href = "https://glin.github.io/reactable/"),
+ "site")
+ ))),
+ column(width = 6,
+ tags$dl(tags$dt("Setup"),
+ tags$li("Module should be configured in both UI and Server code"),
+ tags$li("In the 'body_ui.R' add the following lines:",
+ blockQuote("downloadableReactTableUI('exampleReactTable',
+ 'Download react table data'))", color = "info")),
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
+ blockQuote("downloadableReactTable('exampleReactTable',
+ ss_userAction.Log,
+ 'exampletable',
+ list(csv = load_data3, tsv = load_data3))", color = "info")),
+ tags$li("Review ", tags$b("?downloadableReactTableUI"), " and ", tags$b("?downloadableReactTable"), " for more information"),
+ tags$li("Review below table for detailed example code")))),
+ fluidRow(column(width = 12,
+ downloadableReactTableUI(id = "exampleReactTable",
+ downloadtypes = list("csv", "tsv"),
+ hovertext = "Download react table data")))
+
+)
+
+
file_downloader_box <- box(
id = "file_downloader",
title = "File Downloader",
@@ -237,9 +279,9 @@ plot_downloader_box <- box(
column(width = 6,
tags$dl(tags$dt("Setup"),
tags$ul(tags$li("Module should be configured in both the UI and Server code"),
- tags$li("In your 'body_ui.R', place module UI part as follow: ",
+ tags$li("In the 'body_ui.R' add the following lines:",
blockQuote("downloadablePlotUI('myplotID', c('png', 'csv'), 'Download Plot or Data', '300px'))", color = "info")),
- tags$li("In your 'server_local.R', place module server part, ", tags$em("with the same id used with UI part"), ", as follow: ",
+ tags$li("In the 'server_local.R' add the following lines (make sure the two use the same ID):",
blockQuote("downloadablePlot('myplotID',
ss_userAction.Log,
filenameroot = 'mydownload1',
@@ -297,6 +339,7 @@ reset_application_box <- box(
periscope_modules <- tabItem(tabName = "periscope_modules",
+ react_table_box
table_downloader_box,
plot_downloader_box,
file_downloader_box,
diff --git a/tests/testthat/sample_app_right_sidebar/www/css/custom.css b/tests/testthat/sample_app_right_sidebar/www/css/custom.css
index 728be5f0..ec2f2a37 100644
--- a/tests/testthat/sample_app_right_sidebar/www/css/custom.css
+++ b/tests/testthat/sample_app_right_sidebar/www/css/custom.css
@@ -59,6 +59,11 @@ table.shiny-table {
float: left;
}
+/* Downloadable React Table */
+.periscope-downloadable-react-table-button {
+ display: inline-flex;
+}
+
/* Downloadable Plot */
.periscope-downloadable-plot { }
.periscope-downloadable-plot-button {
@@ -116,6 +121,27 @@ a:focus:not(.nav-link) {
color: #1F2D3D!important;
}
+/* downloadableReactTable Tooltip */
+.tooltip[data-tooltip-for="react-download-button"] .tooltip-inner {
+ background-color: #ffffff !important;
+ color: #212529 !important;
+ border: 1px solid #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::before {
+ border-top-color: #d1d5db !important;
+}
+
+.tooltip[data-tooltip-for="react-download-button"].bs-tooltip-top .arrow::after {
+ content: '';
+ position: absolute;
+ bottom: 1px;
+ left: 50%;
+ margin-left: -5px;
+ border-width: 5px;
+ border-style: solid;
+ border-color: #ffffff transparent transparent transparent;
+}
/* END of periscope2 basic CSS*/
/* ========================================================================== */
diff --git a/tests/testthat/sample_app_right_sidebar/www/js/custom.js b/tests/testthat/sample_app_right_sidebar/www/js/custom.js
index 728ebc18..a613b78a 100644
--- a/tests/testthat/sample_app_right_sidebar/www/js/custom.js
+++ b/tests/testthat/sample_app_right_sidebar/www/js/custom.js
@@ -20,6 +20,31 @@ setInterval(function() {
}, 100);
+function initializeReactTableTooltips() {
+ // Initialize all downloadable react table tooltips
+ $('.periscope-downloadable-react-table-button span.btn-group')
+ .tooltip()
+ .attr('data-tooltip-for', 'react-download-button');
+
+ // Add event handler only once
+ $(document).off('show.bs.tooltip.custom').on('show.bs.tooltip.custom', function(e) {
+ var $trigger = $(e.target);
+ var tooltipFor = $trigger.attr('data-tooltip-for');
+
+ if (tooltipFor) {
+ var tooltipInstance = $trigger.data('bs.tooltip');
+ var $tip = $(tooltipInstance.tip);
+ $tip.attr('data-tooltip-for', tooltipFor);
+ }
+ });
+}
+
+
+$(document).ready(function() {
+ initializeReactTableTooltips();
+});
+
+
// Resolve bs4Dash alert title and close button issues
Shiny.addCustomMessageHandler('pcreate-alert', function (message) {
// setup target
diff --git a/tests/testthat/setup.R b/tests/testthat/setup.R
index f4fdf5df..5c769262 100644
--- a/tests/testthat/setup.R
+++ b/tests/testthat/setup.R
@@ -11,3 +11,25 @@ if (interactive()) {
FUN = function(x) source(file.path(test_source_path, x))))
rm(test_source_path)
}
+
+
+reset_g_opts <- function() {
+ .g_opts$tt_image <- "img/tooltip.png"
+ .g_opts$tt_height <- "16px"
+ .g_opts$tt_width <- "16px"
+ .g_opts$datetime.fmt <- "%m-%d-%Y %H:%M"
+ .g_opts$log.formatter <- function(record) { paste0(record$logger, " [", record$timestamp, "] ", record$msg) }
+ .g_opts$loglevel <- "DEBUG"
+ .g_opts$app_title <- "Set using add_ui_header() in program/ui_header.R"
+ .g_opts$app_info <- NULL
+ .g_opts$app_version <- "1.0.0"
+ .g_opts$loading_indicator <- NULL
+ .g_opts$announcements_file <- NULL
+ .g_opts$data_download_types <- c("csv", "xlsx", "tsv", "txt")
+ .g_opts$plot_download_types <- c("png", "jpeg", "tiff", "bmp")
+ .g_opts$left_sidebar <- list(disable = TRUE)
+ .g_opts$body_elements <- c()
+ .g_opts$header <- NULL
+ .g_opts$right_sidebar <- NULL
+ .g_opts$footer <- NULL
+}
diff --git a/tests/testthat/test_download_file.R b/tests/testthat/test_download_file.R
index 3786dbdb..c7020b15 100644
--- a/tests/testthat/test_download_file.R
+++ b/tests/testthat/test_download_file.R
@@ -5,9 +5,9 @@ local_edition(3)
download_plot <- function() {
ggplot2::ggplot(data = mtcars, aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
@@ -21,11 +21,6 @@ download_data <- function() {
head(mtcars)
}
-download_data_show_row_names <- function() {
- attr(mtcars, "show_rownames") <- TRUE
- head(mtcars)
-}
-
download_string_list <- function() {
c("test1", "test2", "tests")
}
@@ -34,6 +29,18 @@ download_char_data <- function() {
"A123B"
}
+create_openxlsx2_wb <- function() {
+ openxlsx2::wb_workbook()$add_worksheet("openxlsx2_workbook")$add_data(x = download_data())
+}
+
+create_openxlsx_wb <- function() {
+ wb <- openxlsx::createWorkbook()
+ openxlsx::addWorksheet(wb, "openxlsx_workbook")
+ data <- as.data.frame(download_data())
+ openxlsx::writeData(wb, "openxlsx_workbook", data)
+ wb
+}
+
# UI Testing
test_that("downloadFileButton", {
file_btn <- downloadFileButton(id = "myid",
@@ -87,9 +94,11 @@ test_that("downloadFile_AvailableTypes", {
})
test_that("downloadFile - all download types", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
testServer(downloadFile,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "mydownload1",
+ row_names = FALSE,
datafxns = list(csv = download_data,
xlsx = download_data,
tsv = download_data,
@@ -99,19 +108,28 @@ test_that("downloadFile - all download types", {
tiff = download_plot,
bmp = download_plot)),
expr = {
- expect_snapshot_file(output$csv)
- expect_snapshot_file(output$tsv)
- expect_snapshot_file(output$txt)
- expect_true(file.exists(output$xlsx))
- expect_true(file.exists(output$png))
- expect_true(file.exists(output$jpeg))
- expect_true(file.exists(output$tiff))
- expect_true(file.exists(output$bmp))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.csv >",
+ x = capture_output(expect_snapshot_file(output$csv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.tsv >",
+ x = capture_output(expect_snapshot_file(output$tsv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.txt >",
+ x = capture_output(expect_snapshot_file(output$txt))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.png >",
+ x = capture_output(file.exists(output$png))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.jpeg >",
+ x = capture_output(file.exists(output$jpeg))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.tiff >",
+ x = capture_output(file.exists(output$tiff))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.bmp >",
+ x = capture_output(file.exists(output$bmp))))
})
})
test_that("downloadFile - lattice plot", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
testServer(downloadFile,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "mydownload1",
@@ -120,10 +138,14 @@ test_that("downloadFile - lattice plot", {
tiff = download_plot,
bmp = download_lattice_plot)),
expr = {
- expect_true(file.exists(output$png))
- expect_true(file.exists(output$jpeg))
- expect_true(file.exists(output$tiff))
- expect_true(file.exists(output$bmp))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.png >",
+ x = capture_output(expect_true(file.exists(output$png)))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.jpeg >",
+ x = capture_output(expect_true(file.exists(output$jpeg)))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.tiff >",
+ x = capture_output(expect_true(file.exists(output$tiff)))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < mydownload1.bmp >",
+ x = capture_output(expect_true(file.exists(output$bmp)))))
})
})
@@ -133,9 +155,20 @@ test_that("downloadFile - show rownames", {
testServer(downloadFile,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "show_row_names_download",
- datafxns = list(csv = download_data_show_row_names)),
+ row_names = TRUE,
+ datafxns = list(csv = download_data,
+ tsv = download_data,
+ txt = download_data,
+ xlsx = download_data)),
expr = {
- expect_snapshot_file(output$csv)
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < show_row_names_download.csv >",
+ x = capture_output(expect_snapshot_file(output$csv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < show_row_names_download.tsv >",
+ x = capture_output(expect_snapshot_file(output$tsv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < show_row_names_download.txt >",
+ x = capture_output(expect_snapshot_file(output$txt))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < show_row_names_download.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
})
})
@@ -143,35 +176,58 @@ test_that("downloadFile - download char data", {
testServer(downloadFile,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "my_char_download",
+ row_names = FALSE,
datafxns = list(txt = download_char_data,
tsv = download_char_data,
csv = download_char_data)),
expr = {
- expect_snapshot_file(output$txt)
- expect_snapshot_file(output$tsv)
- expect_snapshot_file(output$csv)
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < my_char_download.csv >",
+ x = capture_output(expect_snapshot_file(output$csv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < my_char_download.tsv >",
+ x = capture_output(expect_snapshot_file(output$tsv))))
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < my_char_download.txt >",
+ x = capture_output(expect_snapshot_file(output$txt))))
})
})
-test_that("downloadFile - download txt numeric data", {
+test_that("downloadFile - download numeric data", {
testServer(downloadFile,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "my_numeric_data",
- datafxns = list(txt = function() {123})),
+ datafxns = list(txt = function() {123},
+ csv = function() {123},
+ tsv = function() {123})),
expr = {
- expect_warning(output$txt, "txt could not be processed")
+ expect_warning(expect_true(grepl(
+ pattern = "INFO:actions:File downloaded in browser: < my_numeric_data.txt >",
+ x = capture_output(output$txt))), "txt could not be processed")
+ expect_true(grepl(
+ pattern = "INFO:actions:File downloaded in browser: < my_numeric_data.csv >",
+ x = capture_output(output$csv)))
+ expect_true(grepl(
+ pattern = "INFO:actions:File downloaded in browser: < my_numeric_data.tsv >",
+ x = capture_output(output$tsv)))
+
})
})
test_that("downloadFile - default values", {
testServer(downloadFile,
- args = list(datafxns = list(txt = function() {"123"})),
+ args = list(datafxns = list(txt = function() {"123"},
+ csv = function() {"123"},
+ tsv = function() {"123"})),
expr = {
- expect_snapshot_file(output$txt)
+ expect_true(grepl(pattern = "INFO::File downloaded in browser: < download.txt >",
+ x = capture_output(expect_snapshot_file(output$txt))))
+ expect_true(grepl(pattern = "INFO::File downloaded in browser: < download.csv >",
+ x = capture_output(expect_snapshot_file(output$csv))))
+ expect_true(grepl(pattern = "INFO::File downloaded in browser: < download.tsv >",
+ x = capture_output(expect_snapshot_file(output$tsv))))
})
})
test_that("downloadFile - invalid type", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
testServer(downloadFile,
args = list(datafxns = list(ttt = function() {"123"},
jeg = download_lattice_plot,
@@ -182,3 +238,71 @@ test_that("downloadFile - invalid type", {
expect_error(output$tff)
})
})
+
+# Testing for xlsx downloads
+test_that("Testing workbook openxlsx2", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ skip_if_not_installed("openxlsx2")
+ testServer(downloadFile,
+ args = list(logger = periscope2:::fw_get_user_log(),
+ filenameroot = "excel_test_openxlsx2_wb",
+ datafxns = list(xlsx = create_openxlsx2_wb)),
+ expr = {
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < excel_test_openxlsx2_wb.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ })
+})
+
+test_that("Testing workbook openxlsx", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ skip_if_not_installed("openxlsx")
+ testServer(downloadFile,
+ args = list(logger = periscope2:::fw_get_user_log(),
+ filenameroot = "excel_test_openxlsx_wb",
+ datafxns = list(xlsx = create_openxlsx_wb)),
+ expr = {
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < excel_test_openxlsx_wb.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ })
+})
+
+test_that("Dataframe xlsx download works with openxlsx2", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ skip_if_not_installed("openxlsx2")
+ testServer(downloadFile,
+ args = list(logger = periscope2:::fw_get_user_log(),
+ filenameroot = "excel_test_dataframe",
+ datafxns = list(xlsx = download_data)),
+ expr = {
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < excel_test_dataframe.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ })
+})
+
+test_that("Dataframe xlsx download works with openxlsx", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ skip_if_not_installed("openxlsx")
+ local_mocked_bindings(check_openxlsx2_availability = function() FALSE)
+ testServer(downloadFile,
+ args = list(logger = periscope2:::fw_get_user_log(),
+ filenameroot = "excel_test_dataframe",
+ datafxns = list(xlsx = download_data)),
+ expr = {
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < excel_test_dataframe.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ })
+})
+
+test_that("Dataframe xlsx download works with writexl", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ local_mocked_bindings(check_openxlsx2_availability = function() FALSE)
+ local_mocked_bindings(check_openxlsx_availability = function() FALSE)
+ testServer(downloadFile,
+ args = list(logger = periscope2:::fw_get_user_log(),
+ filenameroot = "excel_test_dataframe",
+ datafxns = list(xlsx = download_data)),
+ expr = {
+ expect_true(grepl(pattern = "INFO:actions:File downloaded in browser: < excel_test_dataframe.xlsx >",
+ x = capture_output(file.exists(output$xlsx))))
+ })
+})
diff --git a/tests/testthat/test_downloadable_plot.R b/tests/testthat/test_downloadable_plot.R
index 80fdda4d..82202f72 100644
--- a/tests/testthat/test_downloadable_plot.R
+++ b/tests/testthat/test_downloadable_plot.R
@@ -105,9 +105,9 @@ test_that("downloadablePlotUI invalid btn_valign", {
download_plot <- function() {
ggplot2::ggplot(data = download_data(), aes(x = wt, y = mpg)) +
geom_point(aes(color = cyl)) +
- theme(legend.justification = c(1, 1),
- legend.position = c(1, 1),
- legend.title = element_blank()) +
+ theme(legend.justification = c(1, 1),
+ legend.position.inside = c(1, 1),
+ legend.title = element_blank()) +
ggtitle("GGPlot Example w/Hover") +
xlab("wt") +
ylab("mpg")
@@ -118,6 +118,7 @@ download_data <- function() {
}
test_that("downloadablePlot", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
testServer(downloadablePlot,
args = list(logger = periscope2:::fw_get_user_log(),
filenameroot = "mydownload1",
@@ -141,6 +142,7 @@ test_that("downloadablePlot", {
test_that("downloadablePlot- default values", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
testServer(downloadablePlot,
args = list(visibleplot = download_plot),
expr = {
diff --git a/tests/testthat/test_downloadable_react_table.R b/tests/testthat/test_downloadable_react_table.R
new file mode 100644
index 00000000..bfe2f217
--- /dev/null
+++ b/tests/testthat/test_downloadable_react_table.R
@@ -0,0 +1,433 @@
+context("periscope2 - downloadable react table")
+local_edition(3)
+
+test_that("downloadableReactTableUI", {
+ table_ui <- downloadableReactTableUI(id = "myid",
+ downloadtypes = c("csv"),
+ hovertext = "myHoverText")
+ expect_equal(length(table_ui), 2)
+ expect_true(grepl('id="myid-reactTableButtonDiv"', table_ui[[1]], fixed = TRUE))
+ expect_true(grepl('title="myHoverText"', table_ui[[1]], fixed = TRUE))
+ expect_true(grepl('id="myid-reactTableButtonID-csv"', table_ui[[1]], fixed = TRUE))
+ expect_false(grepl('style="display:none">', table_ui[[1]], fixed = TRUE))
+ expect_true(grepl('id="myid-reactTableOutputID"', table_ui[[2]], fixed = TRUE))
+})
+
+
+test_that("downloadableReactTableUI - no download types", {
+ table_ui <- downloadableReactTableUI(id = "myid2")
+ expect_equal(length(table_ui), 2)
+ expect_true(grepl('id="myid2-reactTableButtonDiv"', table_ui[[1]], fixed = TRUE))
+ expect_true(grepl('style="display:none">', table_ui[[1]], fixed = TRUE))
+ expect_true(grepl('id="myid2-reactTableOutputID"', table_ui[[2]], fixed = TRUE))
+})
+
+
+# helper functions
+get_mtcars_data <- reactive({
+ head(mtcars)
+})
+
+
+test_that("downloadableReactTable - valid data", {
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data),
+ expr = {
+ expect_true(grepl(paste0(names(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ expect_false(grepl(paste0(rownames(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$mpg, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$cyl, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$disp, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$hp, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$drat, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$wt, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$qsec, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$vs, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$am, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$gear, collapse = "|"), output$reactTableOutputID))
+ expect_true(grepl(paste0(get_mtcars_data()$carb, collapse = "|"), output$reactTableOutputID))
+ })
+})
+
+
+test_that("downloadableReactTable - null or empty data.frame", {
+ no_table_data_error <- "'table_data' parameter must be a function or reactive expression."
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = NULL),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ }))
+ expect_true(grepl(no_table_data_error, server_error))
+
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = data.frame()),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ }))
+ expect_true(grepl(no_table_data_error, server_error))
+
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = NA),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ }))
+ expect_true(grepl(no_table_data_error, server_error))
+
+
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() { NULL }),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = shiny::reactiveVal(NULL)),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = shiny::reactiveVal(NA)),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() { data.frame() }),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = shiny::reactiveVal(data.frame())),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ })
+})
+
+
+test_that("downloadableReactTable - single values", {
+ no_table_data_error <- "'table_data' parameter must be a function or reactive expression."
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = 5),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ }))
+ expect_true(grepl(no_table_data_error, server_error))
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() {5}),
+ expr = {
+ expect_true(grepl('"table_data..":[5]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = shiny::reactiveVal(5)),
+ expr = {
+ expect_true(grepl('"table_data..":[5]', output$reactTableOutputID, fixed = TRUE))
+ })
+})
+
+
+test_that("downloadableReactTable - empty data.frame", {
+ no_table_data_error <- "'table_data' parameter must be a function or reactive expression."
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = data.frame(5)),
+ expr = {
+ expect_true(grepl('"x":null', output$reactTableOutputID, fixed = TRUE))
+ }))
+ expect_true(grepl(no_table_data_error, server_error))
+
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() {data.frame(5)}),
+ expr = {
+ expect_true(grepl('data":{"X5":[5]}', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = shiny::reactiveVal(data.frame(5))),
+ expr = {
+ expect_true(grepl('data":{"X5":[5]}', output$reactTableOutputID, fixed = TRUE))
+ })
+})
+
+
+test_that("downloadableReactTable - selection_mode", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "Single"),
+ expr = {
+ expect_true(grepl('"id":".selection"', output$reactTableOutputID, fixed = TRUE))
+ expect_true(grepl('"selection":"single"', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple"),
+ expr = {
+ expect_true(grepl('"id":".selection"', output$reactTableOutputID, fixed = TRUE))
+ expect_true(grepl('"selection":"multiple"', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "not_valid_mode"),
+ expr = {
+ expect_false(grepl('"id":".selection"', output$reactTableOutputID, fixed = TRUE))
+ expect_false(grepl('"selection""', output$reactTableOutputID, fixed = TRUE))
+ })
+})
+
+
+test_that("downloadableReactTable - pre_selected_rows", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ pre_selected_rows = function() {c(1, 3)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "'selection_mode' parameter must be either 'single' or 'multiple' to use 'pre_selected_rows' param. Setting default value NULL"
+ expect_true(grepl(error_msg, server_error))
+ })
+
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = c(1, 3)),
+ expr = {
+ output$reactTableOutputID
+ }))
+ expect_true(grepl("'pre_selected_rows' parameter must be a function or reactive expression. Setting default value NULL.", server_error))
+
+ server_error <- testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, "a")}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "'pre_selected_rows' parameter must be a function or reactive expression that returns numeric vector. Setting default value NULL."
+ expect_true(grepl(error_msg, server_error))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "single",
+ pre_selected_rows = function() {c(1, 3)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "when 'selection_mode' is 'single', only first value of 'pre_selected_rows' will be used"
+ expect_true(grepl(error_msg, server_error))
+ expect_true(grepl('"defaultSelected":[0]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "single",
+ pre_selected_rows = function() {c(1)}),
+ expr = {
+ expect_true(grepl('"defaultSelected":[0]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3)}),
+ expr = {
+ expect_true(grepl('"defaultSelected":[0,2]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 300)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "Excluding 'pre_selected_rows' value: 300 as it is out of range."
+ expect_true(grepl(error_msg, server_error))
+ expect_true(grepl('"defaultSelected":[0]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(-1, 2)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "Excluding 'pre_selected_rows' value: -1 as it is out of range."
+ expect_true(grepl(error_msg, server_error))
+ expect_true(grepl('"defaultSelected":[1]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(-1, 2, 4, 300)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "Excluding 'pre_selected_rows' values: -1, 300 as they are out of range."
+ expect_true(grepl(error_msg, server_error))
+ expect_true(grepl('"defaultSelected":[1,3]', output$reactTableOutputID, fixed = TRUE))
+ })
+
+ server_error <- capture_output(
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(-1, 300)}),
+ expr = {
+ expect_false(grepl('"defaultSelected"', output$reactTableOutputID, fixed = TRUE))
+ }), print = TRUE)
+ error_msg <- "All 'pre_selected_rows' values are out of range. Setting default value NULL."
+ expect_true(grepl(error_msg, server_error))
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ selection_mode = "single",
+ pre_selected_rows = function() {c(-1, 300)}),
+ expr = {
+ server_error <- capture_output(output$reactTableOutputID, print = TRUE)
+ error_msg <- "when 'selection_mode' is 'single', only first value of 'pre_selected_rows' will be used"
+ expect_true(grepl(error_msg, server_error))
+ expect_false(grepl('"defaultSelected"', output$reactTableOutputID, fixed = TRUE))
+ })
+})
+
+
+test_that("downloadableReactTable - file_name_root and download_data_fxns", {
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ download_data_fxns = list(csv = get_mtcars_data),
+ file_name_root = "test"),
+ expr = {
+ expect_true(grepl(paste0(names(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ download_data_fxns = list(csv = get_mtcars_data),
+ file_name_root = reactiveVal("test")),
+ expr = {
+ expect_true(grepl(paste0(names(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = get_mtcars_data,
+ download_data_fxns = list(csv = get_mtcars_data),
+ file_name_root = function() { "test" }),
+ expr = {
+ expect_true(grepl(paste0(names(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ })
+
+ server_warning <- capture_output(testServer(downloadableReactTable,
+ args = list(table_data = function() { "test" },
+ download_data_fxns = list(csv = get_mtcars_data),
+ file_name_root = NULL),
+ expr = {
+ expect_true(grepl(paste0(names(get_mtcars_data()), collapse = "|"), output$reactTableOutputID))
+ }), print = TRUE)
+
+ warn_msg <- "file_name_root' parameter should not be NULL. Setting default value 'data_file'"
+ expect_true(grepl(warn_msg, server_warning))
+})
+
+
+test_that("downloadableReactTable - table_options", {
+ testServer(downloadableReactTable,
+ args = list(table_data = function() { "test" },
+ table_options = list(showSortable = TRUE)),
+ expr = {
+ expect_true(grepl('"showSortable":true', output$reactTableOutputID))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() { "test" },
+ table_options = list("unnamed_option")),
+ expr = {
+ server_warning <- capture_output(output$reactTableOutputID, print = TRUE)
+ warn_msg <- "Excluding the following unnamed option(s): unnamed_option"
+ expect_true(grepl(warn_msg, server_warning, fixed = TRUE))
+ })
+
+ testServer(downloadableReactTable,
+ args = list(table_data = function() { "test" },
+ table_options = list(not_valid = "option")),
+ expr = {
+ server_warning <- capture_output(output$reactTableOutputID, print = TRUE)
+ warn_msg <- "Excluding the following invalid option(s): not_valid"
+ expect_true(grepl(warn_msg, server_warning, fixed = TRUE))
+ })
+
+ server_warning <- capture_output(testServer(
+ downloadableReactTable,
+ args = list(table_data = function() { "test" },
+ table_options = list(invalid = "option",
+ showSortable = TRUE,
+ invalid_2 = "option2",
+ "unnamed_option")),
+ expr = {
+ expect_true(grepl('"showSortable":true', output$reactTableOutputID))
+ }), print = TRUE)
+
+ warn_msg1 <- "Excluding the following unnamed option(s): unnamed_option"
+ warn_msg2 <- "Excluding the following invalid option(s): invalid, invalid_2"
+
+ expect_true(grepl(warn_msg1, server_warning, fixed = TRUE))
+ expect_true(grepl(warn_msg2, server_warning, fixed = TRUE))
+
+})
+
+
+test_that("downloadableReactTable - module return", {
+ skip_if(getRversion() < "4.1.0", "Skipping due to lifecycle warnings in R < 4.1.0")
+ local_mocked_bindings(
+ getReactableState = function(...) {
+ list(showSortable = TRUE,
+ defaultSelected = c(2, 3),
+ selected = c(2, 3))
+ },
+ .package = "reactable")
+
+ testServer(
+ downloadableReactTable,
+ args = list(table_data = function() { "test" }),
+ expr = {
+ result <- session$returned()
+ expect_equal(length(result), 2)
+ expect_true(all(c("selected_rows", "table_state") %in% names(result)))
+ expect_true(is.null(result$selected_rows))
+ })
+
+ local_mocked_bindings(
+ getReactableState = function(...) {
+ list(data = get_mtcars_data(),
+ showSortable = TRUE,
+ defaultSelected = c(2, 3),
+ selected = c(2, 3))
+ },
+ .package = "reactable")
+
+
+ testServer(
+ downloadableReactTable,
+ args = list(table_data = get_mtcars_data),
+ expr = {
+ result <- session$returned()
+ expect_equal(length(result), 2)
+ expect_true(all(c("selected_rows", "table_state") %in% names(result)))
+ expect_true(NROW(result$selected_rows) == 2)
+ expect_true(all(c("Mazda RX4 Wag", "Datsun 710") %in% rownames(result$selected_rows)))
+ })
+
+})
+
+
diff --git a/tests/testthat/test_downloadable_table.R b/tests/testthat/test_downloadable_table.R
index 9ea3cafe..d4174086 100644
--- a/tests/testthat/test_downloadable_table.R
+++ b/tests/testthat/test_downloadable_table.R
@@ -125,41 +125,57 @@ test_that("downloadableTable - invalid_selection", {
test_that("downloadableTable - filenameroot", {
- testServer(downloadableTable,
- args = list(filenameroot = "test",
- downloaddatafxns = list(csv = data),
- tabledata = data),
- expr = {
- selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
- expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
- })
+ expect_message(
+ testServer(downloadableTable,
+ args = list(filenameroot = "test",
+ downloaddatafxns = list(csv = data),
+ tabledata = data),
+ expr = {
+ selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
+ expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
+ }),
+ regexp = "Could not apply DT options due to.*selection.*argument is incorrect",
+ class = "message"
+ )
- testServer(downloadableTable,
- args = list(filenameroot = reactiveVal("test"),
- downloaddatafxns = list(csv = data),
- tabledata = data),
- expr = {
- selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
- expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
- })
+ expect_message(
+ testServer(downloadableTable,
+ args = list(filenameroot = reactiveVal("test"),
+ downloaddatafxns = list(csv = data),
+ tabledata = data),
+ expr = {
+ selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
+ expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
+ }),
+ regexp = "Could not apply DT options due to.*selection.*argument is incorrect",
+ class = "message"
+ )
- testServer(downloadableTable,
- args = list(filenameroot = function(){"test"},
- downloaddatafxns = list(csv = data),
- tabledata = data),
- expr = {
- selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
- expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
- })
+ expect_message(
+ testServer(downloadableTable,
+ args = list(filenameroot = function(){"test"},
+ downloaddatafxns = list(csv = data),
+ tabledata = data),
+ expr = {
+ selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
+ expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
+ }),
+ regexp = "Could not apply DT options due to.*selection.*argument is incorrect",
+ class = "message"
+ )
- testServer(downloadableTable,
- args = list(filenameroot = NULL,
- downloaddatafxns = list(csv = data),
- tabledata = data),
- expr = {
- selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
- expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
- })
+ expect_message(
+ testServer(downloadableTable,
+ args = list(filenameroot = NULL,
+ downloaddatafxns = list(csv = data),
+ tabledata = data),
+ expr = {
+ selected <- '"selection":{"mode":"multiple","selected":null,"target":"row","selectable":null}'
+ expect_true(grepl(selected, output$dtableOutputID, fixed = TRUE))
+ }),
+ regexp = "Could not apply DT options due to.*selection.*argument is incorrect",
+ class = "message"
+ )
})
test_that("downloadableTable - no downloads", {
diff --git a/tests/testthat/test_log_viewer.R b/tests/testthat/test_log_viewer.R
index 86036c61..66e8c4cd 100644
--- a/tests/testthat/test_log_viewer.R
+++ b/tests/testthat/test_log_viewer.R
@@ -7,11 +7,7 @@ sample_log <- function(){
"actions [2022-02-19 14:04:32] Application Reset requested by user. Resetting in 5 seconds")
}
-null_log <- function(){
- NULL
-}
-
-empty_log <- function(){
+null_log <- function() {
NULL
}
@@ -26,24 +22,15 @@ test_that("logViewer - valid sample log", {
testServer(logViewer,
args = list(id = "myid", logger = sample_log),
expr = {
- expect_snapshot_output(output$myid)
+ expect_snapshot_output(output$"myid-reactTableOutputID")
})
})
-test_that("logViewer - null sample log", {
+test_that("logViewer - null log", {
testServer(logViewer,
args = list(id = "nullLogger", logger = null_log),
expr = {
- expect_null(output$nullLogger)
- })
-})
-
-
-test_that("logViewer - empty sample log", {
- testServer(logViewer,
- args = list(id = "emptyLogger", logger = empty_log),
- expr = {
- expect_null(output$emptyLogger)
+ expect_true(grepl('"x":null', output$"nullLogger-reactTableOutputID", fixed = TRUE))
})
})
diff --git a/tests/testthat/test_logger.R b/tests/testthat/test_logger.R
index c4821953..c974e778 100644
--- a/tests/testthat/test_logger.R
+++ b/tests/testthat/test_logger.R
@@ -1,10 +1,12 @@
context("periscope2 - logging functionality")
-writeToConsole <- periscope2:::writeToConsole
-writeToFile <- periscope2:::writeToFile
-loglevels <- periscope2:::loglevels
-test_file_name <- file.path(tempdir(), c("1", "2", "3"))
+writeToConsole <- periscope2:::writeToConsole
+writeToFile <- periscope2:::writeToFile
+loglevels <- periscope2:::loglevels
+set_app_parameters <- periscope2:::set_app_parameters
+test_file_name <- file.path(tempdir(), c("1", "2", "3"))
+test_file_log <- file.path(tempdir(), "test_log.txt")
env_setup <- function() {
test_env <- new.env(parent = emptyenv())
@@ -110,8 +112,8 @@ test_that("UpdateOptions - updateOptions()", {
periscope2:::logReset()
periscope2:::basicConfig()
- periscope2:::updateOptions.character("", level = "WARN")
- expect_equal(periscope2:::getLogger()$getLevel(), loglevels["WARN"])
+ periscope2:::updateOptions.character("", level = "WARNING")
+ expect_equal(periscope2:::getLogger()$getLevel(), loglevels["WARNING"])
})
test_that("LoggingToConsole", {
@@ -122,8 +124,10 @@ test_that("LoggingToConsole", {
periscope2:::addHandler(writeToConsole, level = "DEBUG")
expect_equal(with(periscope2:::getLogger(), names(handlers)), c("basic.stdout", "writeToConsole"))
- logdebug("log generated for testing")
- loginfo("log generated for testing")
+ expect_true(grepl(pattern = "DEBUG::log generated for testing",
+ x = capture_output(logdebug("log generated for testing"), print = TRUE)))
+ expect_true(grepl(pattern = "INFO::log generated for testing",
+ x = capture_output(loginfo("log generated for testing"), print = TRUE)))
succeed()
})
@@ -207,3 +211,108 @@ test_that("MsgComposer function - defaultMsgCompose()",{
expect_equal(periscope2:::defaultMsgCompose(msg = paste(rep(LETTERS, 316), collapse = "")),
paste(rep(LETTERS, 316), collapse = ""))
})
+
+# Testing logging levels
+test_that("DEBUG level shows all messages", {
+ set_app_parameters(log_level = "DEBUG")
+ periscope2:::addHandler(writeToConsole)
+ expect_output(logdebug("debug message"), "DEBUG::debug message")
+ expect_output(loginfo("info message"), "INFO::info message")
+ expect_output(logwarn("warn message"), "WARNING::warn message")
+ expect_output(logerror("error message"), "ERROR::error message")
+})
+I
+test_that("INFO level filters DEBUG", {
+ set_app_parameters(log_level = "INFO")
+ periscope2:::addHandler(writeToConsole)
+ expect_silent(logdebug("debug message"))
+ expect_output(loginfo("info message"), "INFO::info message")
+ expect_output(logwarn("warn message"), "WARNING::warn message")
+ expect_output(logerror("error message"), "ERROR::error message")
+})
+
+test_that("WARNING level filters DEBUG and INFO", {
+ set_app_parameters(log_level = "WARNING")
+ periscope2:::addHandler(writeToConsole)
+ expect_silent(logdebug("debug message"))
+ expect_silent(loginfo("info message"))
+ expect_output(logwarn("warn message"), "WARNING::warn message")
+ expect_output(logerror("error message"), "ERROR::error message")
+})
+
+test_that("ERROR level filters all but ERROR", {
+ set_app_parameters(log_level = "ERROR")
+ periscope2:::addHandler(writeToConsole)
+ expect_silent(logdebug("debug message"))
+ expect_silent(loginfo("info message"))
+ expect_silent(logwarn("warn message"))
+ expect_output(logerror("error message"), "ERROR::error message")
+})
+
+test_that("File logging level DEBUG", {
+ unlink(test_file_log, force = TRUE)
+ set_app_parameters(log_level = "DEBUG")
+ periscope2:::addHandler(writeToFile, file = test_file_log)
+
+ expect_output(logdebug("debug message"), "debug message")
+ expect_output(loginfo("info message"), "info message")
+ expect_output(logwarn("warn message"), "warn message")
+ expect_output(logerror("error message"), "error message")
+
+ log_content <- readLines(test_file_log)
+ expect_true(any(grepl("debug message", log_content)))
+ expect_true(any(grepl("info message", log_content)))
+ expect_true(any(grepl("warn message", log_content)))
+ expect_true(any(grepl("error message", log_content)))
+})
+
+test_that("File logging level INFO", {
+ unlink(test_file_log, force = TRUE)
+ set_app_parameters(log_level = "INFO")
+ periscope2:::addHandler(writeToFile, file = test_file_log)
+
+ logdebug("debug message")
+ expect_output(loginfo("info message"), "info message")
+ expect_output(logwarn("warn message"), "warn message")
+ expect_output(logerror("error message"), "error message")
+
+ log_content <- readLines(test_file_log)
+ expect_false(any(grepl("debug message", log_content)))
+ expect_true(any(grepl("info message", log_content)))
+ expect_true(any(grepl("warn message", log_content)))
+ expect_true(any(grepl("error message", log_content)))
+})
+
+test_that("File logging level WARNING", {
+ unlink(test_file_log, force = TRUE)
+ set_app_parameters(log_level = "WARNING")
+ periscope2:::addHandler(writeToFile, file = test_file_log)
+
+ logdebug("debug message")
+ loginfo("info message")
+ expect_output(logwarn("warn message"), "warn message")
+ expect_output(logerror("error message"), "error message")
+
+ log_content <- readLines(test_file_log)
+ expect_false(any(grepl("debug message", log_content)))
+ expect_false(any(grepl("info message", log_content)))
+ expect_true(any(grepl("warn message", log_content)))
+ expect_true(any(grepl("error message", log_content)))
+})
+
+test_that("File logging level ERROR", {
+ unlink(test_file_log, force = TRUE)
+ set_app_parameters(log_level = "ERROR")
+ periscope2:::addHandler(writeToFile, file = test_file_log)
+
+ logdebug("debug message")
+ loginfo("info message")
+ logwarn("warn message")
+ expect_output(logerror("error message"), "error message")
+
+ log_content <- readLines(test_file_log)
+ expect_false(any(grepl("debug message", log_content)))
+ expect_false(any(grepl("info message", log_content)))
+ expect_false(any(grepl("warn message", log_content)))
+ expect_true(any(grepl("error message", log_content)))
+})
diff --git a/tests/testthat/test_ui_functions.R b/tests/testthat/test_ui_functions.R
index c06bbe67..34d53151 100644
--- a/tests/testthat/test_ui_functions.R
+++ b/tests/testthat/test_ui_functions.R
@@ -1,9 +1,11 @@
context("periscope2 - UI functionality")
local_edition(3)
+loglevels <- periscope2:::loglevels
+set_app_parameters <- periscope2:::set_app_parameters
# helper functions
create_announcements <- function(start_date = NULL,
- end_data = NULL,
+ end_date = NULL,
start_date_format = NULL,
end_date_format = NULL,
style = NULL,
@@ -13,7 +15,7 @@ create_announcements <- function(start_date = NULL,
appTemp <- tempfile(pattern = "TestThatApp", tmpdir = appTemp_dir)
announcements_file <- paste0(gsub('\\\\|/', '', (gsub(appTemp_dir, "", appTemp, fixed = TRUE))), ".yaml")
yaml::write_yaml(list("start_date" = start_date,
- "end_date" = end_data,
+ "end_date" = end_date,
"start_date_format" = start_date_format,
"end_date_format" = end_date_format,
"style" = style,
@@ -34,8 +36,10 @@ test_that("add_ui_header - no header", {
})
test_that("set_app_parameters default values", {
+ reset_g_opts()
expect_equal(shiny::isolate(periscope2:::.g_opts$app_title), "Set using add_ui_header() in program/ui_header.R")
expect_null(shiny::isolate(periscope2:::.g_opts$app_info), NULL)
+
expect_equal(shiny::isolate(periscope2:::.g_opts$loglevel), "DEBUG")
expect_equal(shiny::isolate(periscope2:::.g_opts$app_version), "1.0.0")
expect_null(shiny::isolate(periscope2:::.g_opts$loading_indicator))
@@ -100,7 +104,7 @@ test_that("add_ui_header - ui element", {
# busy indicator - title - UI elements (center as well)
expect_warning(periscope2::add_ui_header(ui_elements = menu,
- ui_position = "center"),
+ ui_position = "center"),
regexp = "title_position cannot be equal to ui_position")
header <- shiny::isolate(periscope2:::.g_opts$header)
@@ -140,8 +144,8 @@ test_that("add_ui_header - ui element", {
# busy indicator - title positions is NULL- UI elements position is center
warn_msgs <- capture_warnings(periscope2::add_ui_header(ui_elements = menu,
- ui_position = "center",
- title_position = NULL))
+ ui_position = "center",
+ title_position = NULL))
expect_equal("title_position must be on of 'left', 'center'or 'right' values. Setting default value 'center'",
warn_msgs[1])
expect_equal("title_position cannot be equal to ui_position. Setting default values",
@@ -406,7 +410,8 @@ test_that("load_announcements empty file", {
announcements_file <- paste0(gsub('\\\\|/', '', (gsub(appTemp_dir, "", appTemp, fixed = TRUE))), ".yaml")
yaml::write_yaml("", announcements_file)
- expect_null(load_announcements(announcements_file_path = announcements_file))
+ output_msg <- capture_output(expect_null(load_announcements(announcements_file_path = announcements_file)))
+ expect_true(grepl('Announcements will be ignored', output_msg, fixed = TRUE))
unlink(announcements_file, TRUE)
})
@@ -418,33 +423,56 @@ test_that("load_announcements - parsing error", {
cat(":", file = (con <- file(announcements_file, "w", encoding = "UTF-8")))
close(con)
- expect_warning(load_announcements(announcements_file_path = announcements_file),
- regexp = "[(Could not parse TestThatApp)]")
+ output_msg <- capture_output(expect_warning(load_announcements(announcements_file_path = announcements_file),
+ regexp = "[(Could not parse TestThatApp)]"))
+ expect_true(grepl('Parser error', output_msg, fixed = TRUE))
unlink(announcements_file, TRUE)
})
test_that("load_announcements function parameters", {
expect_null(create_announcements(start_date = "2222-11-26",
- end_data = "2222-12-26"))
- expect_null(create_announcements(start_date = "2022-11-26",
- end_data = "2222-12-26",
- style = "not-style"))
- expect_null(create_announcements(start_date = "11-26-2222",
- end_data = "12-26-2222",
- start_date_format = "%m-%d-%Y",
- end_date_format = "%m-%d-%Y"))
- expect_null(create_announcements(start_date = "11-26-2222",
- end_data = "12-26-2222",
- end_date_format = "%m-%d-%Y"))
- expect_null(create_announcements(start_date = "11-26-2222",
- end_data = "12-26-2222",
- start_date_format = "%m-%d-%Y"))
+ end_date = "2222-12-26"))
+ output_msg <- capture_output(expect_null(
+ create_announcements(start_date = "2022-11-26",
+ end_date = "2222-12-26",
+ style = "not-style")))
+ expect_true(grepl("Announcement 'style' must be one of info, danger, success, warning, primary",
+ output_msg, fixed = TRUE))
+ expect_null(
+ create_announcements(start_date = "11-26-2222",
+ end_date = "12-26-2222",
+ start_date_format = "%m-%d-%Y",
+ end_date_format = "%m-%d-%Y"))
+
+ output_msg <- capture_output(expect_null(
+ create_announcements(start_date = "11-26-2222",
+ end_date = "12-26-2222",
+ end_date_format = "%m-%d-%Y")))
+ expect_true(grepl("All formats failed to parse. No formats found",
+ output_msg, fixed = TRUE))
+
+ output_msg <- capture_output(expect_null(
+ create_announcements(start_date = "11-26-2222",
+ end_date = "12-26-2222",
+ start_date_format = "%m-%d-%Y")))
+ expect_true(grepl("All formats failed to parse. No formats found",
+ output_msg, fixed = TRUE))
+
expect_null(create_announcements(start_date = "11-26-2222",
start_date_format = "%m-%d-%Y"))
- expect_null(create_announcements(style = "info"))
- expect_null(create_announcements(style = "info",
- text = "text",
- auto_close = "abc"))
+ expect_true(grepl("All formats failed to parse. No formats found",
+ output_msg, fixed = TRUE))
+
+ output_msg <- capture_output(expect_null(create_announcements(style = "info")))
+ expect_true(grepl("Announcement 'text' value is empty. It must contain non empty text value",
+ output_msg, fixed = TRUE))
+
+ output_msg <- capture_output(expect_null(
+ create_announcements(style = "info",
+ text = "text",
+ auto_close = "abc")))
+ expect_true(grepl("Announcement 'auto_close' value ' abc ' is invalid",
+ output_msg, fixed = TRUE))
})
test_that("load_theme_settings - null settings", {
@@ -504,20 +532,6 @@ test_that("theme - invalid color", {
})
-# test_that("theme - invalid width", {
-# theme_settings <- yaml::read_yaml(system.file("fw_templ", "p_example", "periscope_style.yaml", package = "periscope2"))
-# dir.create("www")
-# theme_settings[["sidebar_width"]] <- "300"
-# theme_settings[["control_sidebar_width"]] <- "-300"
-#
-# yaml::write_yaml(theme_settings, "www/periscope_style.yaml")
-# expect_warning(nchar(create_theme()),
-# regexp = "invalid theme settings -300 must be positive value. Setting default value")
-# unlink("www/periscope_style.yaml")
-# unlink("www", recursive = TRUE)
-# })
-
-
test_that("dashboard - create default dashboard", {
expect_snapshot(periscope2:::create_application_dashboard())
})
diff --git a/vignettes/announcement-module.Rmd b/vignettes/announcement-module.Rmd
index fdc59c16..5462f25a 100644
--- a/vignettes/announcement-module.Rmd
+++ b/vignettes/announcement-module.Rmd
@@ -96,3 +96,4 @@ runApp(paste(app_dir, 'mysampleapp', sep = .Platform$file.sep))
* [logViewer Module](logViewer-module.html)
* [applicationReset Module](applicationReset-module.html)
* [Theme Configuration Builder](themeBuilder_addin.html)
+* [downloadableReactTable Module](downloadableReactTable-module.html)
diff --git a/vignettes/announcement_addin.Rmd b/vignettes/announcement_addin.Rmd
index b483bb9d..00fd9067 100644
--- a/vignettes/announcement_addin.Rmd
+++ b/vignettes/announcement_addin.Rmd
@@ -144,3 +144,4 @@ For detailed usage for that file refer to [announcement Module](announcement-mod
* [logViewer Module](logViewer-module.html)
* [applicationReset Module](applicationReset-module.html)
* [Theme Configuration Builder](themeBuilder_addin.html)
+* [downloadableReactTable Module](downloadableReactTable-module.html)
diff --git a/vignettes/applicationReset-module.Rmd b/vignettes/applicationReset-module.Rmd
index 41973313..4d26d750 100644
--- a/vignettes/applicationReset-module.Rmd
+++ b/vignettes/applicationReset-module.Rmd
@@ -117,3 +117,4 @@ runApp(paste(app_dir, 'mysampleapp', sep = .Platform$file.sep))
* [announcement Module](announcement-module.html)
* [Announcement Configuration Builder](announcement_addin.html)
* [Theme Configuration Builder](themeBuilder_addin.html)
+* [downloadableReactTable Module](downloadableReactTable-module.html)
diff --git a/vignettes/downloadFile-module.Rmd b/vignettes/downloadFile-module.Rmd
index bf6f5e79..81d32475 100644
--- a/vignettes/downloadFile-module.Rmd
+++ b/vignettes/downloadFile-module.Rmd
@@ -90,6 +90,9 @@ downloadFileButton(id = "object_id2",
The **downloadFile** function is called directly. The call consists of the following:
+**Note on Excel file support:** For xlsx files, the module will first attempt to use `openxlsx2` if available, then fall back to `openxlsx`, and finally use `writexl` if neither is available. We recommend `openxlsx2` for best performance with Excel files.
+
+
* the unique object ID that was provided to downloadFileButton when creating
the UI object
* the logging logger to be used
@@ -154,3 +157,4 @@ runApp(paste(app_dir, 'mysampleapp', sep = .Platform$file.sep))
* [announcement Module](announcement-module.html)
* [Announcement Configuration Builder](announcement_addin.html)
* [Theme Configuration Builder](themeBuilder_addin.html)
+* [downloadableReactTable Module](downloadableReactTable-module.html)
diff --git a/vignettes/downloadablePlot-module.Rmd b/vignettes/downloadablePlot-module.Rmd
index af4799b1..5652b334 100644
--- a/vignettes/downloadablePlot-module.Rmd
+++ b/vignettes/downloadablePlot-module.Rmd
@@ -151,3 +151,4 @@ downloadablePlot(id = "object_id1",
* [announcement Module](announcement-module.html)
* [Announcement Configuration Builder](announcement_addin.html)
* [Theme Configuration Builder](themeBuilder_addin.html)
+* [downloadableReactTable Module](downloadableReactTable-module.html)
diff --git a/vignettes/downloadableReactTable-module.Rmd b/vignettes/downloadableReactTable-module.Rmd
new file mode 100644
index 00000000..e68a38cd
--- /dev/null
+++ b/vignettes/downloadableReactTable-module.Rmd
@@ -0,0 +1,165 @@
+---
+title: "Using downloadableReactTable Shiny Module"
+author: "Mohammed Ali"
+date: "`r Sys.Date()`"
+output:
+ rmarkdown::html_vignette:
+ toc: TRUE
+ toc_depth: 3
+vignette: >
+ %\VignetteIndexEntry{Using downloadableReactTable Shiny Module}
+ %\VignetteEngine{knitr::rmarkdown}
+ %\VignetteEncoding{UTF-8}
+---
+
+# Overview
+
+## Purpose
+The document explains how to use **downloadableReactTable** shiny module in periscope2 applications.
+
+## Features
+* Ability to display and download datasets.
+* Table rows selection can be multiple, single or none (the default)
+ * When selection mode is enabled an additional column will be added to the table
+ * The selection controls will be radio buttons for single row selection and checkboxes for "multiple" rows selection mode
+* Returns a reactive expression containing named list with two elements: **selected_rows** and **table_state**
+* Supports full-table searching including regular expressions
+* Columns are sort-able in both directions
+* Configurable table "window" (viewing area) height with infinite vertical
+scrolling (no paging by default)
+* Supports rownames
+* Requires minimal code (see the Usage section for details)
+* Uses **downloadFile** Shiny Module functionality to ensure consistent
+download functionality for table data.
+* **downloadFile** button will be hidden if `downloadableReactTable` parameter `download_data_fxns` or
+`downloadableReactTableUI` parameter `downloadtypes` is empty
+
+# Usage
+
+## Shiny Module Overview
+Shiny modules consist of a pair of functions that modularize, or package, a small piece of reusable functionality. The UI function is called directly by the user to place the UI in the correct location (as with other shiny UI objects). The module server function that is called only once to set it up using the module name as a function inside the server function (i.e. user-local session scope. The first function argument is a string that represents the module id (the same id used in module UI function). Additional arguments can be supplied by the user based on the specific shiny module that is called. There can be additional helper functions that are a part of a shiny module.
+
+The **downloadableReactTable** Shiny Module is a part of the *periscope2* package and
+consists of the following functions:
+
+* **downloadableReactTableUI** - the UI function to place the table in the application
+* **downloadableReactTable** - the server function to be called inside server_local.R.
+
+## downloadableReactTableUI
+
+The **downloadableReactTableUI** function is called from the ui.R (or equivalent)
+file in the location where the table should be placed. This is similar to other
+UI element placement in shiny.
+
+The downloadableReactTableUI looks like:
+
+
applicationReset-module.RmddownloadFile-module.RmddownloadablePlot-module.Rmd
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Using downloadableReactTable Shiny Module
+Mohammed +Ali
+ +2025-09-02
+ + Source:vignettes/downloadableReactTable-module.Rmd
+ downloadableReactTable-module.Rmd
+
+Overview +
+
+
+Purpose +
+The document explains how to use +downloadableReactTable shiny module in periscope2 +applications.
+
+
+Features +
+-
+
- Ability to display and download datasets. +
- Table rows selection can be multiple, single or none (the default)
+
-
+
- When selection mode is enabled an additional column will be added to +the table +
- The selection controls will be radio buttons for single row +selection and checkboxes for “multiple” rows selection mode +
+ - Returns a reactive expression containing named list with two +elements: selected_rows and +table_state + +
- Supports full-table searching including regular expressions +
- Columns are sort-able in both directions +
- Configurable table “window” (viewing area) height with infinite +vertical scrolling (no paging by default) +
- Supports rownames +
- Requires minimal code (see the Usage section for details) +
- Uses downloadFile Shiny Module functionality to +ensure consistent download functionality for table data. +
-
+downloadFile button will be hidden if
+
downloadableReactTableparameter +download_data_fxnsordownloadableReactTableUI+parameterdownloadtypesis empty
+
+
+
+ Usage +
+
+
+Shiny Module Overview +
+Shiny modules consist of a pair of functions that modularize, or +package, a small piece of reusable functionality. The UI function is +called directly by the user to place the UI in the correct location (as +with other shiny UI objects). The module server function that is called +only once to set it up using the module name as a function inside the +server function (i.e. user-local session scope. The first function +argument is a string that represents the module id (the same id used in +module UI function). Additional arguments can be supplied by the user +based on the specific shiny module that is called. There can be +additional helper functions that are a part of a shiny module.
+The downloadableReactTable Shiny Module is a part of +the periscope2 package and consists of the following +functions:
+-
+
- +downloadableReactTableUI - the UI function to place +the table in the application +
- +downloadableReactTable - the server function to be +called inside server_local.R. +
+
+
+
+
+
+downloadableReactTableUI +
+The downloadableReactTableUI function is called from +the ui.R (or equivalent) file in the location where the table should be +placed. This is similar to other UI element placement in shiny.
+The downloadableReactTableUI looks like:
+
+The downloadableReactTableUI function takes the unique object ID for +the UI object.
+The next two arguments (downloadtypes and hovertext) are passed to +the downloadFileButton and set the file types the button will allow the +user to request and the downloadFileButton’s tooltip text.
+
+# Inside ui_body.R or ui_sidebar.R
+
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")
+
+
+downloadableReactTable +
+The downloadableReactTable function is called +directly. The call consists of the following:
+-
+
- the unique object ID that was provided to downloadableTableUI when +creating the UI object +
- the logging logger to be used +
- +file_name_root is an optional character, function +or reactive expression providing downloadable file name +
- the root (prefix) of the downloaded file name to be used in the +browser as a character string or a reactive expression that returns a +character string +
-
+download_data_fxns named list of functions or
+reactive expressions that provide the data to the downloadFileButton
+(see below).
+
-
+
- It is important that the types of files to be downloaded are matched
+to the correct data function in the list.
+
+ - The function/reactive expression names are unquoted - they will be +called at the time the user initiates a download (see requirements +below). +
- The download functions or reactive expressions can all be the same +or different from each other and/or the one provided to +table_data. This allows finer control over what the +user can view vs. download if desired. For example you can allow a user +to view a smaller subset of data but download an expanded dataset, or +perhaps download a redacted version of data, etc. +
+ - It is important that the types of files to be downloaded are matched
+to the correct data function in the list.
- This module also supports most of reactable table options for +further customization. See the example below. +
Data Function or Reactive Expression +Requirements
+-
+
- If a function is provided it must be parameter-less (require NO +parameters). No parameters will be provided when a function is called to +retrieve the plot or data. Reactive expressions cannot take parameters +by definition. +
- The function or reactive expression must return an appropriate data +format for the file type. +
- For instance: csv/tsv/xlsx types require data that is convertible to +a tabular type, to various download types see the downloadFile module +help or vignette. +
- For the visible table data the return value must be able to be +converted to tabular format +
- Since the function or reactive expression is called at the time the +user requests the data it is recommended that reactive expressions are +used to provide dynamic values from the application to create the +table. +
Reactive Return Value
+-
+
- The server function returns a reactive expression containing named
+list with two elements:
+
-
+
- +selected_rows: data.frame of current selected +rows. +
+* Note that this is the data, not references, rownumbers, etc from the table -- it is the actual, visible, table row data. This allows the developer to use this more easily to update another table, chart, etc. as desired.-
+
- +table_state: a list of the current table state. The +list keys are (“page”, “pageSize”, “pages”, “sorted” and +“selected”) +
+ - It is acceptable to ignore the return value as well if this +functionality is not needed. Simply do not assign the result to a +variable. +
Customization Options
+downloadableReactTable module can be customized using
+reactable function arguments(see ?reactable::reactable).
+These options can be sent as a named options via the server function,
+see example below.
+# Inside server_local.R
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ showSortable = TRUE,
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+
+# NOTE: table_state is the reactive return value, captured for later use
+
+
+Sample Application +
+For a complete running shiny example application using the +downloadableReactTable module you can create and run a +periscope2 sample application using:
+
+library(periscope2)
+
+app_dir = tempdir()
+create_new_application(name = 'mysampleapp', location = app_dir, sample_app = TRUE)
+runApp(paste(app_dir, 'mysampleapp', sep = .Platform$file.sep))downloadableTable-module.RmdlogViewer-module.Rmd-
+
- “DEBUG” will log logdebug, loginfo, logwarn, and logerror +messages +
- “INFO” will log loginfo, logwarn, and logerror messages +
- “WARNING” will log logwarn and logerror messages +
- “ERROR” will log logerror messages +
Additional ResourcesTheme Configuration Builder +
Creating a new framework-based application
Dr. Connie Brett
-2025-04-14
+2025-09-02
Source:vignettes/new-application.Rmd
new-application.Rmdwww/img Builder
themeBuilder_addin.Rmdperiscope2 0.2.4
+periscope2 0.3.0
+
+
+New Features
+- Added new module ?downloadableReactTable based on reactable package and downloadFile module +
+
+Enhancements
+- Added openxlsx2 support while keeping openxlsx to support legacy apps and backwards compatibility. writexl package is used as last resort. +
- Updated ?logViewerOutput module to display log data using ?downloadableReactTable. +
- Added loglevel filtering according to level chosen- Added loglevel filtering according to level chosen +
- Added new feature to ?downloadFile module to control whether row names are to be written for tabular data. +
periscope2 0.2.42025-04-14
Enhancements
- Updated
set_app_parametersmethod documentation to displayed html tags correctly
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index ae405c81..a7c6f493 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -6,10 +6,11 @@ articles:
announcement-module: announcement-module.html
applicationReset-module: applicationReset-module.html
downloadablePlot-module: downloadablePlot-module.html
+ downloadableReactTable-module: downloadableReactTable-module.html
downloadableTable-module: downloadableTable-module.html
downloadFile-module: downloadFile-module.html
logViewer-module: logViewer-module.html
migrate_to_v0_2_0: migrate_to_v0_2_0.html
new-application: new-application.html
themeBuilder_addin: themeBuilder_addin.html
-last_built: 2025-04-14T11:09Z
+last_built: 2025-09-03T05:05Z
diff --git a/docs/reference/add_ui_body.html b/docs/reference/add_ui_body.html
index c221244a..519d77f1 100644
--- a/docs/reference/add_ui_body.html
+++ b/docs/reference/add_ui_body.html
@@ -18,7 +18,7 @@
# sample app named 'mytestapp' created in a temp dir
location <- tempdir()
create_application(name = 'mytestapp', location = location, sample_app = TRUE)
-#> periscope2 application mytestapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application mytestapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/mytestapp'), TRUE)
# sample app named 'mytestapp' with a right sidebar using a custom icon created in a temp dir
location <- tempdir()
create_application(name = 'mytestapp', location = location, sample_app = TRUE, right_sidebar = TRUE)
-#> periscope2 application mytestapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application mytestapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/mytestapp'), TRUE)
# blank app named 'myblankapp' created in a temp dir
location <- tempdir()
create_application(name = 'myblankapp', location = location)
-#> periscope2 application myblankapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application myblankapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/myblankapp'), TRUE)
# blank app named 'myblankapp' without a left sidebar created in a temp dir
location <- tempdir()
create_application(name = 'myblankapp', location = location, left_sidebar = FALSE)
-#> periscope2 application myblankapp was created successfully at /tmp/RtmpBjjCUk
+#> periscope2 application myblankapp was created successfully at /tmp/Rtmpk1yVfS
unlink(paste0(location,'/myblankapp'), TRUE)
logical value indicating whether row names are to be written +for tabular data. Where not applicable for a download type it is ignored.
Value
@@ -177,7 +186,7 @@Examples
logger = "", filenameroot = "mydownload1", datafxns = list(csv = reactiveVal(iris)), - aspectratio = 1) + row_names = FALSE) # multiple download types downloadFile(id = "object_id2", logger = "", diff --git a/docs/reference/downloadFileButton.html b/docs/reference/downloadFileButton.html index 61b1d085..5d992a64 100644 --- a/docs/reference/downloadFileButton.html +++ b/docs/reference/downloadFileButton.html @@ -20,7 +20,7 @@
+
+
+
+
+
+
+
+
+
+
+ downloadableReactTable module server function
+ Source:R/downloadableReactTable.R
+ downloadableReactTable.Rd
+
+
+ Server-side function for the downloadableReactTableUI.
+
+
+
+
+ downloadableReactTable(
+ id,
+ table_data,
+ selection_mode = NULL,
+ pre_selected_rows = NULL,
+ file_name_root = "data_file",
+ download_data_fxns = NULL,
+ pagination = FALSE,
+ table_height = 600,
+ show_rownames = FALSE,
+ columns_filter = FALSE,
+ global_search = TRUE,
+ row_highlight = TRUE,
+ row_striping = TRUE,
+ table_options = list(),
+ logger = NULL
+)
+
+ Arguments
+ + +- id +
the ID of the Module's UI element
+
+
+- table_data +
reactive expression (or parameter-less function) that acts as table data source
+
+
+- selection_mode +
to enable row selection, set
selection_modevalue to either "single" for single row +selection or "multiple" for multiple rows selection, case insensitive. Any other value will +disable row selection. Row selection will be enabled by radio buttons in "single" selection +and checkboxes in "multiple" selection (default = NULL)
+
+
+- pre_selected_rows +
reactive expression (or parameter-less function) provides the rows indices of the rows to +be selected when the table is rendered. If selection_mode is disabled, this parameter will +have no effect. If selection_mode is "single" only the first row index will be used (default = NULL)
+
+
+- file_name_root +
the base name used for user-downloaded file. It can be either a character string +a reactive expression or a function returning a character string (default = 'data_file')
+
+
+- download_data_fxns +
a named list of functions providing the data as return values. +The names for the list should be the same names as the ones used in the +downloadableReactTableUI (default = NULL)
+
+
+- pagination +
to enable table pagination (default = FALSE)
+
+
+- table_height +
max table height in pixels. Vertical scroll will be shown after that height value
+
+
+- show_rownames +
enable displaying rownames as a separate column (default = FALSE)
+
+
+- columns_filter +
enable the filtering input on each column in the table (default = FALSE)
+
+
+- global_search +
enable table global searching input to search and filter in all columns at once +(default = TRUE)
+
+
+- row_highlight +
enable highlighting rows upon mouse hover (default = TRUE)
+
+
+- row_striping +
add zebra-striped style to table rows (default = TRUE)
+
+
+- table_options +
optional table formatting parameters check
?reactable::reactablefor options full list. +Also see example below to see how to pass options (default = list())
+
+
+- logger +
logger to use (default = NULL)
+
+
+
+ Value
+A named list of two elements:
selected_rows: data.frame of current selected rows
+table_state: a list of the current table state. The list keys are +("page", "pageSize", "pages", "sorted" and "selected"). +Review
?reactable::getReactableStatefor more info.
+
+
+ Shiny Usage
+ + +This function is not called directly by consumers - it is accessed in
+server.R using the same id provided in downloadableReactTableUI:
downloadableReactTable(id)
+
+
+ See also
+ +
+
+
+ Examples
+if (interactive()) {
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+ shinyApp(
+ ui = fluidPage(fluidRow(column(
+ width = 12,
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")))),
+ server = function(input, output) {
+ table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+ })
+}
+
+
+
+
+
+
+
+
+
+
+
+
+ downloadableReactTable module UI function
+ Source:R/downloadableReactTable.R
+ downloadableReactTableUI.Rd
+
+
+ downloadableReactTable module is extending ?reactable package table functions by creating
+a custom high-functionality table paired with downloadFile button.
+The table has the following default functionality:search, highlight functionality, infinite scrolling, sorting by columns and
+returns a reactive dataset of selected items and table current state.
+
+
+
+ downloadableReactTableUI(id, downloadtypes = NULL, hovertext = NULL)
+
+ Arguments
+ + +
+
+ Value
+list of downloadFileButton UI and reactable table and hidden inputs for contentHeight option
+
+
+ Details
+downloadFile button will be hidden if downloadableReactTableUI parameter
+downloadtypes is empty
+
+ Table Features
+ + +Consistent styling of the table
+downloadFile module button functionality built-in to the table (it will be shown only if downloadtypes is defined)
+Ability to show different data from the download data
+Table is automatically fit to the window size with infinite +y-scrolling
+Table search functionality including highlighting built-in
+Multi-select built in, including reactive feedback on which table +items are selected
+
+
+ Example
+ + +downloadableReactTableUI("mytableID", c("csv", "tsv"),
+"Click Here")
+
+ Notes
+ + +When there are no rows to download in any of the linked downloaddatafxns the +button will be hidden as there is nothing to download.
+
+
+ Shiny Usage
+ + +Call this function at the place in ui.R where the table should be placed.
+Paired with a call to downloadableReactTable(id, ...)
+in server.R
+
+
+ See also
+ +
+
+
+ Examples
+if (interactive()) {
+ library(shiny)
+ library(periscope2)
+ library(reactable)
+
+ shinyApp(
+ ui = fluidPage(fluidRow(column(
+ width = 12,
+ downloadableReactTableUI(
+ id = "object_id1",
+ downloadtypes = c("csv", "tsv"),
+ hovertext = "Download the data here!")))),
+ server = function(input, output) {
+ table_state <- downloadableReactTable(
+ id = "object_id1",
+ table_data = reactiveVal(iris),
+ download_data_fxns = list(csv = reactiveVal(iris), tsv = reactiveVal(iris)),
+ selection_mode = "multiple",
+ pre_selected_rows = function() {c(1, 3, 5)},
+ table_options = list(columns = list(
+ Sepal.Length = colDef(name = "Sepal Length"),
+ Sepal.Width = colDef(filterable = TRUE),
+ Petal.Length = colDef(show = FALSE),
+ Petal.Width = colDef(defaultSortOrder = "desc")),
+ showSortable = TRUE,
+ theme = reactableTheme(
+ borderColor = "#dfe2e5",
+ stripedColor = "#f6f8fa",
+ highlightColor = "#f0f5f9",
+ cellPadding = "8px 12px")))
+
+ observeEvent(table_state(), { print(table_state()) })
+ })
+}
+
+downloadablePlotUI()
downloadablePlot module UI function
downloadableReactTable module server function
downloadableReactTable module UI function
Display app logs
-
Creates a shiny table with table containing logged user actions. Table contents are auto updated whenever a user action is
-logged. The id must match the same id configured in server.R file upon calling fw_server_setup method
Display app log data in downloadableReactTable table containing logged user actions. Table contents are auto updated
+whenever a user action is logged. User can search for logs, sort them by time and download them in CSV or TSV format.
+The id must match the same id configured in server.R file upon calling fw_server_setup method
@@ -105,7 +110,7 @@
Arguments
Value
-shiny tableOutput instance
+downloadableReactTableUI instance
Table columns
@@ -143,7 +148,28 @@Examples
# Inside ui_body add the log viewer box to your box list
logViewerOutput('logViewerId')
-#> <div id="logViewerId-logViewerId" class="shiny-html-output"></div>
+#> [[1]]
+#> <div class="shiny-panel-conditional" data-display-if="output.displayButton" data-ns-prefix="logViewerId-logViewerId-">
+#> <span id="logViewerId-logViewerId-reactTableButtonDiv" class="periscope-downloadable-react-table-button" style="">
+#> <span class="btn-group" data-toggle="tooltip" data-placement="top" title="Download application logs">
+#> <button aria-expanded="false" aria-haspopup="true" class="btn btn-default action-button dropdown-toggle periscope-download-btn" data-toggle="dropdown" id="logViewerId-logViewerId-reactTableButtonID-downloadFileList" type="button action">
+#> <i class="far fa-copy" role="presentation" aria-label="copy icon"></i>
+#> </button>
+#> <ul class="dropdown-menu" id="logViewerId-logViewerId-reactTableButtonID-testList">
+#> <li>
+#> <a aria-disabled="true" class="shiny-download-link disabled periscope-download-choice" download href="" id="logViewerId-logViewerId-reactTableButtonID-csv" tabindex="-1" target="_blank">csv</a>
+#> </li>
+#> <li>
+#> <a aria-disabled="true" class="shiny-download-link disabled periscope-download-choice" download href="" id="logViewerId-logViewerId-reactTableButtonID-tsv" tabindex="-1" target="_blank">tsv</a>
+#> </li>
+#> </ul>
+#> </span>
+#> </span>
+#> </div>
+#>
+#> [[2]]
+#> <div class="reactable html-widget html-widget-output shiny-report-size html-fill-item" data-reactable-output="logViewerId-logViewerId-reactTableOutputID" id="logViewerId-logViewerId-reactTableOutputID" style="width:auto;height:auto;"></div>
+#>
Arguments
Designating the log level to use for the user log as 'DEBUG','INFO', 'WARN' or 'ERROR' (default = 'DEBUG')
Designating the log level to use for the user log as 'DEBUG','INFO', 'WARNING' or 'ERROR' (default = 'DEBUG')
+
+
+
+
+
+
+
+
+ [[2]]
+
+
# logViewer - valid sample log
- [1] "| action | time |
|---|---|
| Be Sure to Remember to Log ALL user actions | 02-19-2022 14:03 |
| Sample Title (click for an info pop-up) started with log level <DEBUG> | 02-19-2022 14:03 |
| Application Reset requested by user. Resetting in 5 seconds | 02-19-2022 14:04 |