From a265f5bb4be5d2e4ac433cf18947247c985c89e3 Mon Sep 17 00:00:00 2001 From: shikokuchuo <53399081+shikokuchuo@users.noreply.github.com> Date: Thu, 14 Dec 2023 12:06:20 +0000 Subject: [PATCH] update docs --- R/iplot.R | 6 ++---- R/oanda.R | 6 ++---- man/iplot.Rd | 6 ++---- man/oanda_studio.Rd | 6 ++---- 4 files changed, 8 insertions(+), 16 deletions(-) diff --git a/R/iplot.R b/R/iplot.R index 30409089..2f9e35f2 100644 --- a/R/iplot.R +++ b/R/iplot.R @@ -38,10 +38,8 @@ #' @return A Shiny app object with class 'shiny.appobj'. With default arguments, #' the Shiny app is launched in the default browser. #' -#' @details This function has a dependency on the 'shiny' package. -#' -#' For further details please refer to the reference vignette by calling: -#' \code{vignette("reference", package = "ichimoku")} +#' @details For further details please refer to the reference vignette by +#' calling: \code{vignette("reference", package = "ichimoku")} #' #' @examples #' if (interactive()) { diff --git a/R/oanda.R b/R/oanda.R index d78e5f36..9a1112b7 100644 --- a/R/oanda.R +++ b/R/oanda.R @@ -533,14 +533,12 @@ oanda_chart <- function(instrument, #' calculating the ichimoku cloud, \code{\link{autoplot}} to set chart #' parameters, or the 'options' argument of \code{shiny::shinyApp()}. #' -#' @return A Shiny app object with class 'shiny.appobj'. With default arguments, -#' the Shiny app is launched in the default browser. +#' @return Invisible NULL, or a 'mirai' if 'new.process' is specified as TRUE. +#' With default arguments, a Shiny app is launched in the default browser. #' #' @details This function polls the OANDA fxTrade API for the latest prices and #' updates a customisable reactive Shiny app at each refresh interval. #' -#' This function has a dependency on the 'shiny' package. -#' #' @section Further Details: #' Please refer to the OANDA fxTrade API vignette by calling: #' \code{vignette("xoanda", package = "ichimoku")}. diff --git a/man/iplot.Rd b/man/iplot.Rd index 68df3605..da4d1308 100644 --- a/man/iplot.Rd +++ b/man/iplot.Rd @@ -62,10 +62,8 @@ Plot Ichimoku Kinko Hyo cloud charts from ichimoku objects in R Shiny, directly from the chart. } \details{ -This function has a dependency on the 'shiny' package. - - For further details please refer to the reference vignette by calling: - \code{vignette("reference", package = "ichimoku")} +For further details please refer to the reference vignette by + calling: \code{vignette("reference", package = "ichimoku")} } \examples{ if (interactive()) { diff --git a/man/oanda_studio.Rd b/man/oanda_studio.Rd index 722e6039..d382f2dc 100644 --- a/man/oanda_studio.Rd +++ b/man/oanda_studio.Rd @@ -77,8 +77,8 @@ as using other values would be invalid in the context of traditional ichimoku analysis.} } \value{ -A Shiny app object with class 'shiny.appobj'. With default arguments, - the Shiny app is launched in the default browser. +Invisible NULL, or a 'mirai' if 'new.process' is specified as TRUE. + With default arguments, a Shiny app is launched in the default browser. } \description{ Interactive and fully-customisable R Shiny environment providing real-time @@ -89,8 +89,6 @@ Interactive and fully-customisable R Shiny environment providing real-time \details{ This function polls the OANDA fxTrade API for the latest prices and updates a customisable reactive Shiny app at each refresh interval. - - This function has a dependency on the 'shiny' package. } \section{Further Details}{