From bbd51d48e50852578adb011ffac154c5f3085b1d Mon Sep 17 00:00:00 2001 From: vedhav Date: Thu, 8 Feb 2024 18:44:55 +0530 Subject: [PATCH 1/2] chore: add url in description --- DESCRIPTION | 3 ++- man/argument_convention.Rd | 2 +- man/teal.osprey.Rd | 1 + man/tm_g_ae_oview.Rd | 2 +- man/tm_g_ae_sub.Rd | 2 +- man/tm_g_butterfly.Rd | 2 +- man/tm_g_events_term_id.Rd | 2 +- man/tm_g_heat_bygrade.Rd | 2 +- man/tm_g_patient_profile.Rd | 2 +- man/tm_g_spiderplot.Rd | 2 +- man/tm_g_swimlane.Rd | 2 +- man/tm_g_waterfall.Rd | 2 +- 12 files changed, 13 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index fabaff7e..33b579e4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -17,7 +17,8 @@ Description: Community efforts to collect teal modules for TLGs defined in the osprey package. The teal modules add an encoding panel to interactively change the encoding within teal. License: Apache License 2.0 | file LICENSE -URL: https://github.com/insightsengineering/teal.osprey/ +URL: https://insightsengineering.github.io/teal.osprey/, + https://github.com/insightsengineering/teal.osprey/ BugReports: https://github.com/insightsengineering/teal.osprey/issues Depends: osprey (>= 0.1.16), diff --git a/man/argument_convention.Rd b/man/argument_convention.Rd index e78a18e4..a85d149d 100644 --- a/man/argument_convention.Rd +++ b/man/argument_convention.Rd @@ -32,7 +32,7 @@ vector to indicate default value, minimum and maximum values.} vector to indicate default value, minimum and maximum values.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ The documentation to this function lists all the arguments in teal modules diff --git a/man/teal.osprey.Rd b/man/teal.osprey.Rd index 074b0e93..019f41c1 100644 --- a/man/teal.osprey.Rd +++ b/man/teal.osprey.Rd @@ -11,6 +11,7 @@ The \code{teal.osprey} R package contains interactive \code{\link{teal}} modules \seealso{ Useful links: \itemize{ + \item \url{https://insightsengineering.github.io/teal.osprey/} \item \url{https://github.com/insightsengineering/teal.osprey/} \item Report bugs at \url{https://github.com/insightsengineering/teal.osprey/issues} } diff --git a/man/tm_g_ae_oview.Rd b/man/tm_g_ae_oview.Rd index bddb9022..621c211a 100644 --- a/man/tm_g_ae_oview.Rd +++ b/man/tm_g_ae_oview.Rd @@ -43,7 +43,7 @@ vector to indicate default value, minimum and maximum values.} vector to indicate default value, minimum and maximum values.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_ae_sub.Rd b/man/tm_g_ae_sub.Rd index 3c478ca9..adf09e5b 100644 --- a/man/tm_g_ae_sub.Rd +++ b/man/tm_g_ae_sub.Rd @@ -41,7 +41,7 @@ Defines initial possible range of font-size. \code{fontsize} is set for plot.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_butterfly.Rd b/man/tm_g_butterfly.Rd index b0616c89..8c32d3c7 100644 --- a/man/tm_g_butterfly.Rd +++ b/man/tm_g_butterfly.Rd @@ -66,7 +66,7 @@ with text placed before the output to put the output into context. For example a into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_events_term_id.Rd b/man/tm_g_events_term_id.Rd index 29f0e296..c4f32148 100644 --- a/man/tm_g_events_term_id.Rd +++ b/man/tm_g_events_term_id.Rd @@ -42,7 +42,7 @@ vector to indicate default value, minimum and maximum values.} vector to indicate default value, minimum and maximum values.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_heat_bygrade.Rd b/man/tm_g_heat_bygrade.Rd index fab320a4..3350496c 100644 --- a/man/tm_g_heat_bygrade.Rd +++ b/man/tm_g_heat_bygrade.Rd @@ -68,7 +68,7 @@ vector to indicate default value, minimum and maximum values.} vector to indicate default value, minimum and maximum values.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_patient_profile.Rd b/man/tm_g_patient_profile.Rd index 2eb47413..29158bf4 100644 --- a/man/tm_g_patient_profile.Rd +++ b/man/tm_g_patient_profile.Rd @@ -89,7 +89,7 @@ with text placed before the output to put the output into context. For example a into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_spiderplot.Rd b/man/tm_g_spiderplot.Rd index ba09ae5f..7d1e44d5 100644 --- a/man/tm_g_spiderplot.Rd +++ b/man/tm_g_spiderplot.Rd @@ -69,7 +69,7 @@ with text placed before the output to put the output into context. For example a into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_swimlane.Rd b/man/tm_g_swimlane.Rd index 54a68ff4..98739fc2 100644 --- a/man/tm_g_swimlane.Rd +++ b/man/tm_g_swimlane.Rd @@ -73,7 +73,7 @@ into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} el \item{x_label}{the label of the x axis} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} diff --git a/man/tm_g_waterfall.Rd b/man/tm_g_waterfall.Rd index 34272416..b4fbc4a1 100644 --- a/man/tm_g_waterfall.Rd +++ b/man/tm_g_waterfall.Rd @@ -92,7 +92,7 @@ with text placed before the output to put the output into context. For example a into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} } \value{ -the \code{\link[teal:module]{teal::module()}} object. +the \code{\link[teal:teal_modules]{teal::module()}} object. } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} From ff24d204582005f3e85de13c5446f707064a556b Mon Sep 17 00:00:00 2001 From: vedhav Date: Fri, 9 Feb 2024 18:01:45 +0530 Subject: [PATCH 2/2] docs: fix warning from roxygen --- R/teal.osprey.R | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/R/teal.osprey.R b/R/teal.osprey.R index b0d9b508..88bac934 100644 --- a/R/teal.osprey.R +++ b/R/teal.osprey.R @@ -3,8 +3,7 @@ #' The \code{teal.osprey} R package contains interactive \code{\link{teal}} modules for the outputs #' #' @import dplyr osprey shiny teal formatters teal.transform -#' @docType package #' @name teal.osprey #' @keywords internal #' -NULL +"_PACKAGE"