Fixed Unit-test for store_xts() 🔧 and updated documentation 📚

* The function were throwing an error: Found the following files/directories: ‘Rtmpx3Ay8DBTC.csv’ Added `unlink()` to the end of the test, which fixes everything locally 🔥
serkor1 · Nov 7, 2024 · e129732 · e129732
1 parent a539695
commit e129732
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/man/dema.Rd b/man/dema.Rd
diff --git a/man/ema.Rd b/man/ema.Rd
diff --git a/man/evwma.Rd b/man/evwma.Rd
diff --git a/man/get_fgindex.Rd b/man/get_fgindex.Rd
diff --git a/man/get_fundingrate.Rd b/man/get_fundingrate.Rd
diff --git a/man/get_openinterest.Rd b/man/get_openinterest.Rd
diff --git a/man/get_quote.Rd b/man/get_quote.Rd
diff --git a/man/hma.Rd b/man/hma.Rd
diff --git a/man/sma.Rd b/man/sma.Rd
diff --git a/man/vwap.Rd b/man/vwap.Rd
diff --git a/man/wma.Rd b/man/wma.Rd
diff --git a/man/write_xts.Rd b/man/write_xts.Rd
diff --git a/man/zlema.Rd b/man/zlema.Rd
diff --git 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)
 
   }
 )