diff --git a/R/chart_ma.R b/R/chart_ma.R index bf1505a..432e6ae 100644 --- a/R/chart_ma.R +++ b/R/chart_ma.R @@ -41,7 +41,7 @@ chart_ma <- function( #' `r lifecycle::badge("experimental")` #' #' A high-level [plotly::add_lines()]-wrapper function that -#' interacts with [TTR]'s moving average family of functions. +#' interacts with \{TTR\}'s moving average family of functions. #' The function adds moving average indicators to the main [chart()]. #' #' @usage sma( diff --git a/R/get_fgi.R b/R/get_fgi.R index bec1193..ea801b8 100644 --- a/R/get_fgi.R +++ b/R/get_fgi.R @@ -24,7 +24,7 @@ #' #' @inherit get_quote details #' -#' @returns An [xts::xts]-object containing, +#' @returns An <[\link[xts]{xts}]>-object containing, #' #' \item{index}{<[POSIXct]> the time-index} #' \item{fgi}{<[numeric]> the daily fear and greed index value} diff --git a/R/get_fundingrate.R b/R/get_fundingrate.R index a297b73..c180562 100644 --- a/R/get_fundingrate.R +++ b/R/get_fundingrate.R @@ -24,7 +24,7 @@ #' #' @inheritParams get_quote #' -#' @returns An [xts::xts]-object containing, +#' @returns An <[\link[xts]{xts}]>-object containing, #' #' \item{index}{<[POSIXct]> the time-index} #' \item{funding_rate}{<[numeric]> the current funding rate} diff --git a/R/get_openinterest.R b/R/get_openinterest.R index 7373d47..18bcc4c 100644 --- a/R/get_openinterest.R +++ b/R/get_openinterest.R @@ -27,7 +27,7 @@ #' @inheritParams get_quote #' #' @returns -#' An [xts::xts]-object containing, +#' An <[\link[xts]{xts}]>-object containing, #' #' \item{index}{<[POSIXct]> the time-index} #' \item{open_interest}{<[numeric]> open perpetual contracts on both both sides} diff --git a/R/get_quote.R b/R/get_quote.R index 76a4858..ca3fb42 100644 --- a/R/get_quote.R +++ b/R/get_quote.R @@ -30,7 +30,7 @@ #' @param to An optional [character]-, [date]- or #' [POSIXct]-vector of [length] 1. [NULL] by default. #' -#' @returns An [xts::xts]-object containing, +#' @returns An <[\link[xts]{xts}]>-object containing, #' #' \item{index}{<[POSIXct]> The time-index} #' \item{open}{<[numeric]> Opening price} diff --git a/R/store_xts.R b/R/store_xts.R index 69e3df9..9314c2f 100644 --- a/R/store_xts.R +++ b/R/store_xts.R @@ -22,12 +22,12 @@ #' ... #' ) #' -#' @param x An <[xts::xts]>-object. +#' @param x An <[\link[xts]{xts}]>-object. #' @inheritParams zoo::write.zoo #' @inheritParams zoo::read.zoo #' #' @details -#' When reading and writing <[xts::xts]>-objects the [attributes] does not follow the object. +#' When reading and writing <[\link[xts]{xts}]>-objects the [attributes] does not follow the object. #' #' #' @author diff --git a/man/alma.Rd b/man/alma.Rd index 6ef9913..76fb1c1 100644 --- a/man/alma.Rd +++ b/man/alma.Rd @@ -32,7 +32,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/dema.Rd b/man/dema.Rd index dafffda..1095ce9 100644 --- a/man/dema.Rd +++ b/man/dema.Rd @@ -37,7 +37,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/ema.Rd b/man/ema.Rd index 91cb5e6..a338eac 100644 --- a/man/ema.Rd +++ b/man/ema.Rd @@ -34,7 +34,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/evwma.Rd b/man/evwma.Rd index 5069e9d..4308bec 100644 --- a/man/evwma.Rd +++ b/man/evwma.Rd @@ -26,7 +26,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/get_fgindex.Rd b/man/get_fgindex.Rd index 3367b1c..25cdf65 100644 --- a/man/get_fgindex.Rd +++ b/man/get_fgindex.Rd @@ -18,7 +18,7 @@ get_fgindex( \link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.} } \value{ -An \link[xts:xts]{xts::xts}-object containing, +An <[\link[xts]{xts}]>-object containing, \item{index}{<\link{POSIXct}> the time-index} \item{fgi}{<\link{numeric}> the daily fear and greed index value} diff --git a/man/get_fundingrate.Rd b/man/get_fundingrate.Rd index 23ad944..d901b2f 100644 --- a/man/get_fundingrate.Rd +++ b/man/get_fundingrate.Rd @@ -25,7 +25,7 @@ See \code{\link[=available_exchanges]{available_exchanges()}} for available exch \link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.} } \value{ -An \link[xts:xts]{xts::xts}-object containing, +An <[\link[xts]{xts}]>-object containing, \item{index}{<\link{POSIXct}> the time-index} \item{funding_rate}{<\link{numeric}> the current funding rate} diff --git a/man/get_openinterest.Rd b/man/get_openinterest.Rd index a507fec..ba5b07a 100644 --- a/man/get_openinterest.Rd +++ b/man/get_openinterest.Rd @@ -29,7 +29,7 @@ See \code{\link[=available_exchanges]{available_exchanges()}} for available exch \link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.} } \value{ -An \link[xts:xts]{xts::xts}-object containing, +An <[\link[xts]{xts}]>-object containing, \item{index}{<\link{POSIXct}> the time-index} \item{open_interest}{<\link{numeric}> open perpetual contracts on both both sides} diff --git a/man/get_quote.Rd b/man/get_quote.Rd index ababbe5..69eaf76 100644 --- a/man/get_quote.Rd +++ b/man/get_quote.Rd @@ -33,7 +33,7 @@ See \code{\link[=available_intervals]{available_intervals()}} for available inte \link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.} } \value{ -An \link[xts:xts]{xts::xts}-object containing, +An <[\link[xts]{xts}]>-object containing, \item{index}{<\link{POSIXct}> The time-index} \item{open}{<\link{numeric}> Opening price} diff --git a/man/hma.Rd b/man/hma.Rd index 7a7a09a..ca386f0 100644 --- a/man/hma.Rd +++ b/man/hma.Rd @@ -26,7 +26,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/sma.Rd b/man/sma.Rd index ef4c73d..79c6d6d 100644 --- a/man/sma.Rd +++ b/man/sma.Rd @@ -26,7 +26,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/vwap.Rd b/man/vwap.Rd index 98267f1..3134e63 100644 --- a/man/vwap.Rd +++ b/man/vwap.Rd @@ -30,7 +30,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/wma.Rd b/man/wma.Rd index 96c7e4a..b3cc3f9 100644 --- a/man/wma.Rd +++ b/man/wma.Rd @@ -30,7 +30,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/write_xts.Rd b/man/write_xts.Rd index df72488..fd5107d 100644 --- a/man/write_xts.Rd +++ b/man/write_xts.Rd @@ -18,7 +18,7 @@ file ) } \arguments{ -\item{x}{An <\link[xts:xts]{xts::xts}>-object.} +\item{x}{An <[\link[xts]{xts}]>-object.} \item{file}{character string or strings giving the name of the file(s) which the data @@ -40,7 +40,7 @@ file The \code{\link[=write_xts]{write_xts()}}- and \code{\link[=read_xts]{read_xts()}}-functions are \code{\link[zoo:read.zoo]{zoo::write.zoo()}}- and \code{\link[zoo:read.zoo]{zoo::read.zoo()}}-wrapper functions. } \details{ -When reading and writing <\link[xts:xts]{xts::xts}>-objects the \link{attributes} does not follow the object. +When reading and writing <[\link[xts]{xts}]>-objects the \link{attributes} does not follow the object. } \seealso{ Other utility: diff --git a/man/zlema.Rd b/man/zlema.Rd index 87c14d3..9be9f5e 100644 --- a/man/zlema.Rd +++ b/man/zlema.Rd @@ -30,7 +30,7 @@ A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that -interacts with \link{TTR}'s moving average family of functions. +interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/tests/testthat/test-store_xts.R b/tests/testthat/test-store_xts.R index f4cae71..14497e0 100644 --- a/tests/testthat/test-store_xts.R +++ b/tests/testthat/test-store_xts.R @@ -35,6 +35,10 @@ testthat::test_that( ) ) ) + + # 3) delete file + # after the test is run + unlink(temp_file) } )