Skip to content

Commit e129732

Browse files
committed
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 🔥
1 parent a539695 commit e129732

21 files changed

+26
-22
lines changed

‎R/chart_ma.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ chart_ma <- function(
4141
#' `r lifecycle::badge("experimental")`
4242
#'
4343
#' A high-level [plotly::add_lines()]-wrapper function that
44-
#' interacts with [TTR]'s moving average family of functions.
44+
#' interacts with \{TTR\}'s moving average family of functions.
4545
#' The function adds moving average indicators to the main [chart()].
4646
#'
4747
#' @usage sma(

‎R/get_fgi.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#'
2525
#' @inherit get_quote details
2626
#'
27-
#' @returns An [xts::xts]-object containing,
27+
#' @returns An <[\link[xts]{xts}]>-object containing,
2828
#'
2929
#' \item{index}{<[POSIXct]> the time-index}
3030
#' \item{fgi}{<[numeric]> the daily fear and greed index value}

‎R/get_fundingrate.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#'
2525
#' @inheritParams get_quote
2626
#'
27-
#' @returns An [xts::xts]-object containing,
27+
#' @returns An <[\link[xts]{xts}]>-object containing,
2828
#'
2929
#' \item{index}{<[POSIXct]> the time-index}
3030
#' \item{funding_rate}{<[numeric]> the current funding rate}

‎R/get_openinterest.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' @inheritParams get_quote
2828
#'
2929
#' @returns
30-
#' An [xts::xts]-object containing,
30+
#' An <[\link[xts]{xts}]>-object containing,
3131
#'
3232
#' \item{index}{<[POSIXct]> the time-index}
3333
#' \item{open_interest}{<[numeric]> open perpetual contracts on both both sides}

‎R/get_quote.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
#' @param to An optional [character]-, [date]- or
3131
#' [POSIXct]-vector of [length] 1. [NULL] by default.
3232
#'
33-
#' @returns An [xts::xts]-object containing,
33+
#' @returns An <[\link[xts]{xts}]>-object containing,
3434
#'
3535
#' \item{index}{<[POSIXct]> The time-index}
3636
#' \item{open}{<[numeric]> Opening price}

‎R/store_xts.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
#' ...
2323
#' )
2424
#'
25-
#' @param x An <[xts::xts]>-object.
25+
#' @param x An <[\link[xts]{xts}]>-object.
2626
#' @inheritParams zoo::write.zoo
2727
#' @inheritParams zoo::read.zoo
2828
#'
2929
#' @details
30-
#' When reading and writing <[xts::xts]>-objects the [attributes] does not follow the object.
30+
#' When reading and writing <[\link[xts]{xts}]>-objects the [attributes] does not follow the object.
3131
#'
3232
#'
3333
#' @author

‎man/alma.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/dema.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/ema.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/evwma.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/get_fgindex.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/get_fundingrate.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/get_openinterest.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/get_quote.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/hma.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/sma.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/vwap.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/wma.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/write_xts.Rd

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/zlema.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/testthat/test-store_xts.R

+4
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ testthat::test_that(
3535
)
3636
)
3737
)
38+
39+
# 3) delete file
40+
# after the test is run
41+
unlink(temp_file)
3842

3943
}
4044
)

0 commit comments

Comments
 (0)