diff --git a/R/init.R b/R/init.R index 9b43ae0397..445d9432b0 100644 --- a/R/init.R +++ b/R/init.R @@ -31,8 +31,8 @@ #' The header of the app. #' @param footer (`shiny.tag` or `character(1)`) #' The footer of the app. -#' @param id (`character`) -#' Optional string specifying the `shiny` module id in cases it is used as a `shiny` module +#' @param id (`character`) optional +#' string specifying the `shiny` module id in cases it is used as a `shiny` module #' rather than a standalone `shiny` app. This is a legacy feature. #' #' @return Named list with server and UI functions. diff --git a/R/modules.R b/R/modules.R index 90fdd62b7f..820be2b474 100644 --- a/R/modules.R +++ b/R/modules.R @@ -395,7 +395,7 @@ is_arg_used <- function(modules, arg) { #' Nesting it increases overall depth by 1. #' #' @inheritParams init -#' @param depth optional, integer determining current depth level +#' @param depth optional integer determining current depth level #' #' @return Depth level for given module. #' @keywords internal diff --git a/R/show_rcode_modal.R b/R/show_rcode_modal.R index 9ef042ed99..762257124a 100644 --- a/R/show_rcode_modal.R +++ b/R/show_rcode_modal.R @@ -8,8 +8,8 @@ #' Title of the modal, displayed in the first comment of the `R` code. #' @param rcode (`character`) #' vector with `R` code to show inside the modal. -#' @param session (`ShinySession` optional) -#' `shiny` session object, if missing then [shiny::getDefaultReactiveDomain()] is used. +#' @param session (`ShinySession`) optional +#' `shiny` session object, defaults to [shiny::getDefaultReactiveDomain()]. #' #' @references [shiny::showModal()] #' @export diff --git a/R/teal_slices.R b/R/teal_slices.R index 6c1235c9bc..f27f339842 100644 --- a/R/teal_slices.R +++ b/R/teal_slices.R @@ -9,7 +9,7 @@ #' #' @inheritParams teal.slice::teal_slices #' -#' @param module_specific optional (`logical(1)`) +#' @param module_specific (`logical(1)`) optional, #' - `FALSE` (default) when one filter panel applied to all modules. #' All filters will be shared by all modules. #' - `TRUE` when filter panel module-specific. diff --git a/R/utils.R b/R/utils.R index 43ad20f4e5..7bb091dc27 100644 --- a/R/utils.R +++ b/R/utils.R @@ -80,7 +80,7 @@ teal_data_to_filtered_data <- function(x, datanames = teal_data_datanames(x)) { #' #' @param title (`character(1)`) title of the card (unless overwritten by label) #' @param label (`character(1)`) label provided by the user when adding the card -#' @param description (`character(1)`) optional additional description +#' @param description (`character(1)`) optional, additional description #' @param with_filter (`logical(1)`) flag indicating to add filter state #' @param filter_panel_api (`FilterPanelAPI`) object with API that allows the generation #' of the filter state in the report diff --git a/man/init.Rd b/man/init.Rd index 89a588328f..991a7db62c 100644 --- a/man/init.Rd +++ b/man/init.Rd @@ -38,8 +38,8 @@ The header of the app.} \item{footer}{(\code{shiny.tag} or \code{character(1)}) The footer of the app.} -\item{id}{(\code{character}) -Optional string specifying the \code{shiny} module id in cases it is used as a \code{shiny} module +\item{id}{(\code{character}) optional +string specifying the \code{shiny} module id in cases it is used as a \code{shiny} module rather than a standalone \code{shiny} app. This is a legacy feature.} } \value{ diff --git a/man/modules_depth.Rd b/man/modules_depth.Rd index 37a59c5f7d..4501141cb2 100644 --- a/man/modules_depth.Rd +++ b/man/modules_depth.Rd @@ -13,7 +13,7 @@ nested list of \code{teal_modules} or \code{teal_module} objects or a single will be displayed in the \code{teal} application. See \code{\link[=modules]{modules()}} and \code{\link[=module]{module()}} for more details.} -\item{depth}{optional, integer determining current depth level} +\item{depth}{optional integer determining current depth level} } \value{ Depth level for given module. diff --git a/man/report_card_template.Rd b/man/report_card_template.Rd index 42a2750800..ac14a9e257 100644 --- a/man/report_card_template.Rd +++ b/man/report_card_template.Rd @@ -17,7 +17,7 @@ report_card_template( \item{label}{(\code{character(1)}) label provided by the user when adding the card} -\item{description}{(\code{character(1)}) optional additional description} +\item{description}{(\code{character(1)}) optional, additional description} \item{with_filter}{(\code{logical(1)}) flag indicating to add filter state} diff --git a/man/show_rcode_modal.Rd b/man/show_rcode_modal.Rd index 66874b9690..b2a407f9a2 100644 --- a/man/show_rcode_modal.Rd +++ b/man/show_rcode_modal.Rd @@ -13,8 +13,8 @@ Title of the modal, displayed in the first comment of the \code{R} code.} \item{rcode}{(\code{character}) vector with \code{R} code to show inside the modal.} -\item{session}{(\code{ShinySession} optional) -\code{shiny} session object, if missing then \code{\link[shiny:domains]{shiny::getDefaultReactiveDomain()}} is used.} +\item{session}{(\code{ShinySession}) optional +\code{shiny} session object, defaults to \code{\link[shiny:domains]{shiny::getDefaultReactiveDomain()}}.} } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/teal_slices.Rd b/man/teal_slices.Rd index bf84b842e2..834ba37617 100644 --- a/man/teal_slices.Rd +++ b/man/teal_slices.Rd @@ -44,7 +44,7 @@ Please make sure that adding new filters doesn't fail on target platform before \item{allow_add}{(\code{logical(1)}) logical flag specifying whether the user will be able to add new filters} -\item{module_specific}{optional (\code{logical(1)}) +\item{module_specific}{(\code{logical(1)}) optional, \itemize{ \item \code{FALSE} (default) when one filter panel applied to all modules. All filters will be shared by all modules.