From 614397c2afd904dd3713e23e081261bce4075d32 Mon Sep 17 00:00:00 2001 From: "27856297+dependabot-preview[bot]@users.noreply.github.com" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Wed, 14 Feb 2024 16:49:03 +0000 Subject: [PATCH] [skip actions] Roxygen Man Pages Auto Update --- man/tm_a_pca.Rd | 4 ++-- man/tm_a_regression.Rd | 4 ++-- man/tm_data_table.Rd | 4 ++-- man/tm_file_viewer.Rd | 4 ++-- man/tm_front_page.Rd | 4 ++-- man/tm_g_association.Rd | 4 ++-- man/tm_g_bivariate.Rd | 4 ++-- man/tm_g_distribution.Rd | 4 ++-- man/tm_g_response.Rd | 4 ++-- man/tm_g_scatterplot.Rd | 4 ++-- man/tm_g_scatterplotmatrix.Rd | 4 ++-- man/tm_missing_data.Rd | 4 ++-- man/tm_outliers.Rd | 4 ++-- man/tm_t_crosstable.Rd | 4 ++-- man/tm_variable_browser.Rd | 4 ++-- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/man/tm_a_pca.Rd b/man/tm_a_pca.Rd index 745bcd36e..e01bdbe27 100644 --- a/man/tm_a_pca.Rd +++ b/man/tm_a_pca.Rd @@ -20,8 +20,8 @@ tm_a_pca( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{dat}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Columns used to compute PCA.} diff --git a/man/tm_a_regression.Rd b/man/tm_a_regression.Rd index 8a4182664..a52ea262c 100644 --- a/man/tm_a_regression.Rd +++ b/man/tm_a_regression.Rd @@ -21,8 +21,8 @@ tm_a_regression( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{regressor}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Regressor variables from an incoming dataset with filtering and selecting.} diff --git a/man/tm_data_table.Rd b/man/tm_data_table.Rd index ecd5982f1..bec8cde63 100644 --- a/man/tm_data_table.Rd +++ b/man/tm_data_table.Rd @@ -17,8 +17,8 @@ tm_data_table( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{variables_selected}{(\code{list}) A named list of character vectors of the variables (i.e. columns) which should be initially shown for each dataset. Names of list elements should correspond to the names diff --git a/man/tm_file_viewer.Rd b/man/tm_file_viewer.Rd index c38c5fd15..a1be536fb 100644 --- a/man/tm_file_viewer.Rd +++ b/man/tm_file_viewer.Rd @@ -10,8 +10,8 @@ tm_file_viewer( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{input_path}{optional, (\code{list}) of the input paths to either: specific files of accepted formats, a directory or a URL. The paths can be specified as absolute paths or relative to the running diff --git a/man/tm_front_page.Rd b/man/tm_front_page.Rd index 66e17acb0..0efa390d0 100644 --- a/man/tm_front_page.Rd +++ b/man/tm_front_page.Rd @@ -14,8 +14,8 @@ tm_front_page( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{header_text}{\verb{character vector} text to be shown at the top of the module, for each element, if named the name is shown first in bold as a header followed by the value. The first diff --git a/man/tm_g_association.Rd b/man/tm_g_association.Rd index 7cbc13945..321d1d175 100644 --- a/man/tm_g_association.Rd +++ b/man/tm_g_association.Rd @@ -21,8 +21,8 @@ tm_g_association( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{ref}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) reference variable, must set \code{multiple = FALSE}.} diff --git a/man/tm_g_bivariate.Rd b/man/tm_g_bivariate.Rd index 82e6bf9b5..12a90c52f 100644 --- a/man/tm_g_bivariate.Rd +++ b/man/tm_g_bivariate.Rd @@ -29,8 +29,8 @@ tm_g_bivariate( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{x}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Variable names selected to plot along the x-axis by default. Variable can be numeric, factor or character. diff --git a/man/tm_g_distribution.Rd b/man/tm_g_distribution.Rd index 676140a02..a82403274 100644 --- a/man/tm_g_distribution.Rd +++ b/man/tm_g_distribution.Rd @@ -20,8 +20,8 @@ tm_g_distribution( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{dist_var}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Variable to consider for the distribution analysis.} diff --git a/man/tm_g_response.Rd b/man/tm_g_response.Rd index ed92b2148..6d0986c2f 100644 --- a/man/tm_g_response.Rd +++ b/man/tm_g_response.Rd @@ -23,8 +23,8 @@ tm_g_response( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{response}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Which variable to use as the response. You can define one fixed column by using the diff --git a/man/tm_g_scatterplot.Rd b/man/tm_g_scatterplot.Rd index bd9873661..1c742cac2 100644 --- a/man/tm_g_scatterplot.Rd +++ b/man/tm_g_scatterplot.Rd @@ -27,8 +27,8 @@ tm_g_scatterplot( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{x}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Variable names selected to plot along the x-axis by default.} diff --git a/man/tm_g_scatterplotmatrix.Rd b/man/tm_g_scatterplotmatrix.Rd index 202ea0583..0bc3b8782 100644 --- a/man/tm_g_scatterplotmatrix.Rd +++ b/man/tm_g_scatterplotmatrix.Rd @@ -14,8 +14,8 @@ tm_g_scatterplotmatrix( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{variables}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Plotting variables from an incoming dataset with filtering and selecting. In case of diff --git a/man/tm_missing_data.Rd b/man/tm_missing_data.Rd index 8d7edacdb..c8cc46e2e 100644 --- a/man/tm_missing_data.Rd +++ b/man/tm_missing_data.Rd @@ -18,8 +18,8 @@ tm_missing_data( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{plot_height}{optional, (\code{numeric}) A vector of length three with \verb{c(value, min and max)} for a slider encoding the plot height.} diff --git a/man/tm_outliers.Rd b/man/tm_outliers.Rd index e10085814..8c140e81d 100644 --- a/man/tm_outliers.Rd +++ b/man/tm_outliers.Rd @@ -17,8 +17,8 @@ tm_outliers( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{outlier_var}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) variable to consider for the outliers analysis.} diff --git a/man/tm_t_crosstable.Rd b/man/tm_t_crosstable.Rd index b17bb2f94..d7cf28179 100644 --- a/man/tm_t_crosstable.Rd +++ b/man/tm_t_crosstable.Rd @@ -16,8 +16,8 @@ tm_t_crosstable( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{x}{(\code{data_extract_spec} or \code{list} of multiple \code{data_extract_spec}) Object with all available choices with pre-selected option for variable X - row values. In case diff --git a/man/tm_variable_browser.Rd b/man/tm_variable_browser.Rd index 511b8ee99..5b12bd007 100644 --- a/man/tm_variable_browser.Rd +++ b/man/tm_variable_browser.Rd @@ -20,8 +20,8 @@ tm_variable_browser( ) } \arguments{ -\item{label}{(\code{character(1)}) Label shown in the navigation item for the module. Any label possible except -\code{"global_filters"} - read more in \code{mapping} argument of \code{\link[teal:teal_slices]{teal_slices()}}.} +\item{label}{(\code{character(1)}) Label shown in the navigation item for the module or module group. +For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item{datasets_selected}{(\code{character}) A vector of datasets which should be shown and in what order. Names in the vector have to correspond with datasets names.