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] 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