diff --git a/DESCRIPTION b/DESCRIPTION index 723621361..f4f89858e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -88,4 +88,4 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.0 +RoxygenNote: 7.3.1 diff --git a/man/tm_a_pca.Rd b/man/tm_a_pca.Rd index b8f1359ce..c0e5029a0 100644 --- a/man/tm_a_pca.Rd +++ b/man/tm_a_pca.Rd @@ -21,6 +21,9 @@ 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{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 119e2c288..5c4c627c3 100644 --- a/man/tm_a_regression.Rd +++ b/man/tm_a_regression.Rd @@ -22,6 +22,9 @@ 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{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 143bf386d..50a525ee2 100644 --- a/man/tm_data_table.Rd +++ b/man/tm_data_table.Rd @@ -17,6 +17,9 @@ 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{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 of the datasets available in the app. If no entry is specified for a dataset, the first six variables from that diff --git a/man/tm_file_viewer.Rd b/man/tm_file_viewer.Rd index b982a438a..295be4cf4 100644 --- a/man/tm_file_viewer.Rd +++ b/man/tm_file_viewer.Rd @@ -10,6 +10,9 @@ 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{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 directory of the application. Will default to current working directory if not supplied.} diff --git a/man/tm_front_page.Rd b/man/tm_front_page.Rd index eb70be881..a6affbb21 100644 --- a/man/tm_front_page.Rd +++ b/man/tm_front_page.Rd @@ -14,6 +14,9 @@ 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{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 element's header is displayed larger than the others} diff --git a/man/tm_g_association.Rd b/man/tm_g_association.Rd index 10111d491..34f610788 100644 --- a/man/tm_g_association.Rd +++ b/man/tm_g_association.Rd @@ -21,6 +21,9 @@ 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{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 68286daa2..c2d02e516 100644 --- a/man/tm_g_bivariate.Rd +++ b/man/tm_g_bivariate.Rd @@ -30,6 +30,9 @@ 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{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. No empty selections are allowed!} diff --git a/man/tm_g_distribution.Rd b/man/tm_g_distribution.Rd index 85ac70573..d736e2acf 100644 --- a/man/tm_g_distribution.Rd +++ b/man/tm_g_distribution.Rd @@ -21,6 +21,9 @@ 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{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 67a1c3ca3..be6437d07 100644 --- a/man/tm_g_response.Rd +++ b/man/tm_g_response.Rd @@ -24,6 +24,9 @@ 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{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 setting \code{fixed = TRUE} inside the \code{select_spec}. diff --git a/man/tm_g_scatterplot.Rd b/man/tm_g_scatterplot.Rd index 354b34fdb..6c9105d1a 100644 --- a/man/tm_g_scatterplot.Rd +++ b/man/tm_g_scatterplot.Rd @@ -28,6 +28,9 @@ 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{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 87da075c7..37920464b 100644 --- a/man/tm_g_scatterplotmatrix.Rd +++ b/man/tm_g_scatterplotmatrix.Rd @@ -14,6 +14,9 @@ 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{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 \code{data_extract_spec} use \code{select_spec(..., ordered = TRUE)} if plot elements should be diff --git a/man/tm_missing_data.Rd b/man/tm_missing_data.Rd index ee5c013b6..d4b11b542 100644 --- a/man/tm_missing_data.Rd +++ b/man/tm_missing_data.Rd @@ -19,6 +19,9 @@ 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{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 3986615e7..d7be32c9f 100644 --- a/man/tm_outliers.Rd +++ b/man/tm_outliers.Rd @@ -18,6 +18,9 @@ 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{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 eba7f7f72..4ff06a29c 100644 --- a/man/tm_t_crosstable.Rd +++ b/man/tm_t_crosstable.Rd @@ -16,6 +16,9 @@ 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{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 of \code{data_extract_spec} use \code{select_spec(..., ordered = TRUE)} if table elements should be diff --git a/man/tm_variable_browser.Rd b/man/tm_variable_browser.Rd index 189b708ea..7430efbf5 100644 --- a/man/tm_variable_browser.Rd +++ b/man/tm_variable_browser.Rd @@ -20,6 +20,9 @@ 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{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. If vector of length zero (default) then all datasets are shown.