diff --git a/R/argument_convention.R b/R/argument_convention.R index 4c4b34f7b6..f8b46aea5c 100644 --- a/R/argument_convention.R +++ b/R/argument_convention.R @@ -19,7 +19,7 @@ #' @param aval_var (`character`)\cr name of the analysis value variable. #' @param baseline_var (`character`)\cr name of the variable for baseline values of the analysis variable. #' @param base_var `r lifecycle::badge("deprecated")` Please use the `baseline_var` argument instead. -#' @param basic_table_args optional, (`basic_table_args`)\cr object created by [teal.widgets::basic_table_args()] +#' @param basic_table_args (`basic_table_args`) optional,\cr object created by [teal.widgets::basic_table_args()] #' with settings for the module table. The argument is merged with option `teal.basic_table_args` and with default #' module arguments (hard coded in the module body). #' For more details, see the vignette: `vignette("custom-basic-table-arguments", package = "teal.widgets")`. @@ -46,7 +46,7 @@ #' @param event_type (`character`)\cr type of event that is summarized (e.g. adverse event, treatment). Default #' is `"event"`. #' @param font_size (`numeric`)\cr font size value. -#' @param ggplot2_args optional, (`ggplot2_args`)\cr object created by [teal.widgets::ggplot2_args()] with settings +#' @param ggplot2_args (`ggplot2_args`) optional,\cr object created by [teal.widgets::ggplot2_args()] with settings #' for the module plot. The argument is merged with option `teal.ggplot2_args` and with default module arguments #' (hard coded in the module body). #' For more details, see the vignette: `vignette("custom-ggplot2-arguments", package = "teal.widgets")`. @@ -88,7 +88,7 @@ #' records in `treatment_flag_var`. #' @param treatment_flag_var (`character`)\cr name of the on treatment flag variable. #' @param useNA (`character`)\cr whether missing data (`NA`) should be displayed as a level. -#' @param var_labels optional, (named `character`)\cr variable labels for relabeling the analysis variables. +#' @param var_labels (named `character`) optional,\cr variable labels for relabeling the analysis variables. #' @param visit_var (`character`)\cr variable names that can be used as `visit` variable. Must be a factor in #' `dataname`. #' @param worst_flag_indicator (`character`)\cr value indicating worst grade. @@ -115,7 +115,7 @@ NULL #' excluded to reduce duplication as each module function inherits parameters from its corresponding template #' function. #' -#' @param arm_ref_comp optional, (`list`)\cr If specified it must be a named list with each element corresponding to +#' @param arm_ref_comp (`list`) optional,\cr If specified it must be a named list with each element corresponding to #' an arm variable in `ADSL` and the element must be another list (possibly #' with delayed [teal.transform::variable_choices()] or delayed [teal.transform::value_choices()] #' with the elements named `ref` and `comp` that the defined the default @@ -175,13 +175,13 @@ NULL #' available choices and preselected option for the parameter code variable from `dataname`. #' @param parentname (`character`)\cr parent analysis data used in teal module, usually this refers to `ADSL`. #' @param patient_col (`character`)\cr name of patient ID variable. -#' @param plot_height optional, (`numeric`)\cr a vector of length three with `c(value, min, max)`. Specifies the +#' @param plot_height (`numeric`) optional,\cr a vector of length three with `c(value, min, max)`. Specifies the #' height of the main plot and renders a slider on the plot to interactively adjust the plot height. -#' @param plot_width optional, (`numeric`)\cr a vector of length three with `c(value, min, max)`. Specifies the width +#' @param plot_width (`numeric`) optional,\cr a vector of length three with `c(value, min, max)`. Specifies the width #' of the main plot and renders a slider on the plot to interactively adjust the plot width. -#' @param post_output optional, (`shiny.tag`)\cr with text placed after the output to put the output into context. +#' @param post_output (`shiny.tag`) optional,\cr with text placed after the output to put the output into context. #' For example the [shiny::helpText()] elements are useful. -#' @param pre_output optional, (`shiny.tag`)\cr with text placed before the output to put the output into context. +#' @param pre_output (`shiny.tag`) optional,\cr with text placed before the output to put the output into context. #' For example a title. #' @param strata_var ([teal.transform::choices_selected()])\cr names of #' the variables for stratified analysis. diff --git a/R/tm_a_mmrm.R b/R/tm_a_mmrm.R index dea651dbb0..08749ff36e 100644 --- a/R/tm_a_mmrm.R +++ b/R/tm_a_mmrm.R @@ -447,7 +447,7 @@ template_mmrm_plots <- function(fit_name, #' @inheritParams template_mmrm_plots #' @param method ([teal.transform::choices_selected()])\cr object with #' all available choices and pre-selected option for the adjustment method. -#' @param ggplot2_args (`ggplot2_args`) \cr optional, object created by [`teal.widgets::ggplot2_args()`] +#' @param ggplot2_args (`ggplot2_args`) optional,\cr object created by [`teal.widgets::ggplot2_args()`] #' with settings for all the plots or named list of `ggplot2_args` objects for plot-specific settings. #' List names should match the following: `c("default", "lsmeans", "diagnostic")`. The argument is merged #' with option `teal.ggplot2_args` and with default module arguments (hard coded in the module body). diff --git a/R/tm_g_forest_rsp.R b/R/tm_g_forest_rsp.R index 35f8b0f122..d0dc148ec4 100644 --- a/R/tm_g_forest_rsp.R +++ b/R/tm_g_forest_rsp.R @@ -10,7 +10,7 @@ #' estimator plot symbol. Typically, the symbol size is proportional to the sample size used #' to calculate the estimator. If `NULL`, the same symbol size is used for all subgroups. #' @param strata_var (`character`)\cr names of the variables for stratified analysis. -#' @param ggplot2_args optional, (`ggplot2_args`)\cr +#' @param ggplot2_args (`ggplot2_args`) optional,\cr #' object created by [teal.widgets::ggplot2_args()] with settings for the module plot. For this #' module, this argument will only accept `ggplot2_args` object with `labs` list of following child #' elements: `title`, `caption`. No other elements would be taken into account. The argument is diff --git a/R/tm_g_ipp.R b/R/tm_g_ipp.R index a4a6c2786b..574f48584f 100644 --- a/R/tm_g_ipp.R +++ b/R/tm_g_ipp.R @@ -12,7 +12,7 @@ #' `TRUE`. #' @param paramcd_first (`character`)\cr `paramcd` text to append to the plot title and y-axis label. #' @param add_avalu (`logical`)\cr whether `avalu_first` text should be appended to the plot title and y-axis label. -#' @param ggplot2_args optional, (`ggplot2_args`)\cr object created by [teal.widgets::ggplot2_args()] with settings +#' @param ggplot2_args (`ggplot2_args`) optional,\cr object created by [teal.widgets::ggplot2_args()] with settings #' for the module plot. For this module, this argument will only accept `ggplot2_args` object with `labs` list of #' the following child elements: `title`, `subtitle`, `x`, `y`. No other elements are taken into account. The #' argument is merged with option `teal.ggplot2_args` and with default module arguments (hard coded in the module diff --git a/R/tm_g_lineplot.R b/R/tm_g_lineplot.R index a7a4982277..19d151343e 100644 --- a/R/tm_g_lineplot.R +++ b/R/tm_g_lineplot.R @@ -7,7 +7,7 @@ #' @inheritParams template_arguments #' @param param (`character`)\cr parameter to filter the data by. #' @param incl_screen (`logical`)\cr whether the screening visit should be included. -#' @param ggplot2_args optional, (`ggplot2_args`)\cr object created by [teal.widgets::ggplot2_args()] with settings +#' @param ggplot2_args (`ggplot2_args`) optional,\cr object created by [teal.widgets::ggplot2_args()] with settings #' for the module plot. For this module, this argument will only accept `ggplot2_args` object with `labs` list of #' following child elements: `title`, `subtitle`, `caption`, `y`, `lty`. No other elements would be taken into #' account. The argument is merged with option `teal.ggplot2_args` and with default module arguments (hard coded in diff --git a/R/utils.R b/R/utils.R index 3fc88013a0..c6ca9432b7 100644 --- a/R/utils.R +++ b/R/utils.R @@ -464,7 +464,7 @@ split_choices <- function(x) { #' @param dataname (`character`)\cr #' `dataname` from data_extract input. #' This might be retrieved like `data_extract_spec(...)[[1]]$dataname`. -#' @param filter optional, (`logical`)\cr +#' @param filter (`logical`) optional,\cr #' if the connected `extract_data_spec` has objects passed to its `filter` argument #' #' @return a string diff --git a/man/extract_input.Rd b/man/extract_input.Rd index f2a2a8fad9..809e07db31 100644 --- a/man/extract_input.Rd +++ b/man/extract_input.Rd @@ -15,7 +15,7 @@ or \code{session$ns("original id")}/"original id" in the server function.} \code{dataname} from data_extract input. This might be retrieved like \code{data_extract_spec(...)[[1]]$dataname}.} -\item{filter}{optional, (\code{logical})\cr +\item{filter}{(\code{logical}) optional,\cr if the connected \code{extract_data_spec} has objects passed to its \code{filter} argument} } \value{ diff --git a/man/make_barchart_simple_call.Rd b/man/make_barchart_simple_call.Rd index 6303ad9179..9b3bd4d673 100644 --- a/man/make_barchart_simple_call.Rd +++ b/man/make_barchart_simple_call.Rd @@ -52,7 +52,7 @@ also be drawn as text.} \item{facet_scales}{(\code{character})\cr value passed to \code{scales} argument of \code{\link[ggplot2:facet_grid]{ggplot2::facet_grid()}}. Options are \code{fixed}, \code{free_x}, \code{free_y}, and \code{free}.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/module_arguments.Rd b/man/module_arguments.Rd index 5ff8d44af8..0e989497f8 100644 --- a/man/module_arguments.Rd +++ b/man/module_arguments.Rd @@ -4,7 +4,7 @@ \alias{module_arguments} \title{Standard Module Arguments} \arguments{ -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -91,16 +91,16 @@ available choices and preselected option for the parameter code variable from \c \item{patient_col}{(\code{character})\cr name of patient ID variable.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} \item{strata_var}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr names of diff --git a/man/template_a_gee.Rd b/man/template_a_gee.Rd index 61cf33a39b..dea1cbef70 100644 --- a/man/template_a_gee.Rd +++ b/man/template_a_gee.Rd @@ -43,7 +43,7 @@ template_a_gee( \item{conf_level}{(\code{numeric})\cr value for the confidence level within the range of (0, 1).} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_abnormality.Rd b/man/template_abnormality.Rd index 8bc5beb0a7..1e06429e94 100644 --- a/man/template_abnormality.Rd +++ b/man/template_abnormality.Rd @@ -63,7 +63,7 @@ user input for this parameter is ignored.} \item{na_level}{(\code{character})\cr the NA level in the input dataset, defaults to \code{""}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_abnormality_by_worst_grade.Rd b/man/template_abnormality_by_worst_grade.Rd index 05ae0e91a3..893310e671 100644 --- a/man/template_abnormality_by_worst_grade.Rd +++ b/man/template_abnormality_by_worst_grade.Rd @@ -53,7 +53,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_adverse_events.Rd b/man/template_adverse_events.Rd index 3e9da8a3c3..eed521f8df 100644 --- a/man/template_adverse_events.Rd +++ b/man/template_adverse_events.Rd @@ -39,7 +39,7 @@ template_adverse_events( \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_ancova.Rd b/man/template_ancova.Rd index fad566073c..2e1274a658 100644 --- a/man/template_ancova.Rd +++ b/man/template_ancova.Rd @@ -71,7 +71,7 @@ variable levels for studied visits.} \item{conf_level}{(\code{numeric})\cr value for the confidence level within the range of (0, 1).} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_arguments.Rd b/man/template_arguments.Rd index 6479d79a07..870b879b06 100644 --- a/man/template_arguments.Rd +++ b/man/template_arguments.Rd @@ -24,7 +24,7 @@ \item{base_var}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}} Please use the \code{baseline_var} argument instead.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} @@ -68,7 +68,7 @@ is \code{"event"}.} \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} @@ -136,7 +136,7 @@ records in \code{treatment_flag_var}.} \item{useNA}{(\code{character})\cr whether missing data (\code{NA}) should be displayed as a level.} -\item{var_labels}{optional, (named \code{character})\cr variable labels for relabeling the analysis variables.} +\item{var_labels}{(named \code{character}) optional,\cr variable labels for relabeling the analysis variables.} \item{visit_var}{(\code{character})\cr variable names that can be used as \code{visit} variable. Must be a factor in \code{dataname}.} diff --git a/man/template_binary_outcome.Rd b/man/template_binary_outcome.Rd index 21a048c574..0f168f5941 100644 --- a/man/template_binary_outcome.Rd +++ b/man/template_binary_outcome.Rd @@ -65,7 +65,7 @@ apply in all modules, run \code{set_default_total_label("new_default")}.} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_coxreg_m.Rd b/man/template_coxreg_m.Rd index 692bb7d7b6..8efa5b0a50 100644 --- a/man/template_coxreg_m.Rd +++ b/man/template_coxreg_m.Rd @@ -51,7 +51,7 @@ to specify the value of the covariate at which the effect should be estimated.} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_coxreg_u.Rd b/man/template_coxreg_u.Rd index ad35234222..b4540f69a5 100644 --- a/man/template_coxreg_u.Rd +++ b/man/template_coxreg_u.Rd @@ -54,7 +54,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{append}{(\code{logical})\cr whether the result should be appended to the previous one.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_events.Rd b/man/template_events.Rd index 444a9c5c04..a4579d50ff 100644 --- a/man/template_events.Rd +++ b/man/template_events.Rd @@ -74,7 +74,7 @@ user input for this parameter is ignored.} \item{incl_overall_sum}{(\code{flag})\cr whether two rows which summarize the overall number of adverse events should be included at the top of the table.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_events_by_grade.Rd b/man/template_events_by_grade.Rd index 6f8f4d8db8..65b563d5d7 100644 --- a/man/template_events_by_grade.Rd +++ b/man/template_events_by_grade.Rd @@ -68,7 +68,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_events_col_by_grade.Rd b/man/template_events_col_by_grade.Rd index 799d1dfb64..576931ab32 100644 --- a/man/template_events_col_by_grade.Rd +++ b/man/template_events_col_by_grade.Rd @@ -71,7 +71,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_events_patyear.Rd b/man/template_events_patyear.Rd index e761aed965..13b92ada61 100644 --- a/man/template_events_patyear.Rd +++ b/man/template_events_patyear.Rd @@ -49,7 +49,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_exposure.Rd b/man/template_exposure.Rd index c8abaa8659..356381ef77 100644 --- a/man/template_exposure.Rd +++ b/man/template_exposure.Rd @@ -61,7 +61,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{avalu_var}{(\code{character})\cr name of the analysis value unit variable.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_fit_mmrm.Rd b/man/template_fit_mmrm.Rd index ab60502079..b0296f63a1 100644 --- a/man/template_fit_mmrm.Rd +++ b/man/template_fit_mmrm.Rd @@ -93,7 +93,7 @@ machine (not default).} enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} @@ -104,7 +104,7 @@ See more \code{\link[tern.mmrm:g_mmrm_lsmeans]{tern.mmrm::g_mmrm_lsmeans()}}.} \item{diagnostic_plot}{(named \code{list})\cr a \code{list} of controls for diagnostic_plot. See more \code{\link[tern.mmrm:g_mmrm_diagnostic]{tern.mmrm::g_mmrm_diagnostic()}}.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_forest_rsp.Rd b/man/template_forest_rsp.Rd index 1988cd2a2c..9e9857dbc2 100644 --- a/man/template_forest_rsp.Rd +++ b/man/template_forest_rsp.Rd @@ -49,12 +49,9 @@ template_forest_rsp( estimator plot symbol. Typically, the symbol size is proportional to the sample size used to calculate the estimator. If \code{NULL}, the same symbol size is used for all subgroups.} -\item{rel_width_forest}{(\code{proportion})\cr proportion of total width to allocate to the forest plot. Relative -width of table is then \code{1 - rel_width_forest}. If \code{as_list = TRUE}, this parameter is ignored.} +\item{font_size}{(\code{numeric})\cr font size value.} -\item{font_size}{(\code{numeric})\cr font size.} - -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of following child elements: \code{title}, \code{caption}. No other elements would be taken into account. The argument is diff --git a/man/template_forest_tte.Rd b/man/template_forest_tte.Rd index 0f0d88c93d..7800ab5c4d 100644 --- a/man/template_forest_tte.Rd +++ b/man/template_forest_tte.Rd @@ -52,12 +52,9 @@ to calculate the estimator. If \code{NULL}, the same symbol size is used for all \item{time_unit_var}{(\code{character})\cr name of the variable representing time units.} -\item{rel_width_forest}{(\code{proportion})\cr proportion of total width to allocate to the forest plot. Relative -width of table is then \code{1 - rel_width_forest}. If \code{as_list = TRUE}, this parameter is ignored.} - \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_g_ci.Rd b/man/template_g_ci.Rd index b50156a436..7fdb3eb733 100644 --- a/man/template_g_ci.Rd +++ b/man/template_g_ci.Rd @@ -31,7 +31,7 @@ and line types.} \item{unit_var}{(\code{character})\cr name of the unit variable.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_g_ipp.Rd b/man/template_g_ipp.Rd index 4abfb28cd1..610dc1666e 100644 --- a/man/template_g_ipp.Rd +++ b/man/template_g_ipp.Rd @@ -54,7 +54,7 @@ template_g_ipp( \item{separate_by_obs}{(\code{logical})\cr whether to create multi-panel plots.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of the following child elements: \code{title}, \code{subtitle}, \code{x}, \code{y}. No other elements are taken into account. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module diff --git a/man/template_g_lineplot.Rd b/man/template_g_lineplot.Rd index c32738eb65..165fe3626c 100644 --- a/man/template_g_lineplot.Rd +++ b/man/template_g_lineplot.Rd @@ -73,7 +73,7 @@ or point and line (\code{pl}).} \item{y_lab}{(\code{character})\cr y-axis label. If equal to \code{NULL}, then no label will be added.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of following child elements: \code{title}, \code{subtitle}, \code{caption}, \code{y}, \code{lty}. No other elements would be taken into account. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in diff --git a/man/template_logistic.Rd b/man/template_logistic.Rd index 9e4db4dfe1..fe190e6d00 100644 --- a/man/template_logistic.Rd +++ b/man/template_logistic.Rd @@ -52,7 +52,7 @@ arm/treatment variable, set to \code{NULL}.} \item{at}{(\code{NULL} or \code{numeric})\cr optional values for the interaction variable. Otherwise the median is used.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_mult_events.Rd b/man/template_mult_events.Rd index 22d9395ee9..fe7aa8db2e 100644 --- a/man/template_mult_events.Rd +++ b/man/template_mult_events.Rd @@ -51,7 +51,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_patient_timeline.Rd b/man/template_patient_timeline.Rd index 415ccc9e68..3e8102f16e 100644 --- a/man/template_patient_timeline.Rd +++ b/man/template_patient_timeline.Rd @@ -51,7 +51,7 @@ template_patient_timeline( \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_shift_by_arm.Rd b/man/template_shift_by_arm.Rd index eac11d1295..2a8734d5be 100644 --- a/man/template_shift_by_arm.Rd +++ b/man/template_shift_by_arm.Rd @@ -57,7 +57,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_shift_by_arm_by_worst.Rd b/man/template_shift_by_arm_by_worst.Rd index 893bac145c..cb4ddce7c5 100644 --- a/man/template_shift_by_arm_by_worst.Rd +++ b/man/template_shift_by_arm_by_worst.Rd @@ -59,7 +59,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_shift_by_grade.Rd b/man/template_shift_by_grade.Rd index 7e117f63a1..be1cc56290 100644 --- a/man/template_shift_by_grade.Rd +++ b/man/template_shift_by_grade.Rd @@ -62,7 +62,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{code_missing_baseline}{(\code{logical})\cr whether missing baseline grades should be counted as grade 0.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_smq.Rd b/man/template_smq.Rd index 98cedd5229..a71137dd21 100644 --- a/man/template_smq.Rd +++ b/man/template_smq.Rd @@ -54,7 +54,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{id_var}{(\code{character})\cr the variable name for subject id.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_summary.Rd b/man/template_summary.Rd index 5cbf845190..bb4bcdedff 100644 --- a/man/template_summary.Rd +++ b/man/template_summary.Rd @@ -40,7 +40,7 @@ template_summary( enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{var_labels}{optional, (named \code{character})\cr variable labels for relabeling the analysis variables.} +\item{var_labels}{(named \code{character}) optional,\cr variable labels for relabeling the analysis variables.} \item{na.rm}{(\code{logical})\cr whether \code{NA} values should be removed prior to analysis.} @@ -61,7 +61,7 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_summary_by.Rd b/man/template_summary_by.Rd index fd91ccab1a..74dcec022a 100644 --- a/man/template_summary_by.Rd +++ b/man/template_summary_by.Rd @@ -39,7 +39,7 @@ template_summary_by( \item{by_vars}{(\code{character})\cr variable names used to split the summary by rows.} -\item{var_labels}{optional, (named \code{character})\cr variable labels for relabeling the analysis variables.} +\item{var_labels}{(named \code{character}) optional,\cr variable labels for relabeling the analysis variables.} \item{add_total}{(\code{logical})\cr whether to include column with total number of patients.} @@ -73,7 +73,7 @@ user input for this parameter is ignored.} \item{drop_zero_levels}{(\code{logical})\cr whether rows with zero counts in all columns should be removed from the table.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_therapy.Rd b/man/template_therapy.Rd index cc43be967f..91d345ff84 100644 --- a/man/template_therapy.Rd +++ b/man/template_therapy.Rd @@ -48,7 +48,7 @@ template_therapy( \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/template_tte.Rd b/man/template_tte.Rd index 985ed7f4c7..f84402a4d6 100644 --- a/man/template_tte.Rd +++ b/man/template_tte.Rd @@ -67,7 +67,7 @@ apply in all modules, run \code{set_default_total_label("new_default")}.} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/template_vitals.Rd b/man/template_vitals.Rd index e4674d2490..3a1a7330da 100644 --- a/man/template_vitals.Rd +++ b/man/template_vitals.Rd @@ -33,7 +33,7 @@ template_vitals( \item{font_size}{(\code{numeric})\cr font size value.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_a_gee.Rd b/man/tm_a_gee.Rd index 4a7c342693..11893fe830 100644 --- a/man/tm_a_gee.Rd +++ b/man/tm_a_gee.Rd @@ -49,7 +49,7 @@ Must be a factor in \code{dataname}.} \item{cov_var}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and preselected option for the covariates variables.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -61,13 +61,13 @@ available choices and preselected option for the parameter code variable from \c \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_a_mmrm.Rd b/man/tm_a_mmrm.Rd index d6f03fe982..83d0d4b87d 100644 --- a/man/tm_a_mmrm.Rd +++ b/man/tm_a_mmrm.Rd @@ -55,7 +55,7 @@ Must be a factor in \code{dataname}.} \item{cov_var}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and preselected option for the covariates variables.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -70,28 +70,28 @@ all available choices and pre-selected option for the adjustment method.} \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} \item{total_label}{(\code{string})\cr string to display as total column/row label if column/row is enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} -\item{ggplot2_args}{(\code{ggplot2_args}) \cr optional, object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for all the plots or named list of \code{ggplot2_args} objects for plot-specific settings. List names should match the following: \code{c("default", "lsmeans", "diagnostic")}. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). diff --git a/man/tm_g_barchart_simple.Rd b/man/tm_g_barchart_simple.Rd index 940d95cdf7..3503f4c44e 100644 --- a/man/tm_g_barchart_simple.Rd +++ b/man/tm_g_barchart_simple.Rd @@ -31,19 +31,19 @@ tm_g_barchart_simple( \item{plot_options}{(\code{list})\cr list of plot options.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_ci.Rd b/man/tm_g_ci.Rd index 8aacafccea..6c9e3e590e 100644 --- a/man/tm_g_ci.Rd +++ b/man/tm_g_ci.Rd @@ -33,19 +33,19 @@ tm_g_ci( \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_forest_rsp.Rd b/man/tm_g_forest_rsp.Rd index 9c10913527..92d1e1a280 100644 --- a/man/tm_g_forest_rsp.Rd +++ b/man/tm_g_forest_rsp.Rd @@ -43,7 +43,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -74,24 +74,21 @@ and contain arrays, each name corresponding to a single value of \code{paramcd}. may contain default response values or named arrays \code{rsp} of default selected response values and \code{levels} of default level choices.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{rel_width_forest}{(\code{proportion})\cr proportion of total width to allocate to the forest plot. Relative -width of table is then \code{1 - rel_width_forest}. If \code{as_list = TRUE}, this parameter is ignored.} +\item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{font_size}{(\code{numeric})\cr font size.} - -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of following child elements: \code{title}, \code{caption}. No other elements would be taken into account. The argument is diff --git a/man/tm_g_forest_tte.Rd b/man/tm_g_forest_tte.Rd index 4583b879b8..7136eb7f48 100644 --- a/man/tm_g_forest_tte.Rd +++ b/man/tm_g_forest_tte.Rd @@ -46,7 +46,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -76,24 +76,21 @@ with all available choices and pre-selected option for the time unit variable.} \item{fixed_symbol_size}{(\code{logical})\cr When (\code{TRUE}), the same symbol size is used for plotting each estimate. Otherwise, the symbol size will be proportional to the sample size in each each subgroup.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{rel_width_forest}{(\code{proportion})\cr proportion of total width to allocate to the forest plot. Relative -width of table is then \code{1 - rel_width_forest}. If \code{as_list = TRUE}, this parameter is ignored.} +\item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{font_size}{(\code{numeric})\cr font size.} - -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_ipp.Rd b/man/tm_g_ipp.Rd index 4464242ded..f5cad7b378 100644 --- a/man/tm_g_ipp.Rd +++ b/man/tm_g_ipp.Rd @@ -73,19 +73,19 @@ all available choices and preselected option for variable values that can be use \item{add_avalu}{(\code{logical})\cr whether \code{avalu_first} text should be appended to the plot title and y-axis label.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of the following child elements: \code{title}, \code{subtitle}, \code{x}, \code{y}. No other elements are taken into account. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module diff --git a/man/tm_g_km.Rd b/man/tm_g_km.Rd index eb51167d69..db2c46c8d2 100644 --- a/man/tm_g_km.Rd +++ b/man/tm_g_km.Rd @@ -42,7 +42,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -69,16 +69,16 @@ available choices and preselected option for the censoring variable.} \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ diff --git a/man/tm_g_lineplot.Rd b/man/tm_g_lineplot.Rd index 681d10c06a..664975ac36 100644 --- a/man/tm_g_lineplot.Rd +++ b/man/tm_g_lineplot.Rd @@ -84,19 +84,19 @@ or point and line (\code{pl}).} \item{table_font_size}{(\code{integer} or \code{double})\cr controls the font size of values in the table.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. For this module, this argument will only accept \code{ggplot2_args} object with \code{labs} list of following child elements: \code{title}, \code{subtitle}, \code{caption}, \code{y}, \code{lty}. No other elements would be taken into account. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in diff --git a/man/tm_g_pp_adverse_events.Rd b/man/tm_g_pp_adverse_events.Rd index 2e1f4ee24f..36f1649ba2 100644 --- a/man/tm_g_pp_adverse_events.Rd +++ b/man/tm_g_pp_adverse_events.Rd @@ -56,19 +56,19 @@ available choices and preselected option for the \code{AEDECOD} variable from \c \item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_pp_patient_timeline.Rd b/man/tm_g_pp_patient_timeline.Rd index 535d860e6e..7c20e004cc 100644 --- a/man/tm_g_pp_patient_timeline.Rd +++ b/man/tm_g_pp_patient_timeline.Rd @@ -71,19 +71,19 @@ with all available choices and preselected option for the \code{AENDY} variable \item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_pp_therapy.Rd b/man/tm_g_pp_therapy.Rd index 914eead236..b68226f9c3 100644 --- a/man/tm_g_pp_therapy.Rd +++ b/man/tm_g_pp_therapy.Rd @@ -68,19 +68,19 @@ available choices and preselected option for the \code{CMENDY} variable from \co \item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_g_pp_vitals.Rd b/man/tm_g_pp_vitals.Rd index bea5a275d0..819cfa4aed 100644 --- a/man/tm_g_pp_vitals.Rd +++ b/man/tm_g_pp_vitals.Rd @@ -43,19 +43,19 @@ available choices and preselected option for the time variable from \code{datana \item{font_size}{(\code{numeric})\cr numeric vector of length 3 of current, minimum and maximum font size values.} -\item{plot_height}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the +\item{plot_height}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.} -\item{plot_width}{optional, (\code{numeric})\cr a vector of length three with \code{c(value, min, max)}. Specifies the width +\item{plot_width}{(\code{numeric}) optional,\cr a vector of length three with \code{c(value, min, max)}. Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{ggplot2_args}{optional, (\code{ggplot2_args})\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings +\item{ggplot2_args}{(\code{ggplot2_args}) optional,\cr object created by \code{\link[teal.widgets:ggplot2_args]{teal.widgets::ggplot2_args()}} with settings for the module plot. The argument is merged with option \code{teal.ggplot2_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-ggplot2-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_abnormality.Rd b/man/tm_t_abnormality.Rd index cee4405f1a..bc29d1ebc7 100644 --- a/man/tm_t_abnormality.Rd +++ b/man/tm_t_abnormality.Rd @@ -79,15 +79,15 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} \item{na_level}{(\code{character})\cr the NA level in the input dataset, default to \code{""}.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_abnormality_by_worst_grade.Rd b/man/tm_t_abnormality_by_worst_grade.Rd index cef4a0e757..9397527c5f 100644 --- a/man/tm_t_abnormality_by_worst_grade.Rd +++ b/man/tm_t_abnormality_by_worst_grade.Rd @@ -75,13 +75,13 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_ancova.Rd b/man/tm_t_ancova.Rd index 37f6915035..7647e4e9e6 100644 --- a/man/tm_t_ancova.Rd +++ b/man/tm_t_ancova.Rd @@ -38,7 +38,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -68,13 +68,13 @@ available choices and preselected option for the parameter code variable from \c \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_binary_outcome.Rd b/man/tm_t_binary_outcome.Rd index b44b884ab9..d1d449846d 100644 --- a/man/tm_t_binary_outcome.Rd +++ b/man/tm_t_binary_outcome.Rd @@ -42,7 +42,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -79,13 +79,13 @@ apply in all modules, run \code{set_default_total_label("new_default")}.} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_coxreg.Rd b/man/tm_t_coxreg.Rd index 8bde57a3cf..96fa487448 100644 --- a/man/tm_t_coxreg.Rd +++ b/man/tm_t_coxreg.Rd @@ -40,7 +40,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -71,13 +71,13 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_events.Rd b/man/tm_t_events.Rd index 4a28261ed3..afab8efe1b 100644 --- a/man/tm_t_events.Rd +++ b/man/tm_t_events.Rd @@ -78,13 +78,13 @@ user input for this parameter is ignored.} \item{incl_overall_sum}{(\code{flag})\cr whether two rows which summarize the overall number of adverse events should be included at the top of the table.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_events_by_grade.Rd b/man/tm_t_events_by_grade.Rd index eb1ab30816..057f746680 100644 --- a/man/tm_t_events_by_grade.Rd +++ b/man/tm_t_events_by_grade.Rd @@ -72,13 +72,13 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_events_patyear.Rd b/man/tm_t_events_patyear.Rd index d0909842b3..60a4f86180 100644 --- a/man/tm_t_events_patyear.Rd +++ b/man/tm_t_events_patyear.Rd @@ -70,13 +70,13 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_events_summary.Rd b/man/tm_t_events_summary.Rd index 93c17647ce..76099d58d3 100644 --- a/man/tm_t_events_summary.Rd +++ b/man/tm_t_events_summary.Rd @@ -88,13 +88,13 @@ event flag variables are provided.} \item{count_events}{(\code{logical})\cr whether to show count of events (based on \code{aeseq_var}). Only applies if event flag variables are provided.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_exposure.Rd b/man/tm_t_exposure.Rd index 8f2a7d9304..f0b2d48e3c 100644 --- a/man/tm_t_exposure.Rd +++ b/man/tm_t_exposure.Rd @@ -81,13 +81,13 @@ enabled (see \code{add_total_row}).} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_logistic.Rd b/man/tm_t_logistic.Rd index 7e6289e2ae..4a26dbb6d8 100644 --- a/man/tm_t_logistic.Rd +++ b/man/tm_t_logistic.Rd @@ -35,7 +35,7 @@ the grouping variable(s) in the results table. If there are two elements selecte variable will be nested under the first variable. If \code{NULL}, no arm/treatment variable is included in the logistic model.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -53,13 +53,13 @@ available choices and preselected option for the analysis variable (categorical) \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_mult_events.Rd b/man/tm_t_mult_events.Rd index c330f2daaa..135df3f308 100644 --- a/man/tm_t_mult_events.Rd +++ b/man/tm_t_mult_events.Rd @@ -64,13 +64,13 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_pp_basic_info.Rd b/man/tm_t_pp_basic_info.Rd index 3a8cbd7311..d7cfa3251b 100644 --- a/man/tm_t_pp_basic_info.Rd +++ b/man/tm_t_pp_basic_info.Rd @@ -23,10 +23,10 @@ tm_t_pp_basic_info( \item{vars}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and preselected option for variables from \code{dataname} to show in the table.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ diff --git a/man/tm_t_pp_laboratory.Rd b/man/tm_t_pp_laboratory.Rd index 5cee5537bf..49cdf5df3e 100644 --- a/man/tm_t_pp_laboratory.Rd +++ b/man/tm_t_pp_laboratory.Rd @@ -53,10 +53,10 @@ available choices and preselected option for the parameter code variable from \c available choices and preselected option for the \code{ANRIND} variable from \code{dataname}. Variable should have the following 3 levels: \code{"HIGH"}, \code{"LOW"}, and \code{"NORMAL"}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ diff --git a/man/tm_t_pp_medical_history.Rd b/man/tm_t_pp_medical_history.Rd index 8a86715808..5bac57e68f 100644 --- a/man/tm_t_pp_medical_history.Rd +++ b/man/tm_t_pp_medical_history.Rd @@ -34,10 +34,10 @@ available choices and preselected option for the \code{MHBODSYS} variable from \ \item{mhdistat}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and preselected option for the \code{MHDISTAT} variable from \code{dataname}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ diff --git a/man/tm_t_pp_prior_medication.Rd b/man/tm_t_pp_prior_medication.Rd index 8bc56b9b99..5cdeea5d0e 100644 --- a/man/tm_t_pp_prior_medication.Rd +++ b/man/tm_t_pp_prior_medication.Rd @@ -38,10 +38,10 @@ available choices and preselected option for the \code{CMINDC} variable from \co \item{cmstdy}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and preselected option for the \code{CMSTDY} variable from \code{dataname}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ diff --git a/man/tm_t_shift_by_arm.Rd b/man/tm_t_shift_by_arm.Rd index 30e072cd3d..b72311e7a7 100644 --- a/man/tm_t_shift_by_arm.Rd +++ b/man/tm_t_shift_by_arm.Rd @@ -74,13 +74,13 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_shift_by_arm_by_worst.Rd b/man/tm_t_shift_by_arm_by_worst.Rd index 6eae9c7b10..d79c79b1b4 100644 --- a/man/tm_t_shift_by_arm_by_worst.Rd +++ b/man/tm_t_shift_by_arm_by_worst.Rd @@ -75,13 +75,13 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n enabled (see \code{add_total}). Defaults to \code{"All Patients"}. To set a new default \code{total_label} to apply in all modules, run \code{set_default_total_label("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_shift_by_grade.Rd b/man/tm_t_shift_by_grade.Rd index f93f46d215..c2a0fb3e45 100644 --- a/man/tm_t_shift_by_grade.Rd +++ b/man/tm_t_shift_by_grade.Rd @@ -83,10 +83,10 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} \item{na_level}{(\code{string})\cr used to replace all \code{NA} or empty values @@ -95,7 +95,7 @@ default \code{na_level} to apply in all modules, run \code{set_default_na_str("n \item{code_missing_baseline}{(\code{logical})\cr whether missing baseline grades should be counted as grade 0.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_smq.Rd b/man/tm_t_smq.Rd index 5efd8dbde6..341bfa638a 100644 --- a/man/tm_t_smq.Rd +++ b/man/tm_t_smq.Rd @@ -72,13 +72,13 @@ available choices and preselected options for standardized/customized queries.} \item{scopes}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices for the scopes of standardized queries.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_summary.Rd b/man/tm_t_summary.Rd index e43dc9a94d..8d894c54a0 100644 --- a/man/tm_t_summary.Rd +++ b/man/tm_t_summary.Rd @@ -65,13 +65,13 @@ set to those used in the \code{dataname} dataset. If \code{FALSE}, \code{arm_var \code{parentname} dataset. If \code{dataname} and \code{parentname} are the same, then \code{drop_arm_levels} is set to \code{TRUE} and user input for this parameter is ignored.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_summary_by.Rd b/man/tm_t_summary_by.Rd index 713e889a52..88204b8982 100644 --- a/man/tm_t_summary_by.Rd +++ b/man/tm_t_summary_by.Rd @@ -88,13 +88,13 @@ user input for this parameter is ignored.} \item{drop_zero_levels}{(\code{logical})\cr whether rows with zero counts in all columns should be removed from the table.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.} diff --git a/man/tm_t_tte.Rd b/man/tm_t_tte.Rd index 2b6082a3cf..c3a424cb72 100644 --- a/man/tm_t_tte.Rd +++ b/man/tm_t_tte.Rd @@ -47,7 +47,7 @@ It defines the grouping variable(s) in the results table. If there are two elements selected for \code{arm_var}, second variable will be nested under the first variable.} -\item{arm_ref_comp}{optional, (\code{list})\cr If specified it must be a named list with each element corresponding to +\item{arm_ref_comp}{(\code{list}) optional,\cr If specified it must be a named list with each element corresponding to an arm variable in \code{ADSL} and the element must be another list (possibly with delayed \code{\link[teal.transform:variable_choices]{teal.transform::variable_choices()}} or delayed \code{\link[teal.transform:value_choices]{teal.transform::value_choices()}} with the elements named \code{ref} and \code{comp} that the defined the default @@ -90,13 +90,13 @@ apply in all modules, run \code{set_default_total_label("new_default")}.} in character or factor variables in the data. Defaults to \code{""}. To set a default \code{na_level} to apply in all modules, run \code{set_default_na_str("new_default")}.} -\item{pre_output}{optional, (\code{shiny.tag})\cr with text placed before the output to put the output into context. +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{optional, (\code{shiny.tag})\cr with text placed after the output to put the output into context. +\item{post_output}{(\code{shiny.tag}) optional,\cr with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} -\item{basic_table_args}{optional, (\code{basic_table_args})\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} +\item{basic_table_args}{(\code{basic_table_args}) optional,\cr object created by \code{\link[teal.widgets:basic_table_args]{teal.widgets::basic_table_args()}} with settings for the module table. The argument is merged with option \code{teal.basic_table_args} and with default module arguments (hard coded in the module body). For more details, see the vignette: \code{vignette("custom-basic-table-arguments", package = "teal.widgets")}.}