diff --git a/DESCRIPTION b/DESCRIPTION index 0971466d13..066903b0b6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: teal Title: Exploratory Web Apps for Analyzing Clinical Trials Data -Version: 0.15.2.9091 -Date: 2024-11-29 +Version: 0.15.2.9093 +Date: 2024-12-18 Authors@R: c( person("Dawid", "Kaledkowski", , "dawid.kaledkowski@roche.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9533-457X")), diff --git a/NEWS.md b/NEWS.md index 9e8dd1a3b0..3fde447627 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# teal 0.15.2.9091 +# teal 0.15.2.9093 ### New features 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. diff --git a/README.md b/README.md index af9af3ba78..f4f3c0e066 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# `teal`: Interactive Exploratory Data Analysis with `Shiny` Web-Applications +# `teal`: Interactive Exploratory Data Analysis with `Shiny` Web-Applications [![CRAN Version](https://www.r-pkg.org/badges/version/teal?color=green)](https://cran.r-project.org/package=teal) diff --git a/man/TealReportCard.Rd b/man/TealReportCard.Rd index efeb681258..061dbb73ba 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. @@ -45,6 +45,7 @@ card$get_content()[[1]]$get_content()
Inherited methods