From 4489e80fdc750d4ae3c8f1a9a8858c55e95be69a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Wed, 11 Dec 2024 16:41:55 +0100 Subject: [PATCH 1/2] Fix links --- R/init.R | 2 +- R/module_init_data.R | 2 +- R/module_teal_data.R | 10 +++++----- R/teal_reporter.R | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/init.R b/R/init.R index 3f27eb385e..24ca5e0ef1 100644 --- a/R/init.R +++ b/R/init.R @@ -11,7 +11,7 @@ #' `teal` app that is composed of `teal` modules. #' #' @param data (`teal_data` or `teal_data_module`) -#' For constructing the data object, refer to [teal_data()] and [teal_data_module()]. +#' For constructing the data object, refer to [teal.data::teal_data()] and [teal_data_module()]. #' If `datanames` are not set for the `teal_data` object, defaults from the `teal_data` environment will be used. #' @param modules (`list` or `teal_modules` or `teal_module`) #' Nested list of `teal_modules` or `teal_module` objects or a single diff --git a/R/module_init_data.R b/R/module_init_data.R index 4963587e94..3bbe7d8bb2 100644 --- a/R/module_init_data.R +++ b/R/module_init_data.R @@ -1,6 +1,6 @@ #' Data Module for teal #' -#' This module manages the `data` argument for `srv_teal`. The `teal` framework uses [teal_data()], +#' This module manages the `data` argument for `srv_teal`. The `teal` framework uses [teal.data::teal_data()], #' which can be provided in various ways: #' 1. Directly as a [teal.data::teal_data()] object. This will automatically convert it into a `reactive` `teal_data`. #' 2. As a `reactive` object that returns a [teal.data::teal_data()] object. diff --git a/R/module_teal_data.R b/R/module_teal_data.R index 056c2ffdcc..bc8d92239b 100644 --- a/R/module_teal_data.R +++ b/R/module_teal_data.R @@ -3,17 +3,17 @@ #' This is a low level module to handle `teal_data_module` execution and validation. #' [teal_transform_module()] inherits from [teal_data_module()] so it is handled by this module too. #' [srv_teal()] accepts various `data` objects and eventually they are all transformed to `reactive` -#' [teal_data()] which is a standard data class in whole `teal` framework. +#' [teal.data::teal_data()] which is a standard data class in whole `teal` framework. #' #' @section data validation: #' #' Executed [teal_data_module()] is validated and output is validated for consistency. #' Output `data` is invalid if: #' 1. [teal_data_module()] is invalid if server doesn't return `reactive`. **Immediately crashes an app!** -#' 2. `reactive` throws a `shiny.error` - happens when module creating [teal_data()] fails. -#' 3. `reactive` returns `qenv.error` - happens when [teal_data()] evaluates a failing code. -#' 4. `reactive` object doesn't return [teal_data()]. -#' 5. [teal_data()] object lacks any `datanames` specified in the `modules` argument. +#' 2. `reactive` throws a `shiny.error` - happens when module creating [teal.data::teal_data()] fails. +#' 3. `reactive` returns `qenv.error` - happens when [teal.data::teal_data()] evaluates a failing code. +#' 4. `reactive` object doesn't return [teal.data::teal_data()]. +#' 5. [teal.data::teal_data()] object lacks any `datanames` specified in the `modules` argument. #' #' `teal` (observers in `srv_teal`) always waits to render an app until `reactive` `teal_data` is #' returned. If error 2-4 occurs, relevant error message is displayed to the app user. Once the issue is diff --git a/R/teal_reporter.R b/R/teal_reporter.R index 6a89331410..ad5f04189b 100644 --- a/R/teal_reporter.R +++ b/R/teal_reporter.R @@ -1,6 +1,6 @@ #' @title `TealReportCard` #' @description `r lifecycle::badge("experimental")` -#' Child class of [`ReportCard`] that is used for `teal` specific applications. +#' Child class of [`teal.reporter::ReportCard`] that is used for `teal` specific applications. #' In addition to the parent methods, it supports rendering `teal` specific elements such as #' the source code, the encodings panel content and the filter panel content as part of the #' meta data. From 48f3ce104ce7db872bbaa4e657063acd8abb9ba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Wed, 11 Dec 2024 16:57:03 +0100 Subject: [PATCH 2/2] Update documentation --- man/TealReportCard.Rd | 2 +- man/init.Rd | 2 +- man/module_init_data.Rd | 2 +- man/module_teal_data.Rd | 10 +++++----- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/man/TealReportCard.Rd b/man/TealReportCard.Rd index efeb681258..2503d00354 100644 --- a/man/TealReportCard.Rd +++ b/man/TealReportCard.Rd @@ -5,7 +5,7 @@ \title{\code{TealReportCard}} \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -Child class of \code{\link{ReportCard}} that is used for \code{teal} specific applications. +Child class of \code{\link[teal.reporter:ReportCard]{teal.reporter::ReportCard}} that is used for \code{teal} specific applications. In addition to the parent methods, it supports rendering \code{teal} specific elements such as the source code, the encodings panel content and the filter panel content as part of the meta data. diff --git a/man/init.Rd b/man/init.Rd index 328c0b9179..cf5a171764 100644 --- a/man/init.Rd +++ b/man/init.Rd @@ -17,7 +17,7 @@ init( } \arguments{ \item{data}{(\code{teal_data} or \code{teal_data_module}) -For constructing the data object, refer to \code{\link[=teal_data]{teal_data()}} and \code{\link[=teal_data_module]{teal_data_module()}}. +For constructing the data object, refer to \code{\link[teal.data:teal_data]{teal.data::teal_data()}} and \code{\link[=teal_data_module]{teal_data_module()}}. If \code{datanames} are not set for the \code{teal_data} object, defaults from the \code{teal_data} environment will be used.} \item{modules}{(\code{list} or \code{teal_modules} or \code{teal_module}) diff --git a/man/module_init_data.Rd b/man/module_init_data.Rd index 7e9cd8b715..d7f80be5aa 100644 --- a/man/module_init_data.Rd +++ b/man/module_init_data.Rd @@ -24,7 +24,7 @@ Output of the \code{data}. If \code{data} fails then returned error is handled ( rest of the application can respond to this respectively. } \description{ -This module manages the \code{data} argument for \code{srv_teal}. The \code{teal} framework uses \code{\link[=teal_data]{teal_data()}}, +This module manages the \code{data} argument for \code{srv_teal}. The \code{teal} framework uses \code{\link[teal.data:teal_data]{teal.data::teal_data()}}, which can be provided in various ways: \enumerate{ \item Directly as a \code{\link[teal.data:teal_data]{teal.data::teal_data()}} object. This will automatically convert it into a \code{reactive} \code{teal_data}. diff --git a/man/module_teal_data.Rd b/man/module_teal_data.Rd index 4f700e8596..9c2e756b5b 100644 --- a/man/module_teal_data.Rd +++ b/man/module_teal_data.Rd @@ -50,7 +50,7 @@ and display a generic failure message.} This is a low level module to handle \code{teal_data_module} execution and validation. \code{\link[=teal_transform_module]{teal_transform_module()}} inherits from \code{\link[=teal_data_module]{teal_data_module()}} so it is handled by this module too. \code{\link[=srv_teal]{srv_teal()}} accepts various \code{data} objects and eventually they are all transformed to \code{reactive} -\code{\link[=teal_data]{teal_data()}} which is a standard data class in whole \code{teal} framework. +\code{\link[teal.data:teal_data]{teal.data::teal_data()}} which is a standard data class in whole \code{teal} framework. } \section{data validation}{ @@ -59,10 +59,10 @@ Executed \code{\link[=teal_data_module]{teal_data_module()}} is validated and ou Output \code{data} is invalid if: \enumerate{ \item \code{\link[=teal_data_module]{teal_data_module()}} is invalid if server doesn't return \code{reactive}. \strong{Immediately crashes an app!} -\item \code{reactive} throws a \code{shiny.error} - happens when module creating \code{\link[=teal_data]{teal_data()}} fails. -\item \code{reactive} returns \code{qenv.error} - happens when \code{\link[=teal_data]{teal_data()}} evaluates a failing code. -\item \code{reactive} object doesn't return \code{\link[=teal_data]{teal_data()}}. -\item \code{\link[=teal_data]{teal_data()}} object lacks any \code{datanames} specified in the \code{modules} argument. +\item \code{reactive} throws a \code{shiny.error} - happens when module creating \code{\link[teal.data:teal_data]{teal.data::teal_data()}} fails. +\item \code{reactive} returns \code{qenv.error} - happens when \code{\link[teal.data:teal_data]{teal.data::teal_data()}} evaluates a failing code. +\item \code{reactive} object doesn't return \code{\link[teal.data:teal_data]{teal.data::teal_data()}}. +\item \code{\link[teal.data:teal_data]{teal.data::teal_data()}} object lacks any \code{datanames} specified in the \code{modules} argument. } \code{teal} (observers in \code{srv_teal}) always waits to render an app until \code{reactive} \code{teal_data} is