The documentation to this function lists all the arguments in teal modules that are used repeatedly to express an analysis.
a teal_module object.
optional, (list)
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
reference and comparison arms when the arm variable is changed.
(teal.transform::choices_selected())
object with all
available choices and preselected option for variable names that can be used as arm_var.
It defines the grouping variable(s) in the results table.
If there are two elements selected for arm_var,
second variable will be nested under the first variable.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the ATIREL variable from dataname.
(teal.transform::choices_selected())
object with
all available choices and pre-selected option for the analysis variable.
(teal.transform::choices_selected())
object with
all available choices and preselected option for the analysis unit variable.
(teal.transform::choices_selected())
value of analysis
visit AVISIT of interest.
(teal.transform::choices_selected())
object with
all available choices and preselected option for variable values that can be used as baseline_var.
(teal.transform::choices_selected())
object with all
available choices and preselected option for variable names used to split the summary by rows.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the CMDECOD variable from dataname.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the CMINDC variable from dataname.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the CMSTDY variable from dataname.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the censoring variable.
(teal.transform::choices_selected())
object with
all available choices and pre-selected option for the confidence level, each within range of (0, 1).
(teal.transform::choices_selected())
object with all
available choices and preselected option for the covariates variables.
(character)
analysis data used in teal module.
(list or character)
defines
the default codes for the response variable in the module per value of paramcd.
A passed vector is transmitted for all paramcd values. A passed list must be named
and contain arrays, each name corresponding to a single value of paramcd. Each array
may contain default response values or named arrays rsp of default selected response
values and levels of default level choices.
(logical)
When (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.
(numeric)
numeric vector of length 3 of current, minimum and maximum font size values.
(teal.transform::choices_selected())
name of the variable
with high level term for events.
(teal.transform::choices_selected())
object specifying
the variable name for subject id.
(character)
name of the variable that should have interactions
with arm. If the interaction is not needed, the default option is NULL.
(character)
a selected item from the interact_var column which will be used
to select the specific ANCOVA results when interact_var is discrete. If the interaction is not
needed, the default option is FALSE.
(character)
menu item label of the module in the teal app.
(teal.transform::choices_selected())
name of the variable
with low level term for events.
(teal.transform::choices_selected())
object with all
available choices and preselected option for the parameter code variable from dataname.
(character)
parent analysis data used in teal module, usually this refers to ADSL.
(character)
name of patient ID variable.
optional, (numeric)
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.
optional, (numeric)
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.
optional, (shiny.tag)
with text placed after the output to put the output into context.
For example the shiny::helpText() elements are useful.
optional, (shiny.tag)
with text placed before the output to put the output into context.
For example a title.
(teal.transform::choices_selected())
names of
the variables for stratified analysis.
(teal.transform::choices_selected())
names of
the variables that should be summarized.
(teal.transform::choices_selected())
object with
all available choices and preselected option for variable names that can be used as the default subgroups.
(teal.transform::choices_selected())
object with all available choices and preselected option
for time points that can be used in tern::surv_timepoint().
(teal.transform::choices_selected())
object
with all available choices and pre-selected option for the time unit variable.
(teal.transform::choices_selected())
value
indicating on treatment records in treatment_flag_var.
(teal.transform::choices_selected())
on
treatment flag variable.
(character)
whether missing data (NA) should be displayed as a level.
(teal.transform::choices_selected())
object with
all available choices and preselected option for variable names that can be used as visit variable.
Must be a factor in dataname.
(teal.transform::choices_selected())
value indicating worst grade.
(teal.transform::choices_selected())
object
with all available choices and preselected option for variable names that can be used as worst flag variable.
Although this function just returns NULL it has two uses, for
the teal module users it provides a documentation of arguments that are
commonly and consistently used in the framework. For the developer it adds a
single reference point to import the roxygen argument description with:
@inheritParams module_arguments
Parameters with identical descriptions & input types to those in the Standard Template Arguments section are excluded to reduce duplication as each module function inherits parameters from its corresponding template function.
The TLG Catalog where additional example apps implementing this module can be found.