CRAN release, upversion to 0.4.1 [skip vbump] (#195)

Related to #189

Author: donyunardi

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: teal.widgets
 Title: 'shiny' Widgets for 'teal' Applications
-Version: 0.4.0.9013
+Version: 0.4.1
 Date: 2023-10-02
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "dawid.kaledkowski@roche.com", role = c("aut", "cre")),
@@ -36,6 +36,7 @@ Imports:
     shinyWidgets (>= 0.5.1),
     styler (>= 1.2.0)
 Suggests:
+    DT,
     knitr (>= 1.42),
     lattice (>= 0.18-4),
     magrittr (>= 1.5),

NEWS.md

@@ -1,10 +1,11 @@
-# teal.widgets 0.4.0.9013
+# teal.widgets 0.4.1
 
 ### Miscellaneous
 
 * Documentation enhancements - code formatting package names and R objects.
 * Add `grDevices` to Imports.
 * Specified minimal version of package dependencies.
+* Improved logic and documentation for `optionalSelectInput`.
 
 # teal.widgets 0.4.0
 

R/get_dt_rows.R

@@ -6,22 +6,36 @@
 #'
 #' @name get_dt_rows
 #'
+#' @return (`shiny::tagList`) A `shiny` tagList.
+#'
 #' @examples
-#' \dontrun{
 #' library(shiny)
-#' # in Shiny UI function
-#' tagList(
-#'   get_dt_rows(ns("data_table"), ns("dt_rows")),
-#'   ...
-#' )
+#' ui <- function(id) {
+#'   ns <- NS(id)
+#'   tagList(
+#'     DT::DTOutput(ns("data_table")),
+#'     get_dt_rows(ns("data_table"), ns("dt_rows"))
+#'   )
+#' }
 #'
 #' # use the input$dt_rows in the Shiny Server function
-#' if (!is.null(input$dt_rows)) {
-#'   dt_args$options$pageLength <- input$dt_rows
-#' } # nolint
-#' do.call(DT::datatable, dt_args)
+#' server <- function(id) {
+#'   moduleServer(id, function(input, output, session) {
+#'     output$data_table <- DT::renderDataTable(
+#'       {
+#'         iris
+#'       },
+#'       options = list(pageLength = input$dt_rows)
+#'     )
+#'   })
 #' }
 #'
+#' if (interactive()) {
+#'   shinyApp(
+#'     ui = ui("my_table_module"),
+#'     server = function(input, output, session) server("my_table_module")
+#'   )
+#' }
 #' @export
 get_dt_rows <- function(dt_name, dt_rows) {
   tags$head(

R/optionalInput.R

@@ -26,6 +26,9 @@
 #' @param width (`character(1)`)\cr
 #'  The width of the input passed to `pickerInput`  e.g. `'auto'`, `'fit'`, `'100px'` or `'75%'`
 #'
+#' @return (`shiny.tag`) HTML tag with `pickerInput` widget and
+#'  non-interactive element listing selected values.
+#'
 #' @export
 #'
 #' @examples
@@ -471,6 +474,8 @@ extract_raw_choices <- function(choices, sep) {
 #'  an object of class `shiny.tag`. E.g. an object returned by [shiny::helpText()]
 #' @param ... optional arguments to `sliderInput`
 #'
+#' @return (`shiny.tag`) HTML tag with `sliderInput` widget.
+#'
 #' @export
 #'
 #' @examples
@@ -532,6 +537,8 @@ optionalSliderInput <- function(inputId, label, min, max, value, label_help = NU
 #'  Otherwise, if it is of length three the three elements will map to `value`, `min` and `max` of
 #'  the [optionalSliderInput()] function.
 #'
+#' @return (`shiny.tag`) HTML tag with range `sliderInput` widget.
+#'
 #' @export
 #'
 #' @examples

R/plot_with_settings.R

@@ -1,9 +1,5 @@
-#' UI part of plot-with-settings module
-#'
-#' @description `r lifecycle::badge("stable")`
+#' @rdname plot_with_settings
 #' @export
-#'
-#' @param id (\code{character}) module ID
 plot_with_settings_ui <- function(id) {
   checkmate::assert_string(id)
 
@@ -62,12 +58,16 @@ plot_with_settings_ui <- function(id) {
   )
 }
 
-#' Server part of plot-with-settings module
+#' Plot-with-settings module
 #'
+#' @rdname plot_with_settings
 #' @description `r lifecycle::badge("stable")`
+#' Universal module for plots with settings for height, width, and download.
+#'
 #' @export
 #'
-#' @inheritParams shiny::moduleServer
+#' @param id (`character(1)`) `shiny` module id.
+#'
 #' @param plot_r (`reactive` or `function`)\cr
 #'  `reactive` expression or a simple `function` to draw a plot.
 #'  A simple `function` is needed e.g. for base plots like `plot(1)` as the output can not be caught when downloading.
@@ -106,11 +106,12 @@ plot_with_settings_ui <- function(id) {
 #' `options(teal.plot_dpi = 96)`. The minimum allowed `dpi` value is `24` and it must be a whole number.
 #' If an invalid value is set then the default value is used and a warning is outputted to the console.
 #'
+#' @return A `shiny` module.
+#'
 #' @examples
-#' \dontrun{
 #' # Example using a reactive as input to plot_r
 #' library(shiny)
-#' shinyApp(
+#' app1 <- shinyApp(
 #'   ui = fluidPage(
 #'     plot_with_settings_ui(
 #'       id = "plot_with_settings"
@@ -130,8 +131,12 @@ plot_with_settings_ui <- function(id) {
 #'   }
 #' )
 #'
+#' if (interactive()) {
+#'   runApp(app1)
+#' }
+#'
 #' # Example using a function as input to plot_r
-#' shinyApp(
+#' app2 <- shinyApp(
 #'   ui = fluidPage(
 #'     radioButtons("download_option", "Select the Option", list("ggplot", "trellis", "grob", "base")),
 #'     plot_with_settings_ui(
@@ -167,8 +172,12 @@ plot_with_settings_ui <- function(id) {
 #'   }
 #' )
 #'
+#' if (interactive()) {
+#'   runApp(app2)
+#' }
+#'
 #' # Example with brushing/hovering/clicking/double-clicking
-#' shinyApp(
+#' app3 <- shinyApp(
 #'   ui = fluidPage(
 #'     plot_with_settings_ui(
 #'       id = "plot_with_settings"
@@ -202,10 +211,14 @@ plot_with_settings_ui <- function(id) {
 #'   }
 #' )
 #'
+#' if (interactive()) {
+#'   runApp(app3)
+#' }
+#'
 #' # Example which allows module to be hidden/shown
 #' library("shinyjs")
 #'
-#' shinyApp(
+#' app4 <- shinyApp(
 #'   ui = fluidPage(
 #'     useShinyjs(),
 #'     actionButton("button", "Show/Hide"),
@@ -229,7 +242,11 @@ plot_with_settings_ui <- function(id) {
 #'     )
 #'   }
 #' )
+#'
+#' if (interactive()) {
+#'   runApp(app4)
 #' }
+#'
 plot_with_settings_srv <- function(id,
                                    plot_r,
                                    height = c(600, 200, 2000),

R/table_with_settings.R

@@ -42,14 +42,16 @@ table_with_settings_ui <- function(id, ...) {
 #'  a mechanism to allow modules which call this module to show/hide the table_with_settings UI.
 #'
 #' @rdname table_with_settings
+#'
+#' @return A `shiny` module.
+#'
 #' @export
 #'
 #' @examples
-#' \dontrun{
 #' library(shiny)
 #' library(rtables)
 #' library(magrittr)
-#' shinyApp(
+#' app <- shinyApp(
 #'   ui = fluidPage(
 #'     table_with_settings_ui(
 #'       id = "table_with_settings"
@@ -69,6 +71,8 @@ table_with_settings_ui <- function(id, ...) {
 #'     table_with_settings_srv(id = "table_with_settings", table_r = table_r)
 #'   }
 #' )
+#' if (interactive()) {
+#'   runApp(app)
 #' }
 #'
 table_with_settings_srv <- function(id, table_r, show_hide_signal = reactive(TRUE)) {

inst/WORDLIST

@@ -7,3 +7,4 @@ draggable
 funder
 pre
 repo
+tagList