Updated Documentation 📚

* Added pkg-anchors (were missing, and CRAN checks did not pass)

.gitignore

@@ -55,3 +55,4 @@ docs
 
 /*.html
 .vdoc.r
+*.Rproj

R/chart_ma.R

@@ -52,7 +52,7 @@ chart_ma <- function(
 #'
 #' @inheritParams TTR::SMA
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::SMA].
+#' The name of the vector to passed into [TTR::SMA()].
 #' @param ... For internal use. Please ignore.
 #'
 #' @example man/examples/scr_MAindicator.R
@@ -128,7 +128,7 @@ sma <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::EMA].
+#' The name of the vector to passed into [TTR::EMA()].
 #' @inheritParams TTR::EMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -206,7 +206,7 @@ ema <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::DEMA].
+#' The name of the vector to passed into [TTR::DEMA()].
 #' @inheritParams TTR::DEMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -286,7 +286,7 @@ dema <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::WMA].
+#' The name of the vector to passed into [TTR::WMA()].
 #' @inheritParams TTR::WMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -362,7 +362,7 @@ wma <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::EVWMA]
+#' The name of the vector to passed into [TTR::EVWMA()]
 #' @inheritParams TTR::EVWMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -434,7 +434,7 @@ evwma <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::ZLEMA].
+#' The name of the vector to passed into [TTR::ZLEMA()].
 #' @inheritParams TTR::ZLEMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -507,7 +507,7 @@ zlema <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::VWAP]
+#' The name of the vector to passed into [TTR::VWAP()]
 #' @inheritParams TTR::VWAP
 #' @param ... For internal use. Please ignore.
 #'
@@ -583,7 +583,7 @@ vwap <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default.
-#' The name of the vector to passed into [TTR::HMA].
+#' The name of the vector to passed into [TTR::HMA()].
 #' @inheritParams TTR::HMA
 #' @param ... For internal use. Please ignore.
 #'
@@ -654,7 +654,7 @@ hma <- function(
 #' )
 #'
 #' @param price A [character]-vector of [length] 1. "close" by default
-#' The name of the vector to passed into [TTR::ALMA].
+#' The name of the vector to passed into [TTR::ALMA()].
 #' @inheritParams TTR::ALMA
 #' @param ... For internal use. Please ignore.
 #'

R/get_fgi.R

@@ -24,7 +24,7 @@
 #'
 #' @inherit get_quote details
 #'
-#' @returns An [xts]-object containing,
+#' @returns An [xts::xts]-object containing,
 #'
 #' \item{index}{<[POSIXct]> the time-index}
 #' \item{fgi}{<[numeric]> the daily fear and greed index value}

R/get_fundingrate.R

@@ -24,7 +24,7 @@
 #'
 #' @inheritParams get_quote
 #'
-#' @returns An [xts]-object containing,
+#' @returns An [xts::xts]-object containing,
 #'
 #' \item{index}{<[POSIXct]> the time-index}
 #' \item{funding_rate}{<[numeric]> the current funding rate}

R/get_lsratio.R

@@ -27,7 +27,7 @@
 #' If [TRUE] it returns the top traders Long-Short ratios.
 #'
 #'
-#' @returns An [xts]-object containing,
+#' @returns An [xts::xts]-object containing,
 #'
 #' \item{index}{<[POSIXct]> the time-index}
 #' \item{long}{<[numeric]> the share of longs}

R/get_openinterest.R

@@ -27,7 +27,7 @@
 #' @inheritParams get_quote
 #'
 #' @returns
-#' An [xts]-object containing,
+#' An [xts::xts]-object containing,
 #'
 #' \item{index}{<[POSIXct]> the time-index}
 #' \item{open_interest}{<[numeric]> open perpetual contracts on both both sides}

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]-object containing,
+#' @returns An [xts::xts]-object containing,
 #'
 #' \item{index}{<[POSIXct]> The time-index}
 #' \item{open}{<[numeric]> Opening price}

R/helper.R

@@ -306,7 +306,7 @@ is.date <- function(x){
 #' @param ... expressions >= 1. If named the names are used
 #' as error messages, otherwise R's internal error-messages are thrown
 #'
-#' @param error_message character. An error message, supports [cli]-formatting.
+#' @param error_message character. An error message, supports [cli::cli]-formatting.
 #' @example man/examples/scr_assert.R
 #' @seealso [stopifnot()], [cli::cli_abort()], [tryCatch()]
 #' @keywords internal

R/store_xts.R

@@ -22,12 +22,12 @@
 #'  ...
 #' )
 #'
-#' @param x An <[xts]>-object.
+#' @param x An <[xts::xts]>-object.
 #' @inheritParams zoo::write.zoo
 #' @inheritParams zoo::read.zoo
 #'
 #' @details
-#' When reading and writing <[xts]>-objects the [attributes] does not follow the object.
+#' When reading and writing <[xts::xts]>-objects the [attributes] does not follow the object.
 #'
 #'
 #' @author

R/utils.R

@@ -176,7 +176,7 @@ endPoint <- function(
 #'
 #' @returns
 #'
-#' It returns an [xts]-object from the desired endpoint.
+#' It returns an [xts::xts]-object from the desired endpoint.
 #'
 #'
 #' @author Serkan Korkmaz