diff --git a/DESCRIPTION b/DESCRIPTION index 27ca55e99..bf3c44d0e 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -15,6 +15,9 @@ Authors@R: c( ) Description: General Purpose Teal Modules. License: Apache License 2.0 | file LICENSE +URL: https://insightsengineering.github.io/teal.modules.general/, + https://github.com/insightsengineering/teal.modules.general/ +BugReports: https://github.com/insightsengineering/teal.modules.general/issues Depends: ggmosaic (>= 0.3.0), ggplot2 (>= 3.4.0), @@ -87,4 +90,4 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 diff --git a/inst/WORDLIST b/inst/WORDLIST index 705735bb7..6815d0d95 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,6 +1,8 @@ Forkers +Hoffmann TLG facetting +funder pre repo reproducibility diff --git a/man/teal.modules.general.Rd b/man/teal.modules.general.Rd index 14eb0e2fe..4a9330dab 100644 --- a/man/teal.modules.general.Rd +++ b/man/teal.modules.general.Rd @@ -2,10 +2,39 @@ % Please edit documentation in R/teal.modules.general.R \docType{package} \name{teal.modules.general} +\alias{teal.modules.general-package} \alias{teal.modules.general} \title{teal.modules.general: General modules to add to a teal application} \description{ The modules in this package are generic modules that should work with any data set (not necessarily for clinical trials data). +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://insightsengineering.github.io/teal.modules.general/} + \item \url{https://github.com/insightsengineering/teal.modules.general/} + \item Report bugs at \url{https://github.com/insightsengineering/teal.modules.general/issues} +} + +} +\author{ +\strong{Maintainer}: Dawid Kaledkowski \email{dawid.kaledkowski@roche.com} + +Authors: +\itemize{ + \item Pawel Rucki \email{pawel.rucki@roche.com} + \item Mahmoud Hallal \email{mahmoud.hallal@roche.com} + \item Maciej Nasinski + \item Konrad Pagacz + \item Nikolas Burkoff +} + +Other contributors: +\itemize{ + \item Ondrej Slama \email{ondrej.slama@roche.com} [contributor] + \item F. Hoffmann-La Roche AG [copyright holder, funder] +} + } \keyword{internal} diff --git a/man/tm_a_pca.Rd b/man/tm_a_pca.Rd index d0e4eb8ab..bf8eadfd8 100644 --- a/man/tm_a_pca.Rd +++ b/man/tm_a_pca.Rd @@ -21,8 +21,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 \link[teal]{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 028978d7d..d4700b3cb 100644 --- a/man/tm_a_regression.Rd +++ b/man/tm_a_regression.Rd @@ -22,8 +22,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 \link[teal]{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 3f64e26b6..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 \link[teal]{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 db3cffb1f..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 \link[teal]{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 ceb61fb3f..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 \link[teal]{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 96a8f31a8..a765bd2ef 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 \link[teal]{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 cdcd38fb3..430b6894a 100644 --- a/man/tm_g_bivariate.Rd +++ b/man/tm_g_bivariate.Rd @@ -30,8 +30,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 \link[teal]{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 edd47d618..6be2badf0 100644 --- a/man/tm_g_distribution.Rd +++ b/man/tm_g_distribution.Rd @@ -21,8 +21,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 \link[teal]{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 ae16fde07..9df112bda 100644 --- a/man/tm_g_response.Rd +++ b/man/tm_g_response.Rd @@ -24,8 +24,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 \link[teal]{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 46a0f8170..ecd33de66 100644 --- a/man/tm_g_scatterplot.Rd +++ b/man/tm_g_scatterplot.Rd @@ -28,8 +28,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 \link[teal]{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 a43190fa5..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 \link[teal]{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 f39d398d2..73438aa4f 100644 --- a/man/tm_missing_data.Rd +++ b/man/tm_missing_data.Rd @@ -19,8 +19,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 \link[teal]{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 a3d013200..dd262f2ab 100644 --- a/man/tm_outliers.Rd +++ b/man/tm_outliers.Rd @@ -18,8 +18,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 \link[teal]{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 668380fa5..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 \link[teal]{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 3c79fe6fd..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 \link[teal]{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.