pK7Qe4`N$GX
z;1hE#|EM-@8LTbsFL{(zM&Az`n)G_MmK_tfREw_(2DSSwokuyDuHNpY5*?x*akEk1
zQ+cG~ZYAXsPy51HKI=Qxd*ylPE;2K9UV(+fCnY*l5P;W3r|c5rCc~LvY~juOXFZ}y
z3)%In*K{W;BbyuXh)jGuJ9v#k`G|_nu(LVPPdO`AEw7-g^yll3M1p0e2lYqd4}EMM
zD{cZPAQlNF{|WzQVze2u4jH`s^XB11yFLYrP;@gpJ4HI8s%%(Dgr#W8Q$v)&?VUxL
zLpv1k5o^4-CRGjhhSb=tST9;R3&Jf3gYDw7PBoO2O=V)}hke=fbf^m2=60#Fa-TTF
zSlxXIth5-4+24!e{-L?u-Z=6|DzA{wfjr(}M@HjVu5jnUO=aaZn<|GKQ)=D>s!(3J
zP2cC?x8+WR1Wiu%%yGaDm-I0(dHnMOhmfy6d7LA1Gpj+>g)to?oZB1(1&@W09%do8
zm_F1DR*eqG%(Ci7RsH3OfEaujMS{wFX7Md}>oJ?m@BuIbA13HmVSEqVU)%4m^5m{C8{x~=XeA0i;DL>&#~t|EewY=(-NtKXq-5;G@uN|a
zo-|S2U4!9Lr-)CQ2Is-SK8kK2qsdM$!IgQZxv*fO5Ch4t4Y5Smbv;0lFyx(vqZB-R
z!T0VY|7$R{=kB;AX`R#8!KFi$j!$eT!=qo%qIhtZ&k-Yjf%FP8X+RZrk-lG;DQda?
z$#_+>z$tZW&h)jO4it2d79McO7b4WKqh$S$qt~5ViDGNB48~yS12IO5b7T30ucdnQ
zDXL+UXR^T)EbSpqq0%bO3e}&M`Y2TI@kW0Mr|&(dBL$8>{=WL)qXbHCHZSU+;EIQX
zCHr}?x&Nlv^RB{IM1eWsf?p!fV90;$4#pPdl&%GPqOW)_(oJ9L5N33uB$rP&5d<P{qYP`Wz;d
ztNI7Ka?l9-{ly;XbmWhHF?qlCyrl3bbj!CNqLbw_%p{NSEc78`r$y|{h@ulkDRVWS
z6@XgZUAWVzN6eKUHS5XL-Y}3HpZYP#uut((rV{(*v(^CO#$)};h=2c(2%zJ$9!K>q
zYHF4i@JuuSn3;dehuSd-2aDu7kd&t^Fjnt6r@KH_C|aHH=u7lGWxdHQyMdBx;j^b+
zhC_^&>dU9I6Kld|Pk7C9KV@@so62Y>e6%RlzfMsOMRV{Lg^!RjbNQV(EGwBB%JTFa
zq-a9zKP6Akx<=Us~Duba{*b-Zd%
z-f>`9U%q~I{!Dq-xxzIkJra=IC9PxV7C?|n4dZ8o~DYNh(f#i)-^Ms$(
zH6uM8r91uBCK^!ax)@@BtS?9N*oZS$0+~_Q(SKF~r^%W7)n_`z%v1UnbYryoB?tW+
z#TrlP<|!1f&Zr8gmGOQ|5J1Yxqhd*6t)b^&ll`&SPmNx@B(lLK{Pb-&liGlD#_g&k
z8~nYr`|?6^gWDyyiIU$fQ)F1WFk7Ci61&09AM7^GV@*)TMK844a~xcmbQALgfhrSh
zj?2ysV%N2GdCyvXlv?<{9Li)V*Q9U*6we_`>4qSZZJRq;Um4|x03dmNz0r*Aj4sc>
z_0$`DT;^pX)^$2#J)!Chk%<&nN$xb@p1X0K#L
z5uoCsGcuaJJP6!=&qn4z^<5+~$-e{kDu={zDi@(|ve=k~U%l4f8%QooxpVT`zxeH<
znS{OL_OW+-qw+AD9A`+Q=(`;q&hOBbVHNoxVz1<0bxpl*5Et_s
z_XGjL=Lp+KW@l{m?`*NT6Nt;;0Mz)|84rfLs4z}lBYaEwW1LN4_Cocj=;>h31kq{USL=gpb
znSiTw{p#3@-ok(Q6^&kF_co*8CJezJ3!c!ui~Qjse#WVBSX25XcnS5Glzv7`?CSvJ
zMSCM`Bm`!#`s+Tw<#`DDZ#FUBxB?%hO<~i=z}-K+{_&#a`vqmo&9c-Y^LCorW*#{i
z2j<@xZ@!aSd@m%wdv>PSjpLkw@il5}XLYjV-cMDC%t6!ADrc@v`H^~r=e6Y8}e~_Y(s;c5Q(B&w)aac|fvJ{dH#?(_Al>H?#!L(&j
zc`%o%Mi!dkQGrn&<0MtXlMDsKySHArq!vcZXmX3K>h+L81gX}mcKAp_LcDSxDT-MP
z@-pWasUt5nKyole=ZDK3{8wG`bhhu|I~VYnw@rs%x=!mLto9ZeCcW~+2mL=|JLy`N
zWtjxyFlPiv!3XEpQ@oUq`cAsb@Thnt`)-N1vu@Har7rIyd^A-vmff9)9+@kB;Z2i!
zww#&JlD20b@l}X0q4n@78OrI`UlC%4|3O0vG?`tlwnbdFq$d
zJz7ct{lSM7H!D98sBL#FGNpsL!{!4?O6u}J*MLOxAIe`34NJ(FC>#JH(+3zSZ}Zvt
zJMqqU&CznBK}~v6x`YOn5^Yix6_@19ri2oK%U#6UAlJ`*p_tbIP{q&e<7sL~&tCM7
z1>o>=SN)-$bVbUZOPp+f@0wcI`l|w;QB^N@^^FEn&i5KaxT*0<75bSY+v1UF&FGge
zPB#zaeN^|Ddh>(L$=n@3MTmf&9#|C60z{72k9~7O`qMz9T2<@SENmeC-c4>m9#%)A
zg;sJ6d>tahKOLv2myY<68Y*3={u@lcqrum~e^>;bTQ>XEw`r@n6PS8jAf+_Y^97kBseC2q51Cl+tvJpY
ly;}K@tc-|0;VH3>-7@aOKHej~-uY%&Nqd(p=ufKFe*q&P@M-`6
literal 0
HcmV?d00001
diff --git a/R/utils.R b/R/utils.R
index ef32628c..c948d611 100644
--- a/R/utils.R
+++ b/R/utils.R
@@ -204,8 +204,8 @@ endPoint <- function(
#' @param ... additional parameters passed down the endpoint
#'
#' @details
-#' This function can only be used to fetch time-based objects, and can therefore
-#' not be used to get, for example, [available_tickers()].
+#' This function can only be used to fetch time-based objects,
+#' and can therefore not be used to get, for example, [available_tickers()].
#'
#' @family development tools
#'
@@ -280,7 +280,6 @@ fetch <- function(
type = type,
futures = futures,
...
-
),
query = parameters$query,
path = parameters$path
@@ -304,7 +303,6 @@ fetch <- function(
what = c('array', 'matrix', 'data.frame')
)
-
# 2.2) extract data
# from reponse:
#
@@ -312,13 +310,17 @@ fetch <- function(
# then it is likely
# that we are dealing with
# an error, or Kraken
- response <- tryCatch(
- expr = {
- response[[which(idx)]]
+ #
+ # This could be done using do.call
+ # maybe
+ switch (source,
+ kraken = {
+ response <- do.call(
+ data.frame,
+ response
+ )
},
- error = function(error){
- as.data.frame(response)
- }
+ response <- response[[which(idx)]]
)
diff --git a/R/zzz.R b/R/zzz.R
index 8b713af1..badfd941 100644
--- a/R/zzz.R
+++ b/R/zzz.R
@@ -4,7 +4,6 @@
# objective:
# script start;
-# 1) on attach
.onAttach <- function(
libname,
pkgname,
@@ -17,36 +16,28 @@
xts_check_TZ = FALSE
)
- # 1) package
- # header
- rlang::inform(
- header(
- pkgname = pkgname,
- pkgversion = utils::packageVersion(
- pkgname
- )
+
+ cli::cli_inform(
+ message = pkg_header(
+ pkgname
),
...,
class = "packageStartupMessage"
)
- # 2) package information
- # to the user
- rlang::inform(
- pkg_information(),
+ cli::cli_inform(
+ message = pkg_information(),
...,
class = "packageStartupMessage"
)
-}
+}
-# 1) on detach
.onDetach <- function(
libpath,
...) {
-
# 1) reset options
# for xts suppressing
# timezone messages
@@ -55,4 +46,5 @@
)
}
+
# script end;
diff --git a/README.Rmd b/README.Rmd
index 09263f3e..dff5a4b6 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -2,36 +2,79 @@
output: github_document
always_allow_html: true
---
-
-
```{r setup, include = FALSE}
# set options
+Sys.setenv(OPENSSL_CONF="/dev/null")
+
knitr::opts_chunk$set(
collapse = FALSE,
- comment = "#>",
+ comment = "#>",
fig.path = "man/figures/README-",
- message = FALSE,
- warning = FALSE
+ message = FALSE,
+ warning = FALSE
)
```
-# cryptoQuotes: A streamlined access to OHLC-V market data and sentiment indicators in R 
+# cryptoQuotes: Open access to cryptocurrency market data
-[](https://www.cran-e.com/package/cryptoQuotes)
-[](https://www.cran-e.com/package/cryptoQuotes)
+[](https://CRAN.R-project.org/package=cryptoQuotes)
+[](https://r-pkg.org/pkg/cryptoQuotes)
[](https://github.com/serkor1/cryptoQuotes/actions/workflows/R-CMD-check.yaml)
-[](https://app.codecov.io/gh/serkor1/cryptoQuotes?branch=main)
-[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[](https://app.codecov.io/gh/serkor1/cryptoQuotes)
+[](https://lifecycle.r-lib.org/articles/stages.html#stable)
+
+## :information_source: About
+
+The `cryptoQuotes`-package is a high-level API client for accessing public market data endpoints on major cryptocurrency exchanges. It supports open, high, low, close and volume (OHLC-V) data and a variety of sentiment indicators; the market data is high quality and can be retrieved in intervals ranging from *seconds* to *months*. All the market data is accessed and processed without relying on crawlers, or API keys, ensuring an open, and reliable, access for researchers, traders and students alike. There are currently `r length(invisible(cryptoQuotes::available_exchanges(type = "ohlc")))` supported cryptocurrency exchanges,
+
+
+```{r, echo=FALSE}
+## available exchanges
+invisible(
+ all_exchanges <- cryptoQuotes::available_exchanges()
+)
+
+# Convert the character vector to a single-row data frame
+exchanges_df <- data.frame(t(all_exchanges))
+
+# Set column names to be the exchange names
+colnames(exchanges_df) <- all_exchanges
+
+# Create a horizontal table
+kableExtra::kable_styling(
+ knitr::kable(
+ x = exchanges_df,
+ digits = 2,
+ col.names = NULL,
+ caption = 'Supported exchanges',
+ align = 'c',
+ table.attr = "style='width:100%;'",
+ format = 'html'
+ ),
+ full_width = TRUE,
+ position = 'center'
+)
+```
+
+
+All data is returned as [`xts`](https://github.com/joshuaulrich/xts)-objects which enables seamless interaction with with [`quantmod`](https://github.com/joshuaulrich/quantmod) and [`TTR`](https://github.com/joshuaulrich/TTR), for developing and evaluating trading strategies or general purpose cryptocurrency market analysis with a historical or temporal perspective.
+
## :information_source: Overview
-The `cryptoQuotes`-package is a high-level API-client to get current, and historical, cryptocurrency OHLC-V market and sentiment data in ```R```, without using web-crawlers or API keys. This ```R```-package uses `xts` and `zoo` under the hood and are compatible with `quantmod` and `TTR` out of the box.
+The `cryptoQuotes`-package has *two* main features; retrieving cryptocurrency market data, and charting. The market data consists of *OHLC-V* data and sentiment indicators; including, but not limited to, cryptocurrency *fear and greed index*, *long-short ratio* and *open interest*. All market data is retrieved using the family of `get_*`-functions. To get a full overview of the package and functionality please see the documentation on [pkgdown](https://serkor1.github.io/cryptoQuotes/).
+
+> **Note:** Given the nature of crypotcurrency data and general legislative restrictions, some `exchanges` may not work in your geolocation.
+
+Below is a quick overview of the package and basic usage examples on retrieving and charting Bitcoin (BTC) *OHLC-V* and *long-short ratio* in 30 minute intervals.
+
+### :information_source: Cryptocurrency market data
-### Supported exchanges and markets
+#### OHLC-V
All supported exchanges and markets are listed in the table below, alongside the available range of intervals available from the respective exchanges,
@@ -189,8 +232,8 @@ kableExtra::kable_styling(
x = data.frame(
row.names = NULL,
Exchange = exchange,
- Spot = rep(x = cli::symbol$tick,length(exchange)),
- Futures = rep(x = cli::symbol$tick,length(exchange)),
+ Spot = rep(x = ":white_check_mark:",length(exchange)),
+ Futures = rep(x = ":white_check_mark:",length(exchange)),
`Available Intervals` = c(intervals),
`Smallest Interval` = c(granularity(TRUE)),
`Biggest Interval` = c(granularity(FALSE))
@@ -203,22 +246,21 @@ kableExtra::kable_styling(
```
-### :information_source: Basic Usage
+
+Example: Bitcoin OHLC-V
-#### OHLC-V Market Data
-
-Get USDT denominated Bitcoin spot market price from Binance with `30m`-intervals using the `get_quote()`-function,
+Get USDT denominated Bitcoin (BTC) on the spot market from Binance in `30m`-intervals using the `get_quote()`-function,
```{r cryptocurrency market data in R, eval=TRUE}
## BTC OHLC prices
## from Binance spot market
## in 30 minute intervals
BTC <- cryptoQuotes::get_quote(
- ticker = 'BTCUSDT',
- source = 'binance',
- futures = FALSE,
+ ticker = 'BTCUSDT',
+ source = 'binance',
+ futures = FALSE,
interval = '30m',
- from = Sys.Date() - 1
+ from = Sys.Date() - 1
)
```
@@ -226,12 +268,12 @@ BTC <- cryptoQuotes::get_quote(
```{r print table, echo=FALSE, fig.alt="cryptocurrency prices in R"}
kableExtra::kable_styling(
knitr::kable(
- caption = 'Bitcoin (BTC) OHLC-prices',
+ caption = 'Bitcoin (BTC) OHLC-V data',
align = 'lcccc',
table.attr = "style='width:100%;'",
x = data.frame(
cbind(
- Index = paste(tail(zoo::index(BTC))),
+ index = paste(tail(zoo::index(BTC))),
tail(zoo::coredata(BTC))
),row.names = NULL
),
@@ -242,12 +284,112 @@ kableExtra::kable_styling(
)
```
+__________
+
-#### Charting OHLC-V
+#### Sentiment indicators
-The `BTC`-object can be charted using the `chart()`-function,
+The sentiment indicators available in the `cryptoQuotes`-package can be divided in two; *derived indicators* and *market indicators*. The former is calculated based on, for example, the price actions such as the *Moving Average Convergence Divergence* (MACD) indicator. The latter are public indicators such as the *long-short ratio* or *fear and greed index*; these are retrieved using the family of `get_*`-functions, while the derived indicators can be created using, for example, [`TTR`](https://github.com/joshuaulrich/TTR).
-```{r chartquote, fig.align='center',fig.dpi=180, fig.alt="cryptocurrency charts in R"}
+In this overview we are focusing on *market indicators* made public by the cryptocurrency exchanges. For a full overview of sentiment indicators please refer to the documentation on [pkgdown](https://serkor1.github.io/cryptoQuotes/). All supported *market indicators* by exchange are listed in the table below,
+
+
+```{r, echo = FALSE}
+## 1) list all available
+## exchanges and the links
+available_endpoint <- data.frame(
+ Endpoint = c(
+ "Long-Short Ratio",
+ "Open Interest",
+ "Funding Rate"
+ ),
+ Binance = c(
+ ":white_check_mark:",
+ ":white_check_mark:",
+ ":white_check_mark:"
+ ),
+ Bitmart = c(
+ ":x:",
+ ":x:",
+ ":x:"
+ ),
+ Bybit = c(
+ ":white_check_mark:",
+ ":white_check_mark:",
+ ":white_check_mark:"
+ ),
+ Kraken = c(
+ ":white_check_mark:",
+ ":white_check_mark:",
+ ":x:"
+ ),
+ Kucoin = c(
+ ":x:",
+ ":x:",
+ ":white_check_mark:"
+ )
+)
+
+## 4) present table
+## for as is
+kableExtra::kable_styling(
+ knitr::kable(
+ digits = 0,
+ caption = 'Available sentiment indicators by exchange',
+ align = 'lccccc',
+ table.attr = "style='width:100%;'",
+ x = available_endpoint,
+ format = 'markdown'
+ ),
+ full_width = TRUE,
+ position = 'center'
+)
+```
+
+
+
+Example: Bitcoin Long-Short Ratio
+
+Get the *long-short ratio* on Bitcoin (BTC) using the `get_lsratio()`-function,
+
+```{r cryptocurrency sentiment indicators in R, eval=TRUE}
+## BTC OHLC prices
+## from Binance spot market
+## in 30 minute intervals
+BTC_LS <- cryptoQuotes::get_lsratio(
+ ticker = 'BTCUSDT',
+ source = 'binance',
+ interval = '30m',
+ from = Sys.Date() - 1
+)
+```
+
+
+```{r print LS table, echo=FALSE, fig.alt="cryptocurrency prices in R"}
+kableExtra::kable_styling(
+ knitr::kable(
+ caption = 'Long-Short Ratio on Bitcoin (BTC)',
+ align = 'lccc',
+ table.attr = "style='width:100%;'",
+ x = data.frame(
+ cbind(
+ index = paste(tail(zoo::index(BTC_LS))),
+ tail(zoo::coredata(round(BTC_LS,3)))
+ ),row.names = NULL
+ ),
+ format = 'html'
+ ),
+ full_width = TRUE,
+ position = 'center'
+)
+```
+
+__________
+
+
+### :information_source: Charting
+
+```{r, echo=FALSE, include=FALSE}
## Chart BTC
## using klines, SMA,
## MACD and Bollinger Bands
@@ -255,8 +397,8 @@ cryptoQuotes::chart(
ticker = BTC,
main = cryptoQuotes::kline(),
sub = list(
- cryptoQuotes::volume(),
- cryptoQuotes::macd()
+ cryptoQuotes::lsr(ratio = BTC_LS),
+ cryptoQuotes::volume()
),
indicator = list(
cryptoQuotes::sma(n = 7),
@@ -267,30 +409,85 @@ cryptoQuotes::chart(
)
```
+Charting in the `cryptoQuotes`-package is built on [`plotly`](https://github.com/plotly/plotly.R) for interactivity. It supports *light* and *dark* themes, and accounts for *color-deficiency* via the `options`-argument in the `chart()`-function.
+
+#### Charting with indicators
+
+The OHLC-V data and the sentiment indicator can be charted using the `chart()`-function,
+
+```{r chartquote, fig.align='center',fig.dpi=180, fig.alt="cryptocurrency charts in R"}
+## Chart BTC
+## using klines, SMA
+## Bollinger Bands and
+## long-short ratio
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::lsr(ratio = BTC_LS),
+ cryptoQuotes::volume()
+ ),
+ indicator = list(
+ cryptoQuotes::sma(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::sma(n = 21),
+ cryptoQuotes::bollinger_bands()
+ )
+)
+```
+
+
+
+Colorblind friendly version
+#### Charting with indicators (colorblind friendly)
+
+```{r chartquote(deficiency), fig.align='center', fig.dpi=180, fig.alt="cryptocurrency charts in R"}
+## Chart BTC
+## using klines, SMA
+## Bollinger Bands and
+## ling-short ratio with color-deficiency
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::lsr(ratio = BTC_LS),
+ cryptoQuotes::volume()
+ ),
+ indicator = list(
+ cryptoQuotes::sma(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::sma(n = 21),
+ cryptoQuotes::bollinger_bands()
+ ),
+ options = list(
+ deficiency = TRUE
+ )
+)
+```
+
+__________
+
+
## :information_source: Installation
-### Stable version
+### :shield: Stable version
```{r stable version guide, eval = FALSE}
-# install from CRAN
+## install from CRAN
install.packages(
pkgs = 'cryptoQuotes',
dependencies = TRUE
)
```
-### Development version
+### :hammer_and_wrench: Development version
```{r development version guide, eval = FALSE}
-# install from github
+## install from github
devtools::install_github(
repo = 'https://github.com/serkor1/cryptoQuotes/',
ref = 'development'
)
```
-## :warning: Disclaimer
-
-This `library` is still considered `experimental` but no breaking changes will be made on functions labelled as `stable` without appropriate action; please refer to the [release notes](NEWS.md), or submit an [issue](https://github.com/serkor1/cryptoQuotes/issues) if that promise is broken.
-
## :information_source: Code of Conduct
Please note that the `cryptoQuotes` project is released with a [Contributor Code of Conduct](https://serkor1.github.io/cryptoQuotes/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
diff --git a/README.md b/README.md
index 48293dbe..9ab287fd 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,93 @@
-# cryptoQuotes: A streamlined access to OHLC-V market data and sentiment indicators in R
+# cryptoQuotes: Open access to cryptocurrency market data
[](https://www.cran-e.com/package/cryptoQuotes)
+status](https://www.r-pkg.org/badges/version/cryptoQuotes)](https://CRAN.R-project.org/package=cryptoQuotes)
[](https://www.cran-e.com/package/cryptoQuotes)
+downloads](https://cranlogs.r-pkg.org/badges/last-month/cryptoQuotes?color=blue)](https://r-pkg.org/pkg/cryptoQuotes)
[](https://github.com/serkor1/cryptoQuotes/actions/workflows/R-CMD-check.yaml)
-[](https://app.codecov.io/gh/serkor1/cryptoQuotes?branch=main)
+[](https://app.codecov.io/gh/serkor1/cryptoQuotes)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
+
+## :information_source: About
+
+The `cryptoQuotes`-package is a high-level API client for accessing
+public market data endpoints on major cryptocurrency exchanges. It
+supports open, high, low, close and volume (OHLC-V) data and a variety
+of sentiment indicators; the market data is high quality and can be
+retrieved in intervals ranging from *seconds* to *months*. All the
+market data is accessed and processed without relying on crawlers, or
+API keys, ensuring an open, and reliable, access for researchers,
+traders and students alike. There are currently 5 supported
+cryptocurrency exchanges,
+
+
+
+
+
+Supported exchanges
+
+
+
+|
+binance
+ |
+
+bitmart
+ |
+
+bybit
+ |
+
+kraken
+ |
+
+kucoin
+ |
+
+
+
+
+
-
+
Supported exchanges, markets and intervals.
@@ -64,10 +127,10 @@ Biggest Interval
Binance
|
-âś”
+:white_check_mark:
|
-âś”
+:white_check_mark:
|
16
@@ -84,10 +147,10 @@ Binance
Bitmart
|
-âś”
+:white_check_mark:
|
-âś”
+:white_check_mark:
|
13
@@ -104,10 +167,10 @@ Bitmart
Bybit
|
-âś”
+:white_check_mark:
|
-âś”
+:white_check_mark:
|
13
@@ -124,10 +187,10 @@ Bybit
Kraken
|
-âś”
+:white_check_mark:
|
-âś”
+:white_check_mark:
|
10
@@ -144,10 +207,10 @@ Kraken
Kucoin
|
-âś”
+:white_check_mark:
|
-âś”
+:white_check_mark:
|
13
@@ -164,11 +227,12 @@ Kucoin
-### :information_source: Basic Usage
-
-#### OHLC-V Market Data
+
+
+Example: Bitcoin OHLC-V
+
-Get USDT denominated Bitcoin spot market price from Binance with
+Get USDT denominated Bitcoin (BTC) on the spot market from Binance in
`30m`-intervals using the `get_quote()`-function,
``` r
@@ -176,24 +240,24 @@ Get USDT denominated Bitcoin spot market price from Binance with
## from Binance spot market
## in 30 minute intervals
BTC <- cryptoQuotes::get_quote(
- ticker = 'BTCUSDT',
- source = 'binance',
- futures = FALSE,
+ ticker = 'BTCUSDT',
+ source = 'binance',
+ futures = FALSE,
interval = '30m',
- from = Sys.Date() - 1
+ from = Sys.Date() - 1
)
```
-
+
-Bitcoin (BTC) OHLC-prices
+Bitcoin (BTC) OHLC-V data
|
-Index
+index
|
open
@@ -215,122 +279,237 @@ volume
|
|
-2024-03-12 10:30:00
+2024-05-31 18:00:00
|
-71978.46
+67215.58
|
-72085.06
+67352.41
|
-71850.01
+66670
|
-71936
+67000.01
|
-818.1898
+2093.77494
|
|
-2024-03-12 11:00:00
+2024-05-31 18:30:00
|
-71936
+67000.01
|
-71959.12
+67221.53
|
-71647.14
+66876.8
|
-71705.63
+67200.01
|
-587.18566
+788.25693
|
|
-2024-03-12 11:30:00
+2024-05-31 19:00:00
|
-71705.63
+67200.01
|
-71999
+67459.66
|
-71705.62
+67160.3
|
-71864
+67417.98
|
-642.93822
+598.68095
|
|
-2024-03-12 12:00:00
+2024-05-31 19:30:00
|
-71864
+67417.98
|
-72376
+67455.93
|
-71860
+67287.97
|
-72062.98
+67342.77
|
-1368.19948
+287.26257
|
|
-2024-03-12 12:30:00
+2024-05-31 20:00:00
|
-72062.99
+67342.77
|
-72257.56
+67444.47
|
-72012.72
+67288.2
|
-72023.82
+67305.5
|
-673.04693
+383.04002
+ |
+
+
+|
+2024-05-31 20:30:00
+ |
+
+67305.5
+ |
+
+67427.68
+ |
+
+67170
+ |
+
+67400
+ |
+
+468.98276
+ |
+
+
+
+
+
+
+------------------------------------------------------------------------
+
+
+
+#### Sentiment indicators
+
+The sentiment indicators available in the `cryptoQuotes`-package can be
+divided in two; *derived indicators* and *market indicators*. The former
+is calculated based on, for example, the price actions such as the
+*Moving Average Convergence Divergence* (MACD) indicator. The latter are
+public indicators such as the *long-short ratio* or *fear and greed
+index*; these are retrieved using the family of `get_*`-functions, while
+the derived indicators can be created using, for example,
+[`TTR`](https://github.com/joshuaulrich/TTR).
+
+In this overview we are focusing on *market indicators* made public by
+the cryptocurrency exchanges. For a full overview of sentiment
+indicators please refer to the documentation on
+[pkgdown](https://serkor1.github.io/cryptoQuotes/). All supported
+*market indicators* by exchange are listed in the table below,
+
+
+
+
+
+Available sentiment indicators by exchange
+
+
+
+|
+Endpoint
+ |
+
+Binance
+ |
+
+Bitmart
+ |
+
+Bybit
+ |
+
+Kraken
+ |
+
+Kucoin
+ |
+
+
+
+
+|
+Long-Short Ratio
+ |
+
+:white_check_mark:
+ |
+
+:x:
+ |
+
+:white_check_mark:
+ |
+
+:white_check_mark:
+ |
+
+:x:
|
|
-2024-03-12 13:00:00
+Open Interest
|
-72023.82
+:white_check_mark:
|
-72144.14
+:x:
|
-71576
+:white_check_mark:
|
-71628.53
+:white_check_mark:
|
+
+:x:
+ |
+
+
|
-1283.8762
+Funding Rate
+ |
+
+:white_check_mark:
+ |
+
+:x:
+ |
+
+:white_check_mark:
+ |
+
+:x:
+ |
+
+:white_check_mark:
|
@@ -338,20 +517,165 @@ volume
-#### Charting OHLC-V
+
+
+Example: Bitcoin Long-Short Ratio
+
-The `BTC`-object can be charted using the `chart()`-function,
+Get the *long-short ratio* on Bitcoin (BTC) using the
+`get_lsratio()`-function,
+
+``` r
+## BTC OHLC prices
+## from Binance spot market
+## in 30 minute intervals
+BTC_LS <- cryptoQuotes::get_lsratio(
+ ticker = 'BTCUSDT',
+ source = 'binance',
+ interval = '30m',
+ from = Sys.Date() - 1
+)
+```
+
+
+
+
+
+Long-Short Ratio on Bitcoin (BTC)
+
+
+
+|
+index
+ |
+
+long
+ |
+
+short
+ |
+
+ls_ratio
+ |
+
+
+
+
+|
+2024-05-31 18:00:00
+ |
+
+0.679
+ |
+
+0.321
+ |
+
+2.114
+ |
+
+
+|
+2024-05-31 18:30:00
+ |
+
+0.687
+ |
+
+0.313
+ |
+
+2.199
+ |
+
+
+|
+2024-05-31 19:00:00
+ |
+
+0.696
+ |
+
+0.304
+ |
+
+2.289
+ |
+
+
+|
+2024-05-31 19:30:00
+ |
+
+0.699
+ |
+
+0.301
+ |
+
+2.323
+ |
+
+
+|
+2024-05-31 20:00:00
+ |
+
+0.696
+ |
+
+0.304
+ |
+
+2.288
+ |
+
+
+|
+2024-05-31 20:30:00
+ |
+
+0.696
+ |
+
+0.304
+ |
+
+2.293
+ |
+
+
+
+
+
+
+### :information_source: Charting
+
+Charting in the `cryptoQuotes`-package is built on
+[`plotly`](https://github.com/plotly/plotly.R) for interactivity. It
+supports *light* and *dark* themes, and accounts for *color-deficiency*
+via the `options`-argument in the `chart()`-function.
+
+#### Charting with indicators
+
+The OHLC-V data and the sentiment indicator can be charted using the
+`chart()`-function,
``` r
## Chart BTC
-## using klines, SMA,
-## MACD and Bollinger Bands
+## using klines, SMA
+## Bollinger Bands and
+## long-short ratio
cryptoQuotes::chart(
ticker = BTC,
main = cryptoQuotes::kline(),
sub = list(
- cryptoQuotes::volume(),
- cryptoQuotes::macd()
+ cryptoQuotes::lsr(ratio = BTC_LS),
+ cryptoQuotes::volume()
),
indicator = list(
cryptoQuotes::sma(n = 7),
@@ -364,36 +688,65 @@ cryptoQuotes::chart(
+
+
+Colorblind friendly version
+
+
+#### Charting with indicators (colorblind friendly)
+
+``` r
+## Chart BTC
+## using klines, SMA
+## Bollinger Bands and
+## ling-short ratio with color-deficiency
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::lsr(ratio = BTC_LS),
+ cryptoQuotes::volume()
+ ),
+ indicator = list(
+ cryptoQuotes::sma(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::sma(n = 21),
+ cryptoQuotes::bollinger_bands()
+ ),
+ options = list(
+ deficiency = TRUE
+ )
+)
+```
+
+-1.png)
+
+------------------------------------------------------------------------
+
+
+
## :information_source: Installation
-### Stable version
+### :shield: Stable version
``` r
-# install from CRAN
+## install from CRAN
install.packages(
pkgs = 'cryptoQuotes',
dependencies = TRUE
)
```
-### Development version
+### :hammer_and_wrench: Development version
``` r
-# install from github
+## install from github
devtools::install_github(
repo = 'https://github.com/serkor1/cryptoQuotes/',
ref = 'development'
)
```
-## :warning: Disclaimer
-
-This `library` is still considered `experimental` but no breaking
-changes will be made on functions labelled as `stable` without
-appropriate action; please refer to the [release notes](NEWS.md), or
-submit an [issue](https://github.com/serkor1/cryptoQuotes/issues) if
-that promise is broken.
-
## :information_source: Code of Conduct
Please note that the `cryptoQuotes` project is released with a
diff --git a/_pkgdown.yml b/_pkgdown.yml
index 96c27a1e..6fc6aeaf 100644
--- a/_pkgdown.yml
+++ b/_pkgdown.yml
@@ -4,43 +4,87 @@ home:
title: Cryptocurrency with R
# description for google
- description: A high-level API client to fetch historical cryptocurrency OHLC-V market data, and sentiment indicators, in R.
+ description: >
+ An open and unified access to cryptocurrency market data in R.
navbar:
type: inverse
+ structure:
+ left: [intro, usecase, custom-indicators, reference, articles, news]
+ right: [github]
+
+ components:
+ usecase:
+ text: Usecase
+ href: articles/usecase.html
+ custom-indicators:
+ text: Custom Indicators
+ href: articles/custom_indicators.html
+ articles:
+ text: Articles
+ menu:
+ - text: Cryptocurrency Market Data
+ href: articles/01-article.html
+ - text: Cryptocurrency Charts
+ href: articles/02-article.html
+ - text: Time Zones
+ href: articles/03-article.html
+ - text: Converting xts-objects
+ href: articles/04-article.html
+ - text: cryptoQuotes x quantmod and TTR
+ href: articles/05-article.html
+
url: https://serkor1.github.io/cryptoQuotes/
+
template:
bootstrap: 5
bootswatch: flatly
reference:
-- title: Cryptocurrency sentiment and price data
- desc: Functions that return cryptocurrency market data
-- contents: has_concept('get-function')
-- title: Supported calls
- desc: All available API parameters
+- title: Cryptocurrency Market Data
+ desc: >
+ The collection of functions to retrieve OHLC-V and sentiment data.
+- contents: has_concept('get-functions')
+
+- title: Supported Calls
+ desc: >
+ The collection of functions to list available argument values in the
+ `interval`-, `source`- and `interval`-arguments.
- contents: has_concept('supported calls')
-- title: Main charts
- desc: The main charts
-- contents: has_concept(c('charting','price charts'))
-- title: Subcharts
- desc: The family of chart suited for subcharts
-- contents:
- - has_concept('subcharts')
-- title: Charting indicators
- desc: Adding indicators to charts
-- contents:
- - has_concept('chart indicators')
- - -has_concept('price charts')
- - -has_concept('subcharts')
-- title: Convinience functions
+
+- title: Charting
+ desc: >
+ The collection of `chart`-functions are split 3; main charts (price chart), main chart
+ indicators and subchart indicators. All `charts` are initialised using the `chart`-function.
+ contents:
+ - chart
+
+- subtitle: Main Charts
+ desc: >
+ The collection of main chart functions for charting prices.
+ contents:
+ - kline
+ - ohlc
+ - pline
+
+- subtitle: Main Chart Indicators
+ desc: >
+ The collection of main chart indicators which are overlaid the main chart.
+ contents:
+ - has_concept('main chart indicators')
+
+- subtitle: Subchart Indicators
+ desc: >
+ The collection of subchart indicators which are charted as a subchart.
+ contents:
+ - has_concept('subchart indicators')
+
+- title: Utilities
desc: Manipulate and calibrate objects
-- contents: has_concept('convinience')
+- contents: has_concept('utility')
+
- title: Datasets
desc: Sample datasets returned by ```get_quote()``` and ```get_fgindex()```
-- contents: has_concept('data')
-- title: Decprecated functions
- desc: These functions has been deprecated since version 1.3.0, and will be permanently deleted in the subsequent versions
-- contents: has_concept('deprecated')
-
+- contents:
+ - has_keyword('datasets')
diff --git a/codemeta.json b/codemeta.json
new file mode 100644
index 00000000..2e5c5836
--- /dev/null
+++ b/codemeta.json
@@ -0,0 +1,266 @@
+{
+ "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+ "@type": "SoftwareSourceCode",
+ "identifier": "cryptoQuotes",
+ "description": " This high-level API client offers a streamlined access to public cryptocurrency market data and sentiment indicators. It features OHLC-V (Open, High, Low, Close, Volume) that comes with granularity ranging from seconds to months and essential sentiment indicators to develop and backtest trading strategies, or conduct detailed market analysis. By interacting directly with the major cryptocurrency exchanges this package ensures a reliable, and stable, flow of market information, eliminating the need for complex, low-level API interactions or webcrawlers.",
+ "name": "cryptoQuotes: A Streamlined Access to Cryptocurrency OHLC-V Market Data and Sentiment Indicators",
+ "relatedLink": ["https://serkor1.github.io/cryptoQuotes/", "https://CRAN.R-project.org/package=cryptoQuotes"],
+ "codeRepository": "https://github.com/serkor1/cryptoQuotes",
+ "issueTracker": "https://github.com/serkor1/cryptoQuotes/issues",
+ "license": "https://spdx.org/licenses/GPL-2.0",
+ "version": "1.3.1",
+ "programmingLanguage": {
+ "@type": "ComputerLanguage",
+ "name": "R",
+ "url": "https://r-project.org"
+ },
+ "runtimePlatform": "R version 4.4.0 (2024-04-24)",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "author": [
+ {
+ "@type": "Person",
+ "givenName": "Serkan",
+ "familyName": "Korkmaz",
+ "email": "serkor1@duck.com",
+ "@id": "https://orcid.org/0000-0002-5052-0982"
+ }
+ ],
+ "contributor": [
+ {
+ "@type": "Person",
+ "givenName": "Serkan",
+ "familyName": "Korkmaz",
+ "email": "serkor1@duck.com",
+ "@id": "https://orcid.org/0000-0002-5052-0982"
+ },
+ {
+ "@type": "Person",
+ "givenName": "Jonas",
+ "familyName": "Cuzulan Hirani",
+ "email": "jjh@vive.dk",
+ "@id": "https://orcid.org/0000-0002-9512-1993"
+ }
+ ],
+ "copyrightHolder": [
+ {
+ "@type": "Person",
+ "givenName": "Serkan",
+ "familyName": "Korkmaz",
+ "email": "serkor1@duck.com",
+ "@id": "https://orcid.org/0000-0002-5052-0982"
+ }
+ ],
+ "maintainer": [
+ {
+ "@type": "Person",
+ "givenName": "Serkan",
+ "familyName": "Korkmaz",
+ "email": "serkor1@duck.com",
+ "@id": "https://orcid.org/0000-0002-5052-0982"
+ }
+ ],
+ "softwareSuggestions": [
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "data.table",
+ "name": "data.table",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=data.table"
+ },
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "knitr",
+ "name": "knitr",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=knitr"
+ },
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "quantmod",
+ "name": "quantmod",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=quantmod"
+ },
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "rmarkdown",
+ "name": "rmarkdown",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
+ },
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "testthat",
+ "name": "testthat",
+ "version": ">= 3.0.0",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=testthat"
+ },
+ {
+ "@type": "SoftwareApplication",
+ "identifier": "tidyverse",
+ "name": "tidyverse",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=tidyverse"
+ }
+ ],
+ "softwareRequirements": {
+ "1": {
+ "@type": "SoftwareApplication",
+ "identifier": "cli",
+ "name": "cli",
+ "version": ">= 3.6.2",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=cli"
+ },
+ "2": {
+ "@type": "SoftwareApplication",
+ "identifier": "curl",
+ "name": "curl",
+ "version": ">= 5.2.1",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=curl"
+ },
+ "3": {
+ "@type": "SoftwareApplication",
+ "identifier": "jsonlite",
+ "name": "jsonlite",
+ "version": ">= 1.8.8",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=jsonlite"
+ },
+ "4": {
+ "@type": "SoftwareApplication",
+ "identifier": "lifecycle",
+ "name": "lifecycle",
+ "version": ">= 1.0.4",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=lifecycle"
+ },
+ "5": {
+ "@type": "SoftwareApplication",
+ "identifier": "plotly",
+ "name": "plotly",
+ "version": ">= 4.10.4",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=plotly"
+ },
+ "6": {
+ "@type": "SoftwareApplication",
+ "identifier": "TTR",
+ "name": "TTR",
+ "version": ">= 0.24.4",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=TTR"
+ },
+ "7": {
+ "@type": "SoftwareApplication",
+ "identifier": "utils",
+ "name": "utils"
+ },
+ "8": {
+ "@type": "SoftwareApplication",
+ "identifier": "xts",
+ "name": "xts",
+ "version": ">= 0.13.2",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=xts"
+ },
+ "9": {
+ "@type": "SoftwareApplication",
+ "identifier": "zoo",
+ "name": "zoo",
+ "version": ">= 1.8-12",
+ "provider": {
+ "@id": "https://cran.r-project.org",
+ "@type": "Organization",
+ "name": "Comprehensive R Archive Network (CRAN)",
+ "url": "https://cran.r-project.org"
+ },
+ "sameAs": "https://CRAN.R-project.org/package=zoo"
+ },
+ "10": {
+ "@type": "SoftwareApplication",
+ "identifier": "R",
+ "name": "R",
+ "version": ">= 4.0.0"
+ },
+ "SystemRequirements": null
+ },
+ "fileSize": "808.095KB",
+ "releaseNotes": "https://github.com/serkor1/cryptoQuotes/blob/master/NEWS.md",
+ "readme": "https://github.com/serkor1/cryptoQuotes/blob/main/README.md",
+ "contIntegration": ["https://github.com/serkor1/cryptoQuotes/actions/workflows/R-CMD-check.yaml", "https://codecov.io/gh/serkor1/cryptoQuotes"],
+ "developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html#experimental",
+ "keywords": ["cryptocurrencies", "cryptocurrency", "cryptocurrency-exchanges", "r", "binance", "binance-api", "kucoin", "kucoin-api", "kraken-api", "kraken-exchange-api", "bitmart", "bybit", "bybit-api", "rstats", "rstats-package"]
+}
diff --git a/cran-comments.md b/cran-comments.md
index 42ef5b0f..85b962e4 100644
--- a/cran-comments.md
+++ b/cran-comments.md
@@ -2,22 +2,10 @@
0 errors âś” | 0 warnings âś” | 1 note âś–
-### The note
-
-```
- The Title field should be in title case. Current version is:
- 'A Streamlined Access to Cryptocurrency OHLC-V Market Data and Sentiment Indicators'
- In title case that is:
- 'A Streamlined Access to Cryptocurrency OHLC-v Market Data and Sentiment Indicators'
-```
-
-This `note` is related to `OHLC-V`, and since `OHLC-V` is an accepted shorthand for Open, High, Low, Close and Volume I believe this `note` should
-be ignored.
-
-## Resubmission
-
-This is a resubmission. In this version I have updated many elements in the library, but
-most importantly the unittests are being conducted in a manner that is robust to timing
-errors.
-
-
+❯ checking installed package size ... NOTE
+ installed size is 13.1Mb
+ sub-directories of 1Mb or more:
+ doc 11.9Mb
+
+This is beyond my technical knowledge, but here is a related SO-post:
+https://stackoverflow.com/questions/38639266/r-cmd-check-unusual-checking-installed-package-size-note
diff --git a/data-raw/ATOM.R b/data-raw/ATOM.R
index 2afd7088..57e60323 100644
--- a/data-raw/ATOM.R
+++ b/data-raw/ATOM.R
@@ -1,11 +1,10 @@
## code to prepare `ATOM` dataset goes here
-
# 1) generate ATOM
# with 15 minute candles
ATOM <- cryptoQuotes::get_quote(
ticker = "ATOMUSDT",
- source = "binance",
+ source = "bybit",
futures = FALSE,
interval = "15m",
from = "2023-12-30",
diff --git a/data-raw/BTC.R b/data-raw/BTC.R
index 4ee652e9..281f912b 100644
--- a/data-raw/BTC.R
+++ b/data-raw/BTC.R
@@ -4,7 +4,7 @@
# with weekly candles
BTC <- cryptoQuotes::get_quote(
ticker = "BTCUSDT",
- source = "binance",
+ source = "bybit",
futures = FALSE,
interval = "1w",
from = "2023-01-01",
diff --git a/data-raw/DOGE.R b/data-raw/DOGE.R
index 54ba82fa..b5c8098c 100644
--- a/data-raw/DOGE.R
+++ b/data-raw/DOGE.R
@@ -7,6 +7,7 @@
# He tweeted at 06:18 UTC on January 14, 2022
DOGE <- get_quote(
ticker = "DOGEUSDT",
+ source = "bybit",
interval = "1m",
from = as.POSIXct("2022-01-14 06:00:00", tz = "UTC"),
to = as.POSIXct("2022-01-14 07:00:00", tz = "UTC")
diff --git a/data-raw/control_data.R b/data-raw/control_data.R
new file mode 100644
index 00000000..87069d5f
--- /dev/null
+++ b/data-raw/control_data.R
@@ -0,0 +1,70 @@
+# script: control_data
+# author: Serkan Korkmaz, serkor1@duck.com
+# date: 2024-05-17
+# objective: The control data is an internal dataset
+# for all get_*-functions in daily format to conduct
+# thorough testing of charting functions and avoid
+# unnecessary bugs
+#
+# NOTE: Run this function before each PUSH to development
+# to incorporate changes to packages
+# script start;
+
+# 1) define functions
+# for naming datasets
+funs <- c(
+ "quote",
+ "fgindex",
+ "lsratio",
+ "openinterest",
+ "fundingrate"
+)
+
+# 2) run functions
+# accordingly
+control_data <- lapply(
+ X = funs,
+ FUN = function(FUN) {
+
+ # 2.1) extract function
+ # and store as foo
+ foo <- get(
+ paste0("get_", FUN),
+ envir = asNamespace('cryptoQuotes')
+ )
+
+ if (!(FUN == "fgindex")) {
+
+ foo(
+ ticker = "BTCUSDT",
+ source = "binance",
+ from = Sys.Date() - 100
+ )
+
+
+ } else {
+
+ foo(
+ from = Sys.Date() - 100
+ )
+
+ }
+
+
+ }
+)
+
+# 3) set names
+# of datasets
+names(control_data) <- funs
+
+# write data;
+usethis::use_data(
+ control_data,
+ overwrite = TRUE,
+ internal = TRUE
+)
+
+# script end;
+
+
diff --git a/data/ATOM.rda b/data/ATOM.rda
index 9f8762ccc7d17671f42471c99eb26828ca3f5688..e5bfe11a1e540af0cc07eb6a2dec5132198230bf 100644
GIT binary patch
literal 3161
zcmV-f45sr!T4*^jL0KkKSr$iOI{*axfB*mg|NsC0|NsC0{r~^}|NsC0|NsC0|NsC0
z|NsC0|Nr0#8$Lc>`I@hNUD!U~Zu@t)x6td*(B;=yR5V3X%~RCTpaVbyMt}y?&;S9Z
zfB*n`ni^;tXah!o8fXEa27m@b5unp*Vraw~F%3OH8XlUO8&mS5)HKiyN>jx&$i&cT
zqf8S`Gz>;OoIV5Fwg))CMKCNs2LAaN2t>T0AU&pJxqtG
zgvo#=6KI++)Kf{6^o^9$X`*>gM99-mD0)VoQG$AEG&ZKv28Nk5(U8MYp{9m_(V^-Z
z8&GMcgG`zL#Lx{541mz}Gz~InHl~_-gFw&*fuJ;k5(F6l0B8n*p{J>lri}m^20#Nt
zN2mZAGy$L*W{5Nm8UQpJX`?^@dWL{B#0>z@(9wzJsi0|~$xRfVglGnU02%;j0NR=W
z8VrG;Xc_}RXfy*uKmgIB5CcFOXk=&_4F*8<8fXB}226u$8foec0!avjQ!)_ArkNg~
z13~39V2@KH(hUPZ14hXj21Z68XlawsCZ3Z(2AT(^qiQ`MWMn-->KjBddSx`o1_B~+GUs^CcnGRcPRYU?M{Dq?pqY5$6y^2!2M9o1p#vLdK&ThZzSQmhD8(z)sSdc0tt?+%ejC;-6)1sO|pvhHh0lr2mjp!@A4-ar!S6J6g4GRdmoZ6SQ@`QPM
zbS++#kMrsEA(&B?8=J(Pb{gc4gusOHWutZjMCq&g%9<28P(1)S%LM(AIwycp!u@C#
zyh>TZd^(W;E``!G64=y!+$l8>;WB_Xpvar8zec+f6v0mM&N6^53=U-{z}}s}?FeVx
zKXN3tVOU-eGvO(+nu;VwHY5u{Che1rC#3txeoT0ofJo7$u0Tjr%dnx{YBkjSgSc^D
z#^{Uc%|!hcrD(RtT@}-e77zmv$shLKl!cXsE2!g3WFm9eE!p7Aef-
zU+3%*u)8M=#%fJkthf-;M8sIpv@a9)XeQBGhpD$R24qt(eNZsQBuD#++XP#-1{5!C
z64jm~1Dd9TY4x0b54er?G+gEys8qC>g?847-&2N0Eja<;Y(bD}fda@0Mua})L$;t!
zY#q<6M!F08T~gE-$(6aVV3%eBviQA{l<{}*3=Rv?peGc}vxp$&m3(>PYaKg^?4mUf}H!1W94@R0D%ZX#^ng-tL@5W*8e
zN#S;$mF+!73wjZUQPbxOgLFWt)Ubej#fwXb@TiDuc5GYHk&`-8mBk%)L*}p6aAk+uKSzC1
zE?0pEXwpzoSNDWnSVX8Jix)^y^meX@6Q<%>$cmMq?LKf$ISFNhB==V~$p~h_inTDp
zXL>PWpgGC~whoUYwFdiPlMVHbVSuRuh>T+GPzqb2@OR9G6lRiDdv!e~Ha7HnhhNK>
z#6aR)XeHv4G?=z-S)`>yD1kbNL|xadls74D4ROEXnr_PXX2bbk!2zd84LCF7XhCBh
z@`mJjC2Lg6yR18tB`YLqr1VY?^ZRJR1rQ?US;v3?1WS%7u$A$}2kb5u^*|bsRzm@J
zCHXhh{Eqd0UAqCwU&Shq1x3JvAkFC{Pt
zXMYC){xZIPxEw5Ny7bEkoRf9r0R7lKyTX_lDmL&A4Kz!ZyKuLT)L`4W>
zoHMlHlokb`ajyZnWV24=TtcAaE60x{2xsk+80e0$ygbFEHmnc?c|uEi00D;R6b6dB
z-jQf>)r#bE0sIELTl~rb&%H1NnS#yJYC~faAD3~G0@zZ7=@N2tXPYY^ah^AQ0LK@r
ziNI0Z2#tHKm|ML4;a9G;^jBPO&O)dl&1v3
zW<)4GWYb8&=UG)io7lepnlLi&Zj(eU`v+!G`O@mW)#Q-&T8N$j@jG6m@UhwgvXlzB>x>TUL=x%Gq~
znu4(oh-U9b9X>zGC?Tf@_774ULF{m_(UnYy$F(57;pLuj-Uu`oQ<)DkQCw%j**qOnNkPB6@Vh
z_4BcBS@aWhjQQYglpg{M^qQMUu_POSLg6g2UU*R&hs9o0G%6@kj#%#!O)0o&qH}QO
z$lvBEH#Q@u=a$J6kq)Ua%=3$ro$Xz&DspZfBPtsyT{cZYsm6?mYDDEQda_JBmRO82
zQSiB&s3>E^?E_mB)jEw<{9@|jp~>POBdZ5QJg^RH{wc=)D&__KNn&c9iHXFr!WcX5
zR#y>ZNqmN0h%i|Sq8;&MFGWwt%dbJtAR)ZL@SCByGhZ5Ism_o@B>O4yd0Y^v?EeH1
z*HTn7g?6l==4gV?7nTf3WuVq`Ga^}3AT}h3?-~RO@TnSK-NJclqBMp9J_=&n7Ys6F9LmY7#yleCDj%$%ma|tPB;FGFC8^DKnI+61hex
zK|TTDAW#CQE7q9s!v>s6Bq{XxkXJ8
z8|@l82tZh+9y22A8#WD6J%Y(%A{2iFK9z1=Y>F7mLeLx*m5m!JpoSr!?V@>-hEZ(}
z?!Gc6vn<|;2PlOXD77`x3xKDY+C{mUE<*rlCC6yQtq?t~9HSEy60C?_L5(s{Ot{A+
zlQSt2*c}1*2Eiz0{z*No{HS~&X22z(G%!77;6b(lOGr3Xx;UAg^d$2H4B_jS1`q10
zsIeiihl1a+=aRXe=x<4V$_-zGP)vdeZ8Zo&7>ArviE&~f0}m@EizTRzmqw!
zdrS}Yu|_7g`&+j%(rV{Dc$P&xmJz+=uo%DYQ4@L79ywO9ta0sG6^TjGIfk@^qEhN$
zcZtD;D2Y&cnZR}o5CbE0{g`{v+au%*;*Yd~d-HHR6#kZ2@BCfK6yZWZSsjGz|GBQ0
literal 2559
zcmV|v&T4*^jL0KkKS)TXlL;wW%fB*mg|NsB~zW@LK|Nnpg|NsC0|NsB@|NsC0
z|NsC0|Nr0zzew;(-tZ^9(xk}|1qEXw1i(fBOaU+e0$>14)L;gH27m)dzyJw>FotS9
z00EE&jDQA!0UBaxG{H7Ng8&Sv`za>%Pij3;k?7P6^&@J2sp@U2J*hUDO&V`h^*yQR
zNv4k`hLiO@Q%_Ay(2r9P7@7b800HU&pbQ`l00E%T#Lxyn01W^Jku(s|q{5z|>SzXm
z=?s7k27nC!00E!?05oK1&^=6m06jntQJ??-01Y$%001%o13@GtlS!oY2AMrZhD|gy
z89hMLN2#HwsMAduF#)4NriO>8(-6=AXwi|AMvXLRX{Li35FVz7s2ViMkjd&i)DURR
zOwwtD$PEwx000000000000000000J>0000000000000000001J5=cohlhkSHJtyil
zJf?s%P#Qfz(V%)yDB35eXnL6sQJROTfdPaz(mrh^m8Y%ev4%fO5TxZ?pOkdB4L9B^QV-|cJquUK%aou857(-K}i3VZqE1j|7;uW{<&S9>DEGjo0N
zErd(Lx%Tep4y&Jye+oxe5Lk(LcMs>=C}mXyj2}kkmI$FQ!NJN{KD~edB5-KuD;ysS
zMTDoXu!ul{RfR{{KB3X0`fpeJ^NB`M5_2S{(gs38ms&r-9sys5i4uT~#C=R@L__HvAlAiQ$SErA
zap|%$xQ&d}69_Prn+CZxu^1}bNdlFkspEdb`Jp=$=}zq0NTxwef3hGZnZ6Xwer-_5
zmdb7|yL1N`%uj@5``Va6gP-5G?b}ow8bp~Uw>8kKWLYwU9q9$*YT{{Y;LF;j*jEKl
zS}8Ey(^|9w-qT}r^|_fKD6kja3Mto2A=udDt&+DYO7!6rj`-HZte}mxU=9WnKtX{d
zi3}i4!f9?<1OJHIN9muy+M_*gU{lZ*tdS`u=FY32S%yhYSk6#vL$=%wMtmmjT#+}X
z$fipffW2XP94gh;|CRRqCCf%HSyH%(u=vE2)Ka~Omn)sC+5tSkXe_<3(Jg`eyf*&F
z4V>~~5L0CFA~pZ7p7B0o2jEcTK57}Rt%hl-(170&Y!ArT7FxYYI)Tum3F$O8yr3h1
z9Y!^dXTc;S27;4+bun4!1TlhMmOD3HqEO1q7(jhN#kKGvP<}b4zJ2S^CFsiXr8iMB
z%hG2s@*;6^g|mI6Gcqo=;~+guLdaF(_QX%L#XQ{O!V(Xp+rgbE{g7y9VVRb##-K>_
ztPaO_Ez4oZtkR$5SQo)fAwWAM$kGKjxRuJ%U6w`zn9&F|=oZ(hoke?AY3+sRcOYcL
z7ZxXYtfxG?Z^|bz6&CL_;cTA)@W_mkR5{Tjxjf}Zv8wec38`hY$sXR2iYf%zSB9n>
zrf%rz83<6iOc(EJs3<4aa^_yJz6N`7MR*0`UP@IAs+I$QI?g}<6mn<<
zQaHahTJ-e$WWvHjg{Ad2J&iEQ97xGyH*^+_i~D!4L_Wi+Xy@rZcr?^E<*wiRz$6N01U@`g^g5lqn}jI9lD1BtJD-g6;z%y~ou&
z0K2J?@--;541;Ua_@eb}(}Yp;tsR%PDPtp
z=)2y;yjc^V(kZ>RdLwGIBwyj+hh_o6h)&u}pmHV;02mLZ1tJ{9j#)J{^JCW{554P|
zOXz1B{8Of*)`9(F)K6BAqN)6dkQ!7eO{;3F?Sf%~7ugNB_-aN-*~TR9LCk|w%RcoD
z{E9+113Z7%CMG%4~Wd21?LiG%P%umUbg6sBG*9C75!$
z6ATLPG(CBi%@Cd){K{eJ=)DH5?cP{2fWY23FvUx!WxZ5A0BY?42jIM3
z_+P$0YtM>!+Bp!CO~bPNL57?#vDL0f!DXDxSgcL$(X5$SR6qPCVJ5s%zR@AO=FM-r
z1TVd^{iF_{K{}p;>Wq3uRx{e*z_F5I3wUC@3nb?wRPF(s#nmcz#yA3*_{I&k84lR2
zE5p0R(%Jm~q-2zZWCIrz1Ht5)vE9yX=*_~HirOQ5U^AZmIV7+~QgagYd@w-w!S
ztUX8~su5M=Ul58qGn|1r8Srwc#c{p5kxij>roJUdvXnf;$M+V@-rmxXhE9irp`<+oDim{WKt&(=77*Ymh0K*Mn
zIkOQAnLBuS$iT@u#Yzm?kwMi9fZ>vy>TyK}uMR_}yET`x5}C`sh3fHb?cM3-NGH+K
zZ0eo{B*TU=#W(~RD&zp7B7>afzB?Eu2aXyNvoKJT>J1guM@EG+&i)zVrXxH94MCEd
zteR|uq8ZrFg3f{rmp^^zZ-Q
z|NsC0|NqbhJ?aeZ>&LqFb9WU3)*6xqshXQmz#*mx^hWg)O`wK>gu)CVjV2J#WWh8H
z5uh~5lLXUh9+8B|$jHbKQv@_I>L6)=hL2O!G8mXarA-O6Q%@=CX_`O=0(mq>O+8IC
z(0ZPxMok(XP}vB?!K7$tdW{=U4H+5$#54~=13{tbGH7HBntF{54FGANY3U6xYNiRJ
zAZmE1H>!T1K*VBb8fXmUngwd%yO+mEDl-iFey-gaL0BstB^&?F*dYT$&ZBNvIJdpJbGf+K7$)xo?
zPfbHZAT$8eYI=`Rr>Fty4^Yt2qfFGn8hS%Uk0wnGzn-ZSqqM@whWv5ijkECxdh
zabny(NPZltX>-&3!Ru?ODJ461nQG+97}S8F0!ZLQ?K{OaGBNCCVL2klNLiS0ogSiP
z1R=ZK9dYu&`bi{`NhFd?gN!t?
zI5=@%wqq2;XdI%X<`R&QFf8h1!x~h=Ou&+S@5~2;zafzL$(agp$(u5dK^zEaZ8zHu
zX9W2B1YCTWQC~?DYz_Rlu3=s6Xbo2>qndy)8WYY0XE)ku^oy;J&U$CS=fJ$LkALUd
z$c0kt{B~Z7Vq8nuh^WEux0`q1X>QaVC@o%9S#i*Wl$VVo+oC+92(YMrc58ozMfB)h
z#g>~((G(~#Vig4dUV?}P5kv?p#vNt~VGazCZ(Fa|jWr!iC?}gJLWYdM}AC9&Qyqn^5qyanWoS)tiuzy=q8`
zrob{8E}wZAcSP9&rCE~Ods|aF?%S>Z^^TBSB#1yMVH@ojq*y{8uEC$8s9;2DyMJeI
zt%C0ZElHrp?`))COmgz6QD$5EgUI)kAg&_rULz3P(<5S%S4PbuT=F##moVfSA+o}R
z@Cx-Q&|eyC64NUfM|1)(1QbYc?jp1?48u~w0R!Oyt8wOw(jgNUDnUUrgJPKmL5Mw{
z)kDH<69<}LB#=qKp(dj6WZA(Y)JUZQcE$sNekH*M11YB^h(Q2QH9Mg@8^NnXi5-_)
zMhXVb=>_34mGiW}?_!j~<+7}(;XXNw+>`3VO}5+1fclaP9nCTbMu8IrJjy}1=
zew~}FJ!RUM-Y(B2y8VQwrfDaoBvTm=G^#dcXZU#DM84|fj|xQ*qx@u<*{Z(C-P~_;
z->l5$4!>Pu8n*@L+C1h9;vY2C^WytffKzT$!HW&iz(~^L4v-3jX)8;m#hVoj=+K_K
z&7@3y0f6s@$}y&vQFoQ-A@E>&u`yu!cJtsd53|6+AX5PVRUC1Oj^yvk9|>i1na{cU
z1XgycLNJT63Yl0DIGXiF(iI|w3;MCdPhCzdLGO26n9E14Fdv{pSwop3-}DRwR`(*y
zY9;EVr;@{mMXl#UMGj%z9Ngn5F#_ze?A;m!$<)xn^-5`s3)*GglgN
ztG1~JP7QHDh7<@zVVh4+B)B{{A%ih!B?5~{tU#0B&NL=Tl5S0#I*{TRvKuv6%uSRt
za%;@p)rA_exeQOE`aj~qK8_?{?`du4jWuyQ65>yxwCRlWwr2o7{HF$rEJz|6#G!{t
zxNrc5(tahVulmhS!pylq489f-x;5~=d?19sO}+(PgOVF20D}DigcQFFM+IFu2WWSuEqdBXcd<2Em9=0vlH3EOKtQ69ylR_LZ!WL`j-|?F_T_SsiHg3#ZdB7i
z!yS3ikqtW}u)K>{QSSaqA3_ib0!!Wki#K{8N3%D
zUE=~-=0k=N%QB)E*)m3J->``p%_FA8YWKpC*n`n
t@^=_}te$Qp-bXd5yK{6wA|R;>U?(w{z5C5(#7SNYxgwk>NHoCI$$*Oan}+}Z
literal 2007
zcmY+6dpOgJAIHD5i@7YhrpbI8#+1ccQYZS3ESIfgOfIFCluf#vaw$idO);S@5({l8
z6l1d>_tUOeX-}ybyd7j_v`8@CU>-qfgb_(EZv8DPGy#0e_*Zu;2k7C-q~u`E9PJW=#=uabLxblS6wae6XKJ;PtDMY{M<+8-c{J8f
zT|9RJ=iMVfE
z27p7TJhu-MX>>wTGz4I=M6DCp537vEPV^esOB|SVz%#X00A7AjBSIVzf
z#&$*ojEdWzOlZ}zd*p4LwF~4s+wnPreTQS-8Qrfxt9Mq0)d!h
z)|PC0dGKX7v;VtqrTD*`;6%XGBFq!NiPa?PECQT>m~?!Op+w?=J4IT3st?{m5(Xg@
zZZMsLDtVxIJw1pWv>qn3(aYqS-DSSfvF1B-1Qzc~>i|1YTk9x!NslyREt+tP7cKBk
z$73kiW2WB*WQQ~1v#q_YL3=ArE#IVbuSI1v?5oj19QguwG{IxRR_Ytv>lM3{;T&|7
zRqwnn0*O*nRUa$-Ghzoc;X>oE+YmqEqD)}GcR@0j7iX-N%G7K4s9#={K+UMJHakC7
zNKNV3Npjw>NIItIDoRMqr_}n)S*TU2F#I#o1jSYHez%;nH}^_1z6;W<2rZ+P7;){b
z`KF}lGj=(1--y9fw0rqup21MwcBHhf{?g0cE;K_mcc%K<=MevG$p&QaJETIx
ze)Y+RIOXESX0D5u2})XW7vbc?A}K&=koIXkcOhw;bDP)9nduiT74~!D+a2Bujx+jY
zLuI0ptJ$C4FV!-#e?DKJx$hI_6;tSy!}_LmDaZw*uwjC>&n~W`VLXuaO2_zMtwVQn
z%~XJB_zE196NBRBOC-N`6Gf`;jvI{Yu;ulI8eQznH4s6)9N#^asXz|;**>WnLVT`s
z8{c!z`s)X4C+RF0v&&Ux`vRtR-jhd{IF>6l*T%fU3nYA;=jNHASN7M=DnZwAlTz}H
zF$Ar>Gm2HSqxa$iZI?Zok-47wW1IDMn1QM&8^VTw(M=i`hPS@!NxrMAP7PFzGZm$(
z!O|2+JLnrl@1`svKPJ)H=N|R3bVV}iK^EYW5e+m!1eLE}1gEQ;_2Z{Ueof_`V59p<
z(`LQkny`sI9m9?%N2ZLJlWKQHV_GB!LJrm|VB_}&9x%st9ik6-=k1u~YIL_6KQm8&
zXkAp>-Z#_n=IKS*8avvKk5@493)O?K36n}hhGRl*wdReaXWIT*weF2r_Vblm9pp_P
zZ1YQRck=Wuu3+5u>OfRg*{!3DG&Ksix>GStjT_1yK5C)=w5^ETjhU+JYn7R|ynG`c
zA$+D9y`8j*iw8&6r*Y{3dZ2%+DlE~*^RaCoU~Z{j^D0x(A6Ho$CGjQP9q51Dn8ZP2
z5;>lQ6TEN;Or|}FS&_$KRkk1Yf3oIkb7M2yuVAUBvG1v)+8JjhKZYo=
z(;_@L*!PpSOR9u#aN_9l)c(_WFAZa2MA;w1wE#iejS};!&t^Gp8
zCh!u7x@JOsM9|&?t0srD-MT^7Efs|?)yra*!H>48zN5UzoV%c;nIVy9}Z0|fk#Eg2fiDo2x_DysWYEQ9F9
zfP%pMG4t-knfD{kHYN7gr};jOV}XIbG7wi8XA>%^>JpfrO|84;T7CWNJ|uR~(!Z=Z
mcKF*KwYhVC;qY}FB4nh1*@{OX8s0{#*n1|
diff --git a/data/DOGE.rda b/data/DOGE.rda
index 545887acce08b3141964833b52128a07d597da83..057b508fc5606390092f192b07d57c2373691f4c 100644
GIT binary patch
literal 1699
zcmV;U23+|k}SOpnzx27uatXwYZ?0004?dVmH%00STZ00000
zZBJ9w(dh#q&@}Y`G&BdO4Lv|KF~k4>13&-(&93?ZO2JwN~r00SV?CV&7M27nC!000008V#h#
z0017400U}@Mw8Mq14GnkXc_>}0iXbA27mwq)Bw-`001=5000dQ001-_YJfBv001-|
zpb}C-nUva^15Gs000Te
zhKntou@2rG9I;@WG$T-Do8D1^kckc|YOm_sloB$HEZfYg+LxC43Yjs^l)uSM22OWd`wlH!j7
zAOfoa^btzl!vTbZ#dQ7g2=1Av1VKPafZAP`PvAnflR+B%k)iq1PnFPZD~Ly1)aKNP
zs1T1;PJm&Q5fkG}I3ipiTz-f3$MkO8X2lmNbnCcLg5v02Uo&Lgs)R-W>!OnzoP=RQ
zd>c^M@v)g|#WQEpbsMfp(*&wuG4XGu1`&WcL|bTz1DS0NjbJjEWz{
z3bvHN(N2XFSsAYq`5J1ts%keB1q%MyOl@ToF{&jZs|+X5OmeTrW*$)>l1S$-Ko;V0
z&Dm9pw-YrxZ<#NiIZwWcGB=`NdeDMR(7?%}f8<{Xy8Hpm$D~#3Vnl3BFv~2q7%}sO
ziNPZCIN+j66Jq7zApK>>Nib~}Ww_OAgyF9V4pI%dz9pWH?HA$Fkg3sx=v}BXRj0eu
zal0c-Gf7LUV~7}S4205$q~Qp1Jgvz@<-WEvZWZfu$POm=Dvk<0FiAdOhzUit510|m
z708{nARL#LcOtLW_fmDrJ1t^hH)41C8d#Pl0}5!xRAL6q56BD-aL4uwUYJzamG|0{
zLL_B5gj?yryVgUDc{2->0X~LPs8p>&8yC4}?c1dFy#64Rzs*-Ll^XQKa)wE$VRr=`
z5i$e>5vhA3NJfy7>7Z{qghpb9lBvFeLVHQa5m^^0zxAFRYVk=)usWF)_isafra%`$
z7bqpXkq9_Q4y>QRju{T@9!L~2Pp|1@^PyC7|H_{7tF_^}KtaU>{yjmo``_qRh{gYWWmfWGod5Vubj-v}AL~3A=z-Cq!tSKTJHc
z!S{g9AthXP1nN;$F8NEJOR8J?X9e7tUeB7{cu+i>6!70G7upfVQT^LySm;%(DLxMR
zQFL2ohON`;=VILodX&##X`Gi(YAH>Jby@bWf$)3EJSe#f^<+camkGO6$uNhHluDO7
z2k8+%)nI~2eIG?=--C%JAa)qw--Db{#5nCg2js)vAqK~?)Boa`doUA2GMomB?BJFj
z07{h(a4P38Rb|se3=-vvn8B`G9%NKC2P&N0a6E%AI*C(X7b*s*2Y1P`-I5eMk|evy
z;GLj@!GY1GJ5FO9J5C)W)G7(3a~Jg2o*5J=1dxK|K#1jzbTyluKMYno&ZKg1O6RDG|U&1tWP*HNi5ulPGCSr10K@@I9THi2_}O
th75WuTcBp>lxzW{d_@ZbOd
literal 2534
zcmVTMu2^h^+F4G%-oo{BTWNLnrXEF
z44$CEX`>J{(@c#9L8&H9QROrZ02%-q0Aw^88hV3IDZM6{Pts~{5@Lpc01Y0aK-y}0
zgVX>9ngI0x&}aea8UO+683up=2dL9eL=96!^huM_X+1SD8%TN~r=-)=(-THb88iW)
zXf)GIBV?F>22C^uL7-$Z05oXRO&Vy?p{9)h8Z^+;)EYDZ(?);;Ll9z;M8JXS0B9Ki
z000dD(X|?A02%{8Gyn#MfY1N{0QCR^)Bpe)dVm3-02%-^XaFT5B7;C4pc*|u00000
zJws{$2dSgeBme+30001FXc_Yh=^QeMoYswu7XOseVgbLu?&#QvoIGpx
z3IB^F*PNbnOC$Y-w?W_{<8zKS4y#W4K02HP#={H&heSEYu!h$8zN1p`03e6d4wmB7
zv5zlKS~7RW2{JEWu@Y`%fQTLBBe#Ko0!=qN;b;IIIbw)>05!i+D2XmHlsvZKO#=Y>
z2lf&JbW#GA94$Z6G6@~X8?_lwMC!POqe53kp@zUGq43N^5w*Os=@f_(CeJEEOK{0-wD(U6A6y4T;}58?ZS-j=slDWI*KG5DdqTV%RJ~k8q*o
z74w8EaWGJwqfX~)>adWo5;)-djV;2-h-&+7zw!kJoG8GhF@gERXNH3xuIo{N*~1Xwl6x!O-XoNfto!v9~4eT
zbjf1UG0HLPYh0J9u^RB_O2Cy(SiJJJBEJuUuDMI2#)*1WD&>yqH>A3$jQ+E4){~z|
z5-Bo6nTvz>e(RLi>gHnVYf>;^MUx*14GJ1}EUKU{G#y0~6C%?H2n4x6fPyKj03`P^
zvJdg%fq9GhYu#PGJMGkabR8p93k-;gQl$ceq==9VY=k-jNFyAB(jZO|8W4u{Z(?T6sN5h&S2!x>Vlt7HltspJlX3RaDv*A=O7k%bS`MbMxj
z&Un!L;ufi@k42aF(~e&A8C3R+x%gA03Z0?zjR6nEhl+nJ(LORWo5
z#fucomEa_2ew7BY7Kq5b(!m=5y_%T9ONK6DbZh}^3}X~jh6W-fP?l8NEVV~L#N&sV
z5fYKqhmkQ|=ni`lOniclX7(?N@UOYmZN%iXNRjCxVi}+a4*PJJm`RI4K(jVJo)kwn
zgrbn9lA8em18zPUfvL%yxthkY7@Qeh4?V%C`EEWE#4r?{)LEJg_0L+Ou+9?$JYX=x
z6FkIaPFXM2+$k#Lrw>EDMPy=C>k=(RjR1qbSw_ffN7{UWNg3%RFb>nb9V-J{%A+t?
zgo1%kK#7o`U=^BxUX}4W6kDng7f`TiEdZw+@(|ybF`+3PdDXD8pYS^?D4vvp=_WBn
zDREahcEiz5^@8_Bt?1~5zJ7>Qfiffu@Tiz%H71B*8XJK{x&6@yZNxDm2|%$dymw$L
zdxEafQmKf`#{+jP6|NW#mfO01ZqS2UVB}dK?~@F&FmWr2n?-2I>+{Eu_egR3#wa9`
zGcdshsp;%KtuCWUiq{7preIauP8WBk`Kk1Mz$CWm`6a{OD)=&(A=tN#7GX}02#rYD
z2)e$%4~F&|rqI=4Lcq9NzX|*E$0uLc4+2~w-)AQJuc`*$J*BeJ1z_+}OnBbRTe4a7GOLBM97
zMl{&0X3e+u*KOstnpe+}lM#+7rjr-EnQ_;@uhdHt`7C%mIP5WFDtqXD2o63m;f&iR
zPD$GiWx)sn0HOydl6ec(ffPgtjX(qDL=buCfD5z@wH$&0v$BAzkSL0>L()U#p;8c;
z^UMz(WjVTUdp8~$s%|JuXZy#^ZU{yXjHs`dBtvZe>9B0sq~`y~=rx5ZL_i3<6d~X_
zkZ(C8Ktd6FAi!l8z9R(_SK4dXY)jNQWO%A
zS@%m9C2dv5woO#kt%T6CEsIlkRtIft(bh@(&)G9`X7-tRKF@dNxy)~V^UOT9K1>Uu
z4MW$1!MVPB4?xAH9sHfmA@kDbaI>Z_p@97v98}{e#wuf(W7UNdCTu6mQ&=pPNhD!S
z060!=sj+!2eU&6twssG%b>zrZy_No>xv{aKNqpc=k~&#?0!%Cbx95{cOo?t%b>rP*
zj({ovBLD#4SSo|e4ow1JZ%@!?{TZsD1jgb94Uoi47NHcyGvx-$>dTlyKu$x}1|Wo`
zpBy1EN#c}gz=8l>0L8%xVL68mq+YK7o%4ScYptIAKMC0r0l3tr3du=r`b)x+oL}Qa
zskLWSO)%feRo4yktUbsmK{+ic&yDZs7!h78-sY3U*Bkgqw-wSD8j%#^p5rn}3Lyy*S!@aKo72U*X5Q6>!pqdDy9WW9o9M#D06zgrYuMuvGJ8u(VhjE38t!fKpJyUBIKGS>ahh2JQxcaDiSlihhBcp_8EneYei>+X=b;-&b_9Zj>OCJPAQ;Z!!_dk6j
zWnn7EFO;z(&*ed1Q!se>(-r{YVfU!wqxPkl*!>M+mh}9;_Y>8Ys~#>7iUotNhKVb!
zg%_7AFRp11EC<{jE<>}FMSWZ>+I@S$kX)oubvW1``HT0S4oWj?g4`o*vqj&8g9Ud3J
zL1Z2dv|;Ri^-V^1Uao;lpoiPH39DYWhiV_Xtlzx&#*<(90DHkIa=g($;i^Ua%ksAF
z%VAZR8e1-e24%h9pfkck}%_dUwF*kt4+{l`L@EmbjNY;{p}gyM`B
zeYbL@K6V=tOPp6Ow^8mZLJAMebsDbWUuk|R>E|3Zk4%;xFNmV0T^GSaj_A4Q!-Fb`
zy{3ASF5U4XdWQPxcU1O|Ie=``9GQ4{vIaSNF{>;qOUTBkbBS0M5VPUz8Wyi|ay|r^
z@+W5dU#!>(r#_k5Y6`hjjM{2`Y;6|n^+qePC#|H`KXKIW#mKZvp5ZM?6o1{ma6iC*
zFV$t{eM&qTIQn@fG2V#eo-o4?RY=g_y}pgDd1*tzI+~5W?#$JEj3zurrxJz*Uqts)
z@Yu%4M!P^{rWbf_K#gefd;z-R&ZC^!U2f-{elJ?CY!*t-d)<;JkG?7YDEg%(
z(1)&FK-Zp=F>=38qLLFnaz9LWk}P$3`;
zLP&!70j!30(nM)p@qL{Rdd!#fGP(ghZlZKjhwak&vGPG&)cToZqb}PaBf-##c_ZS@
zN9fQTji=#9m6j%Ky1*0Rppu*XCON{OTCRz^TM;=dSoiknzLEWjRWdT-=P~g=16t49
RX6G4%7}3LRx4!F+o`-Q(4*UwrBtea{rMMBY&IVcnCiF*4RM#_j31zVMwW?
zO)>!W00*ekO$VU>27#aedVl}`8}(EDQ}s|k)kA3wGBgbUXaTmVqtx;0pz-NRqfhlv
z4GjPQ0MKYO2c&vUH1R?vswN2237`*AlO~4LXaH%Zm?IF=AkY~!8Zr$A^#Tk{`l*O-
z)kXv~dQpuq^*{{(2l}a?27qK_&Vz^GA)o*>089XwCJE>S#-^A6BLGGK
zA?N`;1i+X_p%?%F27nD3m`nfw000DH7)><5Oi_XV{;H~zVFDk24Lwq*XaEVC14)54
znoI!EFcF%Vm`nu3WWY24XicL*9)JR1Y8cb?K%eT31Z@CJ6HEXIFaQ8101c=TB1x!_
z4KyC08X7bKkQo{PWCK6|4K&fA=`_ip8X9QG2ATi{dY}e?0Q7(W00000000lw8jxpK
z-m;3uFYLf=XoNg}7lSJgPc-Vzz?7^(2ZJ0x)LxCK@YwKZwxRjOH110K&Hx0GH*lFjoAhTm}aEU3gX=DV1i5m3ta`av;>
zh=J6|91J)KhY=W>IuN9qDIO{d4yQ!e>xE&Bk~-rTOkD>@92Hh7s_hmmR})oAstyU6
zDrT(|sERiZ8BIaUaS74GO^;m?Mn?yMNy-qBwO=H`(Ig~b!()g8khPJ?6nC!HyWQ`4
zlgdDoVFDkL0SkWuy6djG>$~UKJkE(EkxStS=GsU|Y$=k-PT0hNL0dve5JqhZ-IB^8
z8V$7xh!RJ~hGZlFn_N^BN=t?bBu%Vz7S<}4hiV2TF6_}fV^**fQn%v&eLw;9zIEv`PWg45Mpykl9TmTZ5w_*llW4Q==cTDw^W*9ya%
z1~h1*Pn1|eqeg)cf~PbYbCIz_q5+XH$P$E{4h4PuLOj5yMdYVU>N%vV;IIU
zjM~y@13t8oP?1KJSds!oLJCFjLGVBo2w4}=UdE0Z1_8~K8}b?iQ<``BxqOG{C0=J53g__Y(u!Zi2<-rOK^t7`lkYIA>3{eC>ucU*dioDXipIUUN6*?4WIK78F)l6
z8%7DBh9jql0lpeB<0+SgWv)4^Hep$KY%F4jeQM2^R$A5>W!{(=q#MFPV`EGUhHH{B_m+ifNax#DUH6tD4DNAc9N>Y@iT-hL}wmvuyfo{Pt
zx1+dT_yv!^fr(AWTLmbeCqM;Y;8kA!tLOm&i+UE?3*Z8#5ir$^6Zu#)!GP?B{y<{L
zhz12Hkr>}wFbNO>0a_IZyg!)OR(<#WXXYvTc198Tw4MCLvG?P?_wdw5kYJn+$U%Px
zz~@Q?InZEcG>D_S&Vw-A+s)dLQr-t)&1`X~)k(1z`GJ+PCJLmz(r=YpR~6DqtFYX<
z=BnhRM9#rgEvl}>SgTvMcQkXLohTHVP6LyNCnA63g^2ED@qIWsE@d;#L$i1Exh}jU
z4vk;YRgCb+SLxa;{*J{dN>Y~wQs#fpr@9^7@Tz0rPZHvM(cHB$XUFc;9PesQ?)Qh9
zn%Kk`*rOQBjAL63HIH>0qWn=e^NU^0#Q#0f^R(l4p&oq8{f^fhaSb5^)vm6}(WH&Uye)hK@>HbL57d8??AW@l
ztewd_a>9YLN&6z%=%#avQ;*N9DPrUdlkZS1#R!N0agA6GXSSb-G
saY&cpJTt>R7Up The time-index}
+\item{open}{<\link{numeric}> Opening price}
+\item{high}{<\link{numeric}> Highest price}
+\item{low}{<\link{numeric}> Lowest price}
+\item{close}{<\link{numeric}> Closing price}
+\item{volume}{<\link{numeric}> Trading volume}
+}
}
\usage{
ATOM
}
\description{
-A xts object with 15m OHLCV of USDT denominated ATOM with 97 rows and 5 columns, from 2023-12-30 to 2023-12-31.
-}
-\details{
-\describe{
-\item{Open}{Opening price}
-\item{High}{Highest price}
-\item{Low}{Lowest price}
-\item{Close}{Closing price}
-\item{Volume}{Volume}
-}
+This dataset contains time-series data for the ATOM (ATOM)
+denominated in USDT (Tether), captured in 15-minute intervals.
+The data spans from December 30 to December 31, 2023.
}
-\seealso{
-Other data:
-\code{\link{BTC}},
-\code{\link{DOGE}},
-\code{\link{FGIndex}}
+\examples{
+# Load the dataset
+data("ATOM")
+
+# chart
+chart(
+ ticker = ATOM,
+ main = kline(),
+ sub = list(volume())
+)
}
-\concept{data}
\keyword{datasets}
diff --git a/man/BTC.Rd b/man/BTC.Rd
index dff63951..69386008 100644
--- a/man/BTC.Rd
+++ b/man/BTC.Rd
@@ -3,30 +3,36 @@
\docType{data}
\name{BTC}
\alias{BTC}
-\title{USDT denominated Bitcoin(BTC) with 1 week intervals}
+\title{USDT Denominated Bitcoin (BTCUSDT) Weekly Intervals}
\format{
-An object of class \code{xts} (inherits from \code{zoo}) with 52 rows and 5 columns.
+An \code{\link[xts:xts]{xts::xts()}}-object with 52 rows and 5 columns,
+
+\describe{
+\item{index}{<\link{POSIXct}> The time-index}
+\item{open}{<\link{numeric}> Opening price}
+\item{high}{<\link{numeric}> Highest price}
+\item{low}{<\link{numeric}> Lowest price}
+\item{close}{<\link{numeric}> Closing price}
+\item{volume}{<\link{numeric}> Trading volume}
+}
}
\usage{
BTC
}
\description{
-A xts object with weekly OHLCV of USDT denominated Bitcoin with 52 rows and 5 columns, from 2023-01-01 to 2023-12-31.
-}
-\details{
-\describe{
-\item{Open}{Opening price}
-\item{High}{Highest price}
-\item{Low}{Lowest price}
-\item{Close}{Closing price}
-\item{Volume}{Volume}
-}
+This dataset contains time-series data for Bitcoin (BTC)
+denominated in USDT (Tether), captured in weekly intervals.
+The data spans from January 1, 2023, to December 31, 2023.
}
-\seealso{
-Other data:
-\code{\link{ATOM}},
-\code{\link{DOGE}},
-\code{\link{FGIndex}}
+\examples{
+# Load the dataset
+data("BTC")
+
+# chart
+chart(
+ ticker = BTC,
+ main = kline(),
+ sub = list(volume())
+)
}
-\concept{data}
\keyword{datasets}
diff --git a/man/DOGE.Rd b/man/DOGE.Rd
index c97383d0..4bcc7450 100644
--- a/man/DOGE.Rd
+++ b/man/DOGE.Rd
@@ -3,30 +3,36 @@
\docType{data}
\name{DOGE}
\alias{DOGE}
-\title{USDT denominated DOGECOIN in 1m intervals}
+\title{USDT Denominated DOGECOIN (DOGEUSDT) 1-Minute Intervals}
\format{
-An object of class \code{xts} (inherits from \code{zoo}) with 61 rows and 5 columns.
+An \code{\link[xts:xts]{xts::xts()}}-object with 61 rows and 5 columns,
+
+\describe{
+\item{index}{<\link{POSIXct}> The time-index}
+\item{open}{<\link{numeric}> Opening price}
+\item{high}{<\link{numeric}> Highest price}
+\item{low}{<\link{numeric}> Lowest price}
+\item{close}{<\link{numeric}> Closing price}
+\item{volume}{<\link{numeric}> Trading volume}
+}
}
\usage{
DOGE
}
\description{
-A xts object with 1m OHLCV of USDT denominated Dogecoin with 61 rows and 5 columns.
-}
-\details{
-\describe{
-\item{Open}{Opening price}
-\item{High}{Highest price}
-\item{Low}{Lowest price}
-\item{Close}{Closing price}
-\item{Volume}{Volume}
-}
+This dataset contains time-series data for the DOGECOIN (DOGE)
+denominated in USDT (Tether), captured in 1-minute intervals.
+The data spans 2022-01-14 07:00:00 CET to 2022-01-14 08:00:00 CET.
}
-\seealso{
-Other data:
-\code{\link{ATOM}},
-\code{\link{BTC}},
-\code{\link{FGIndex}}
+\examples{
+# Load the dataset
+data("DOGE")
+
+# chart
+chart(
+ ticker = DOGE,
+ main = kline(),
+ sub = list(volume())
+)
}
-\concept{data}
\keyword{datasets}
diff --git a/man/FGIndex.Rd b/man/FGIndex.Rd
index 8071c705..4f525733 100644
--- a/man/FGIndex.Rd
+++ b/man/FGIndex.Rd
@@ -3,26 +3,40 @@
\docType{data}
\name{FGIndex}
\alias{FGIndex}
-\title{Fear and Greed Index Values}
+\title{Fear and Greed Index (FGI) values for the
+cryptocurrency market in daily intervals}
\format{
-An object of class \code{xts} (inherits from \code{zoo}) with 364 rows and 1 columns.
+An \code{\link[xts:xts]{xts::xts()}}-object with 364 rows and 1 columns,
+
+\describe{
+\item{index}{<\link{POSIXct}> The time-index}
+\item{fgi}{<\link{numeric}< The daily fear and greed index value}
+}
}
\usage{
FGIndex
}
\description{
-A xts object with Fear and Greed Index value. It has 689 rows, and 1 colum. Extracted from 2023-01-01 to 2023-12-31
+This dataset contains daily values of the Fear and Greed Index for the year
+2023, which is used to measure the sentiments of investors in the market.
+The data spans from January 1, 2023, to December 31, 2023.
}
\details{
-\describe{
-\item{FGI}{Daily Fear and Greed Index Value}
+The Fear and Greed Index goes from 0-100, and can be classified as follows,
+
+\itemize{
+\item 0-24, Extreme Fear
+\item 25-44, Fear
+\item 45-55, Neutral
+\item 56-75, Greed
+\item 76-100, Extreme Greed
}
}
-\seealso{
-Other data:
-\code{\link{ATOM}},
-\code{\link{BTC}},
-\code{\link{DOGE}}
+\examples{
+# Load the dataset
+data("FGIndex")
+
+# Get a summary of index values
+summary(FGIndex)
}
-\concept{data}
\keyword{datasets}
diff --git a/man/GET.Rd b/man/GET.Rd
index b55470c4..75be4caf 100644
--- a/man/GET.Rd
+++ b/man/GET.Rd
@@ -22,34 +22,28 @@ A \link{list} crated by \code{\link[jsonlite:fromJSON]{jsonlite::fromJSON()}}
GET-requests
}
\examples{
-# script: scr_GET
-# date: 2024-02-28
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: An example on how to use the GET-function
-# mostly for internal purposes
-# script start;
-
\dontrun{
+ # script start;
+
exchange <- "bybit"
futures <- FALSE
- # 1) define baseUrl
- # and endoint
+ # 1) define baseurl
base_url <- cryptoQuotes:::baseUrl(
- source = exchange,
+ source = exchange,
futures = futures
)
+ # 2) define endpoint
end_point <- cryptoQuotes:::endPoint(
source = "bybit",
futures = futures,
- type = "ohlc"
+ type = "ohlc"
)
-
- # 2) define parameters
- # that are passed into
- # GET
+ # 2) define actual
+ # parameters based on
+ # API docs
queries <- list(
symbol = "BTCUSDT",
category = "spot",
@@ -57,19 +51,19 @@ GET-requests
interval = "D"
)
-
# 3) perform GET request
- GET(
+ cryptoQuotes:::GET(
url = base_url,
endpoint = end_point,
query = queries
)
-}
-# script end;
+ # script end;
+}
}
\seealso{
Other development tools:
+\code{\link{chart_layout}()},
\code{\link{convert_date}()},
\code{\link{default_dates}()},
\code{\link{fetch}()},
diff --git a/man/add_event.Rd b/man/add_event.Rd
index 6b93276e..c9acfd3f 100644
--- a/man/add_event.Rd
+++ b/man/add_event.Rd
@@ -2,44 +2,36 @@
% Please edit documentation in R/chart_event.R
\name{add_event}
\alias{add_event}
-\title{add eventlines to
-the chart}
+\title{Add eventlines to the chart}
\usage{
-add_event(event_data, ...)
+add_event(data, ...)
}
\arguments{
-\item{event_data}{a \link{data.frame} with index, event and colors.}
+\item{data}{a \link{data.frame}-type object with \code{index}, \code{event}
+and \code{color} columns.}
-\item{...}{arguments pass interally by \link{chart}, ignore.}
+\item{...}{For internal use. Please ignore.}
}
\value{
-Invisbly returns a plotly object.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object with \code{shapes} and \code{annotations}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
-Common types of event indicators include earnings release dates, dividend payouts, central bank interest rate decisions, chart pattern breakouts, and geopolitical events like elections or geopolitical tensions.
-The choice of event indicators depends on the trader's or analyst's specific objectives and the factors they believe are most relevant to the asset's price movements.
+A high-level \code{\link[plotly:layout]{plotly::layout()}}-function.
+The function adds \code{shapes} and \code{annotations} to the main \code{\link[=chart]{chart()}}.
}
\details{
-TBA
+The \link{data.frame} must include the following columns,
+\itemize{
+\item \code{index} \link{integer} or \link{date}: corresponding to the event timing.
+\item \code{event} \link{character}: the event label.
+\item \code{color} \link{character}: the color of the event
}
-\section{Note}{
-The eventlines are drawn using \code{\link[plotly:layout]{plotly::layout()}}, so all existing
-eventlines will be replaced each time you call \code{\link[=add_event]{add_event()}}.
}
-
\examples{
-# script: scr_addEvents
-# date: 2023-12-07
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Describe the usage
-# of addEvents
# script start;
-# laod library
-library(cryptoQuotes)
-
# 1) Generate random events
# of buys and sells and convert
# to data.frame
@@ -48,8 +40,11 @@ library(cryptoQuotes)
# but only base R is shown here to avoid
# too many dependencies
set.seed(1903)
-event_data <- ATOM[
- sample(1:nrow(ATOM), size = 2)
+event_data <- cryptoQuotes::ATOM[
+ sample(
+ x = 1:nrow(cryptoQuotes::ATOM),
+ size = 2
+ )
]
# 1.1) Extract the index
@@ -61,7 +56,9 @@ index <- zoo::index(
# 1.2) Convert the coredata
# into a data.frame
event_data <- as.data.frame(
- zoo::coredata(event_data)
+ zoo::coredata(
+ event_data
+ )
)
# 1.3) Add the index into the data.frame
@@ -83,28 +80,30 @@ event_data$color <- ifelse(
event_data$event == 'Buy',
yes = 'darkgrey',
no = ifelse(
- subset(event_data, event == 'Buy')$Close < subset(event_data, event == 'Sell')$Close,
- yes = 'green',
- no = 'red'
+ test = subset(
+ x = event_data,
+ event == 'Buy')$close < subset(x = event_data, event == 'Sell')$close,
+ yes = 'green',
+ no = 'red'
)
)
# 1.6) modify the event to add
# closing price at each event
event_data$event <- paste0(
- event_data$event, ' @', event_data$Close
+ event_data$event, ' @', event_data$close
)
# 2) Chart the the klines
# and add the buy and sell events
-chart(
- ticker = ATOM,
- main = kline(),
+cryptoQuotes::chart(
+ ticker = cryptoQuotes::ATOM,
+ main = cryptoQuotes::kline(),
sub = list(
- volume()
+ cryptoQuotes::volume()
),
indicator = list(
- bollinger_bands()
+ cryptoQuotes::bollinger_bands()
),
event_data = event_data,
options = list(
@@ -121,6 +120,7 @@ Other chart indicators:
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
@@ -129,17 +129,37 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
-Other subcharts:
+Other subchart indicators:
\code{\link{fgi}()},
\code{\link{lsr}()},
\code{\link{macd}()},
\code{\link{rsi}()},
+\code{\link{smi}()},
\code{\link{volume}()}
+
+Other main chart indicators:
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{dema}()},
+\code{\link{donchian_channel}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
}
\concept{chart indicators}
-\concept{subcharts}
+\concept{main chart indicators}
+\concept{subchart indicators}
+\keyword{internal}
diff --git a/man/alma.Rd b/man/alma.Rd
index 12a3d694..9e786902 100644
--- a/man/alma.Rd
+++ b/man/alma.Rd
@@ -2,12 +2,19 @@
% Please edit documentation in R/chart_ma.R
\name{alma}
\alias{alma}
-\title{Add Arnaud Legoux Moving Average to the chart}
+\title{Add Arnaud Legoux Moving Average (ALMA) to the chart}
\usage{
-alma(price = "close", n = 9, offset = 0.85, sigma = 6, internal = list(), ...)
+alma(
+ price = "close",
+ n = 9,
+ offset = 0.85,
+ sigma = 6,
+ ...
+)
}
\arguments{
-\item{price}{A \link{character}-vector of \link{length} 1. Close by default. The name of the vector to passed into \link[TTR:MovingAverages]{TTR::ALMA}}
+\item{price}{A \link{character}-vector of \link{length} 1. "close" by default
+The name of the vector to passed into \link[TTR:MovingAverages]{TTR::ALMA}.}
\item{n}{Number of periods to average over. Must be between 1 and
\code{nrow(x)}, inclusive.}
@@ -16,62 +23,28 @@ alma(price = "close", n = 9, offset = 0.85, sigma = 6, internal = list(), ...)
\item{sigma}{Standard deviation of the distribution.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
-
-\item{...}{any other passthrough parameters}
+\item{...}{For internal use. Please ignore.}
}
\value{
-A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object wrapped in \code{\link[rlang:expr]{rlang::expr()}}.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object
}
\description{
\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.
+A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that
+interacts with \link{TTR}'s moving average family of functions.
+The function adds moving average indicators to the main \code{\link[=chart]{chart()}}.
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
- indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
+ cryptoQuotes::ema(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::wma(n = 21)
)
)
@@ -83,6 +56,7 @@ Other chart indicators:
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
@@ -91,6 +65,7 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
@@ -102,8 +77,26 @@ Other moving average indicators:
\code{\link{evwma}()},
\code{\link{hma}()},
\code{\link{sma}()},
+\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{bollinger_bands}()},
+\code{\link{dema}()},
+\code{\link{donchian_channel}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
}
\concept{chart indicators}
+\concept{main chart indicators}
\concept{moving average indicators}
diff --git a/man/assert.Rd b/man/assert.Rd
index 6c1a4529..6405a6c1 100644
--- a/man/assert.Rd
+++ b/man/assert.Rd
@@ -7,8 +7,8 @@
assert(..., error_message = NULL)
}
\arguments{
-\item{...}{expressions >= 1. If named the names are used as error messages, otherwise
-R's internal error-messages are thrown}
+\item{...}{expressions >= 1. If named the names are used
+as error messages, otherwise R's internal error-messages are thrown}
\item{error_message}{character. An error message, supports \link{cli}-formatting.}
}
@@ -16,111 +16,87 @@ R's internal error-messages are thrown}
\link{NULL} if all statements in ... are \link{TRUE}
}
\description{
-This function is a wrapper of \code{\link[=stopifnot]{stopifnot()}}, \code{\link[=tryCatch]{tryCatch()}} and \code{\link[cli:cli_abort]{cli::cli_abort()}} and asserts
-the truthfulness of the passed expression(s).
+This function is a wrapper of \code{\link[=stopifnot]{stopifnot()}}, \code{\link[=tryCatch]{tryCatch()}} and
+\code{\link[cli:cli_abort]{cli::cli_abort()}} and asserts the truthfulness of the passed expression(s).
}
\examples{
-# script: Assert truthfullness
-# of functions
-# date: 2024-02-22
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Demonstrate the use of the error-function. This is
-# mainly for contributers, and for my future self on how to use
-# this function properly
-#
-#
-# NOTE: As these are wrapped in try
-# they are not properly formatted.
-# script start;
-
-
-# 1) unnamed assert
-# expressions
-foo <- function(
+\dontrun{
+ # script start;
+
+ # 1) unnamed assert
+ # expressions
+ foo <- function(
a,
b) {
- # assert without
- # named expressions
- cryptoQuotes:::assert(
- is.numeric(a),
- is.numeric(b)
- )
+ # assert without
+ # named expressions
+ cryptoQuotes:::assert(
+ is.numeric(a),
+ is.numeric(b)
+ )
- a + b
+ a + b
-}
+ }
-# 1.1) returns
-# the regular R error
-# messages in cli-format
-try(
+ # 1.1) returns
+ # the regular R error
+ # messages in cli-format
foo(
a = "1",
b = "2"
)
-)
-
-
-# 2) named assert
-# expressions
-foo <- function(
+ # 2) named assert
+ # expressions
+ foo <- function(
a,
b) {
- cryptoQuotes:::assert(
- "{.arg a} is not {.cls numeric}" = is.numeric(a),
- "{.arg a} is not {.cls numeric}" = is.numeric(b)
- )
-
+ cryptoQuotes:::assert(
+ "{.arg a} is not {.cls numeric}" = is.numeric(a),
+ "{.arg a} is not {.cls numeric}" = is.numeric(b)
+ )
- a + b
+ a + b
-}
+ }
-# 2.2) Returns
-# custom error-messages
-# in cli-format
-try(
+ # 2.2) Returns
+ # custom error-messages
+ # in cli-format
foo(
a = "1",
b = "2"
)
-)
-
-# 3) custom error
-# messages on
-foo <- function(
+ # 3) custom error
+ # messages on
+ foo <- function(
a) {
- cryptoQuotes:::assert(
- is.numeric(a),
- error_message = sprintf(
- fmt = "{.val \%s} is not a numeric value.",
- a
+ cryptoQuotes:::assert(
+ is.numeric(a),
+ error_message = sprintf(
+ fmt = "{.val \%s} is not a numeric value.",
+ a
+ )
)
- )
- a
+ a
-}
+ }
-# 2.2) Returns
-# custom error-messages with
-# passed values in cli-format
-try(
+ # 2.2) Returns
+ # custom error-messages with
+ # passed values in cli-format
foo(
a = "1"
)
-)
-
-
-
-
-# script end;
+ # script end;
+}
}
\seealso{
\code{\link[=stopifnot]{stopifnot()}}, \code{\link[cli:cli_abort]{cli::cli_abort()}}, \code{\link[=tryCatch]{tryCatch()}}
diff --git a/man/availableExchanges.Rd b/man/availableExchanges.Rd
deleted file mode 100644
index f13c7a73..00000000
--- a/man/availableExchanges.Rd
+++ /dev/null
@@ -1,61 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/availableExchanges.R
-\name{availableExchanges}
-\alias{availableExchanges}
-\title{Get available exchanges}
-\usage{
-availableExchanges(type = "ohlc")
-}
-\arguments{
-\item{type}{\link{character}-vector of length 1. See details}
-}
-\value{
-An \code{\link[=invisible]{invisible()}} \link{character} vector containing available exchanges
-}
-\description{
-\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
-
-Get a vector of all available exchanges passed into the source
-argument of the get-functions.
-}
-\details{
-\subsection{Available types}{
-\itemize{
-\item ohlc: Open, High, Low, Close and Volume
-\item lsratio: Long-Short ratio
-\item fundingrate: Funding rates
-\item interest: Open perpetual contracts on both sides
-}
-}
-
-\subsection{Limits}{
-
-The endpoints supported by the \code{\link[=available_exchanges]{available_exchanges()}} are not uniform,
-so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily the same as those available for \code{\link[=get_quote]{get_quote()}}
-}
-}
-\examples{
-# script:
-# date: 2023-10-06
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective:
-# script start;
-
-## return all
-## available exchanges
-cryptoQuotes::available_exchanges()
-
-# script end;
-}
-\seealso{
-Other deprecated:
-\code{\link{availableIntervals}()},
-\code{\link{availableTickers}()},
-\code{\link{getFGIndex}()},
-\code{\link{getLSRatio}()},
-\code{\link{getQuote}()}
-}
-\author{
-Serkan Korkmaz
-}
-\concept{deprecated}
diff --git a/man/availableIntervals.Rd b/man/availableIntervals.Rd
deleted file mode 100644
index 876b3149..00000000
--- a/man/availableIntervals.Rd
+++ /dev/null
@@ -1,75 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/availableIntervals.R
-\name{availableIntervals}
-\alias{availableIntervals}
-\title{Get available intervals}
-\usage{
-availableIntervals(source = "binance", type = "ohlc", futures = TRUE)
-}
-\arguments{
-\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default. See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
-
-\item{type}{\link{character}-vector of length 1. See details}
-
-\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default. Returns futures market if \link{TRUE}, spot market otherwise.}
-}
-\value{
-An \code{\link[=invisible]{invisible()}} \link{character} vector containing the available intervals on
-the exchange, market and endpoint
-}
-\description{
-\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
-}
-\details{
-\subsection{Available types}{
-\itemize{
-\item ohlc: Open, High, Low, Close and Volume
-\item lsratio: Long-Short ratio
-\item fundingrate: Funding rates
-\item interest: Open perpetual contracts on both sides
-}
-}
-
-\subsection{Limits}{
-
-The endpoints supported by the \code{\link[=available_exchanges]{available_exchanges()}} are not uniform,
-so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily the same as those available for \code{\link[=get_quote]{get_quote()}}
-}
-}
-\examples{
-\dontrun{
- # script:
- # date: 2023-10-06
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective:
- # script start;
-
- # available intervals
- # at kucoin futures market
- cryptoQuotes::available_intervals(
- source = 'kucoin',
- futures = TRUE
- )
-
- # available intervals
- # at kraken spot market
- cryptoQuotes::available_intervals(
- source = 'kraken',
- futures = FALSE
- )
-
- # script end;
-}
-}
-\seealso{
-Other deprecated:
-\code{\link{availableExchanges}()},
-\code{\link{availableTickers}()},
-\code{\link{getFGIndex}()},
-\code{\link{getLSRatio}()},
-\code{\link{getQuote}()}
-}
-\author{
-Serkan Korkmaz
-}
-\concept{deprecated}
diff --git a/man/availableTickers.Rd b/man/availableTickers.Rd
deleted file mode 100644
index 49451558..00000000
--- a/man/availableTickers.Rd
+++ /dev/null
@@ -1,62 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/availableTickers.R
-\name{availableTickers}
-\alias{availableTickers}
-\title{Get available cryptocurrency pairs}
-\usage{
-availableTickers(source = "binance", futures = TRUE)
-}
-\arguments{
-\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default. See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
-
-\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default. Returns futures market if \link{TRUE}, spot market otherwise.}
-}
-\value{
-A \link{character}-vector of actively traded cryptocurrency pairs on the exchange, and the specified market.
-}
-\description{
-\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}
-
-This function returns all available
-cryptocurrewncy pairs on the \link{available_exchanges}
-}
-\details{
-The naming-conventions across, and within, \code{\link[=available_exchanges]{available_exchanges()}} are not necessarily the same. This function lists
-all actively traded tickers.
-}
-\examples{
-\dontrun{
- ## available tickers
- ## in Binance spot market
- head(
- cryptoQuotes::available_tickers(
- source = 'binance',
- futures = FALSE
- )
- )
-
- ## available tickers
- ## on Kraken futures market
- head(
- cryptoQuotes::available_tickers(
- source = 'kraken',
- futures = TRUE
- )
- )
-}
-
-
-
-}
-\seealso{
-Other deprecated:
-\code{\link{availableExchanges}()},
-\code{\link{availableIntervals}()},
-\code{\link{getFGIndex}()},
-\code{\link{getLSRatio}()},
-\code{\link{getQuote}()}
-}
-\author{
-Serkan Korkmaz
-}
-\concept{deprecated}
diff --git a/man/available_exchanges.Rd b/man/available_exchanges.Rd
index 61aacd2c..8e4ebd97 100644
--- a/man/available_exchanges.Rd
+++ b/man/available_exchanges.Rd
@@ -4,50 +4,51 @@
\alias{available_exchanges}
\title{Get available exchanges}
\usage{
-## available exchanges
-## by type
available_exchanges(
type = "ohlc"
)
}
\arguments{
-\item{type}{\link{character}-vector of length 1. See details}
+\item{type}{\link{character}-vector of \link{length} 1. One of,
+\itemize{
+\item \code{"ohlc"} - Available exchanges for Open, High, Low, Close and
+Volume market data. See the \code{\link[=get_quote]{get_quote()}}-function.
+\item \code{"lsratio"} - Available exchanges for Long-Short ratios.
+See the \code{\link[=get_lsratio]{get_lsratio()}}-function.
+\item \code{"fundingrate"} - Available exchanges for Funding rates.
+See the \code{\link[=get_fundingrate]{get_fundingrate()}}-function.
+\item \code{"interest"} - Available exchanges for Open interest on perpetual
+contracts on both sides. See the \code{\link[=get_openinterest]{get_openinterest()}}-function.
+}}
}
\value{
-An \code{\link[=invisible]{invisible()}} \link{character} vector containing available exchanges
+An \code{\link[=invisible]{invisible()}} \link{character}-vector containing available exchanges
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}}
-Get a vector of all available exchanges passed into the source
+Get a \link{vector} of all available exchanges passed into the \code{source}
argument of the get-functions.
}
\details{
-\subsection{Available types}{
-\itemize{
-\item ohlc: Open, High, Low, Close and Volume
-\item lsratio: Long-Short ratio
-\item fundingrate: Funding rates
-\item interest: Open perpetual contracts on both sides
-}
-}
-
-\subsection{Limits}{
-
The endpoints supported by the \code{\link[=available_exchanges]{available_exchanges()}} are not uniform,
-so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily the same as those available for \code{\link[=get_quote]{get_quote()}}
-}
+so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily
+the same as those available for \code{\link[=get_quote]{get_quote()}}
}
\examples{
-# script:
-# date: 2023-10-06
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective:
# script start;
-## return all
-## available exchanges
-cryptoQuotes::available_exchanges()
+# 1) available exchanges
+# on ohlc-v endpoint
+cryptoQuotes::available_exchanges(
+ type = "ohlc"
+ )
+
+# 2) available exchanges
+# on long-short ratios
+cryptoQuotes::available_exchanges(
+ type = "lsratio"
+)
# script end;
}
diff --git a/man/available_intervals.Rd b/man/available_intervals.Rd
index 97c23b4a..26858f58 100644
--- a/man/available_intervals.Rd
+++ b/man/available_intervals.Rd
@@ -4,60 +4,71 @@
\alias{available_intervals}
\title{Get available intervals}
\usage{
-available_intervals(source = "binance", type = "ohlc", futures = TRUE)
+available_intervals(
+ source = "binance",
+ type = "ohlc",
+ futures = TRUE
+)
}
\arguments{
-\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default. See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
+\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default.
+See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
-\item{type}{\link{character}-vector of length 1. See details}
+\item{type}{\link{character}-vector of \link{length} 1. One of,
+\itemize{
+\item \code{"ohlc"} - Available exchanges for Open, High, Low, Close and
+Volume market data. See the \code{\link[=get_quote]{get_quote()}}-function.
+\item \code{"lsratio"} - Available exchanges for Long-Short ratios.
+See the \code{\link[=get_lsratio]{get_lsratio()}}-function.
+\item \code{"fundingrate"} - Available exchanges for Funding rates.
+See the \code{\link[=get_fundingrate]{get_fundingrate()}}-function.
+\item \code{"interest"} - Available exchanges for Open interest on perpetual
+contracts on both sides. See the \code{\link[=get_openinterest]{get_openinterest()}}-function.
+}}
-\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default. Returns futures market if \link{TRUE}, spot market otherwise.}
+\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default.
+Returns futures market if \link{TRUE}, spot market otherwise.}
}
\value{
-An \code{\link[=invisible]{invisible()}} \link{character} vector containing the available intervals on
-the exchange, market and endpoint
+An \code{\link[=invisible]{invisible()}} \link{character}-vector containing the available intervals on
+the exchange, market and endpoint.
+
+\strong{Sample output}
+
+\if{html}{\out{}}\preformatted{#> i Available Intervals at "bybit" (futures):
+#> v 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d, 1M, 1w
+#> [1] "1m" "3m" "5m" "15m" "30m" "1h"
+}\if{html}{\out{ }}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}}
-Get available intervals for the \code{\link[=available_tickers]{available_tickers()}} on the \code{\link[=available_exchanges]{available_exchanges()}}.
+Get available intervals for the \code{\link[=available_tickers]{available_tickers()}}
+on the \code{\link[=available_exchanges]{available_exchanges()}}.
}
\details{
-\subsection{Available types}{
-\itemize{
-\item ohlc: Open, High, Low, Close and Volume
-\item lsratio: Long-Short ratio
-\item fundingrate: Funding rates
-\item interest: Open perpetual contracts on both sides
-}
-}
-
-\subsection{Limits}{
-
The endpoints supported by the \code{\link[=available_exchanges]{available_exchanges()}} are not uniform,
-so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily the same as those available for \code{\link[=get_quote]{get_quote()}}
-}
+so exchanges available for, say, \code{\link[=get_lsratio]{get_lsratio()}} is not necessarily
+the same as those available for \code{\link[=get_quote]{get_quote()}}
}
\examples{
\dontrun{
- # script:
- # date: 2023-10-06
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective:
# script start;
# available intervals
# at kucoin futures market
cryptoQuotes::available_intervals(
- source = 'kucoin',
- futures = TRUE
+ source = 'kucoin',
+ futures = TRUE,
+ type = "ohlc"
)
# available intervals
# at kraken spot market
cryptoQuotes::available_intervals(
- source = 'kraken',
- futures = FALSE
+ source = 'kraken',
+ futures = FALSE,
+ type = "ohlc"
)
# script end;
diff --git a/man/available_tickers.Rd b/man/available_tickers.Rd
index 791e9575..03197e3e 100644
--- a/man/available_tickers.Rd
+++ b/man/available_tickers.Rd
@@ -2,43 +2,52 @@
% Please edit documentation in R/available_tickers.R
\name{available_tickers}
\alias{available_tickers}
-\title{Get available cryptocurrency pairs}
+\title{Get actively traded cryptocurrency pairs}
\usage{
available_tickers(source = "binance", futures = TRUE)
}
\arguments{
-\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default. See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
+\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default.
+See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
-\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default. Returns futures market if \link{TRUE}, spot market otherwise.}
+\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default.
+Returns futures market if \link{TRUE}, spot market otherwise.}
}
\value{
-A \link{character}-vector of actively traded cryptocurrency pairs on the exchange, and the specified market.
+A \link{character}-vector of actively traded cryptocurrency pairs on the exchange,
+and the specified market.
+
+\strong{Sample output}
+
+\if{html}{\out{}}\preformatted{#> [1] "10000000AIDOGEUSDT" "1000000MOGUSDT" "10000COQUSDT"
+#> [4] "10000LADYSUSDT" "10000NFTUSDT" "10000SATSUSDT"
+}\if{html}{\out{ }}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}}
-Get available cryptocurrency pairs
+Get actively traded cryptocurrency pairs on the \code{\link[=available_exchanges]{available_exchanges()}}.
}
\details{
-The naming-conventions across, and within, \code{\link[=available_exchanges]{available_exchanges()}} are not necessarily the same. This function lists
-all actively traded tickers.
+The naming-conventions across, and within, \code{\link[=available_exchanges]{available_exchanges()}} are not
+necessarily the same. This function lists all actively traded tickers.
}
\examples{
\dontrun{
- ## available tickers
- ## in Binance spot market
+ # 1) available tickers
+ # in Binance spot market
head(
cryptoQuotes::available_tickers(
- source = 'binance',
+ source = 'binance',
futures = FALSE
)
)
- ## available tickers
- ## on Kraken futures market
+ # 2) available tickers
+ # on Kraken futures market
head(
cryptoQuotes::available_tickers(
- source = 'kraken',
+ source = 'kraken',
futures = TRUE
)
)
diff --git a/man/bollinger_bands.Rd b/man/bollinger_bands.Rd
index 2b5593c7..29d5dbb8 100644
--- a/man/bollinger_bands.Rd
+++ b/man/bollinger_bands.Rd
@@ -5,7 +5,13 @@
\title{Add Bollinger Bands
to the chart}
\usage{
-bollinger_bands(n = 20, sd = 2, maType = "SMA", internal = list(), ...)
+bollinger_bands(
+ n = 20,
+ sd = 2,
+ maType = "SMA",
+ color = '#4682b4',
+ ...
+)
}
\arguments{
\item{n}{Number of periods for moving average.}
@@ -14,63 +20,31 @@ bollinger_bands(n = 20, sd = 2, maType = "SMA", internal = list(), ...)
\item{maType}{A function or a string naming the function to be called.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
+\item{color}{A \link{character}-vector of \link{length} 1. "#4682b4" by default.}
\item{...}{Other arguments to be passed to the \code{maType} function.}
}
\value{
-Invisbly returns a plotly object.
+An \link{invisible} \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
-Bollinger Bands provide a visual representation of price volatility and are widely used by traders
-and investors to assess potential price reversals and trade opportunities in various financial markets, including stocks, forex, and commodities.
+A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that interacts
+with the \code{\link[TTR:bollingerBands]{TTR::BBands()}}-function. The function adds bollinger bands
+to the main \code{\link[=chart]{chart()}}.
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
- indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
- indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
+# Charting BTC using
+# candlesticks as main
+# chart
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::volume()
)
)
@@ -82,6 +56,7 @@ Other chart indicators:
\code{\link{alma}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
@@ -90,9 +65,27 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{dema}()},
+\code{\link{donchian_channel}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
}
\concept{chart indicators}
+\concept{main chart indicators}
diff --git a/man/calibrate_window.Rd b/man/calibrate_window.Rd
index af4118e0..74392426 100644
--- a/man/calibrate_window.Rd
+++ b/man/calibrate_window.Rd
@@ -24,19 +24,8 @@ This function is a high-level wrapper of \link{do.call} and \link{lapply} which
modifies each xts object stored in a \code{\link[=list]{list()}}.
}
\examples{
-# script: scr_FUN
-# date: 2023-12-27
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Demonstrate the use of the convinience
-# funtions
# script start;
-# by default the Fear and Greed Index
-# is given daily. So to align these values
-# with, say, weekly candles it has to be aggregated
-#
-# In this example the built-in data are used
-
# 1) check index of BTCUSDT and
# the Fear and Greed Index
setequal(
@@ -47,8 +36,8 @@ setequal(
# 2) to align the indices,
# we use the convincience functions
# by splitting the FGI by the BTC index.
-FGIndex <- split_window(
- xts = FGIndex,
+FGIndex <- cryptoQuotes::split_window(
+ xts = cryptoQuotes::FGIndex,
by = zoo::index(BTC),
# Remove upper bounds of the
@@ -64,7 +53,7 @@ FGIndex <- split_window(
# 3) as splitWindow returns a list
# it needs to passed into calibrateWindow
# to ensure comparability
-FGIndex <- calibrate_window(
+FGIndex <- cryptoQuotes::calibrate_window(
list = FGIndex,
# As each element in the list can include
@@ -79,22 +68,19 @@ FGIndex <- calibrate_window(
# 3) check if candles aligns
# accordingly
-setequal(
- zoo::index(BTC),
- zoo::index(FGIndex)
+stopifnot(
+ setequal(
+ zoo::index(BTC),
+ zoo::index(FGIndex)
+ )
)
-# As the dates are now aligned
-# and the Fear and Greed Index being summarised by
-# the first value, the Fear and Greed Index is the opening
-# Fear and Greed Index value, at each candle.
-
# script end;
}
\seealso{
-Other convinience:
+Other utility:
\code{\link{remove_bound}()},
\code{\link{split_window}()}
}
-\concept{convinience}
+\concept{utility}
diff --git a/man/chart.Rd b/man/chart.Rd
index fffc2157..0625b19f 100644
--- a/man/chart.Rd
+++ b/man/chart.Rd
@@ -2,92 +2,96 @@
% Please edit documentation in R/chart.R
\name{chart}
\alias{chart}
-\title{Build interactive financial charts}
+\title{Build an interactive financial chart}
\usage{
chart(
ticker,
- main = kline(),
- sub = list(volume()),
- indicator = list(bollinger_bands()),
+ main = list(kline()),
+ sub = list(),
+ indicator = list(),
event_data = NULL,
options = list()
)
}
\arguments{
-\item{ticker}{A \code{\link[xts:xts]{xts::xts()}}-object with Open, High, Low, Close and Volume columns.}
+\item{ticker}{An object with Open, High, Low, Close and Volume columns that
+can be coerced to a \code{\link[xts:xts]{xts::xts()}}-object.}
-\item{main}{A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object wrapped in \code{\link[rlang:expr]{rlang::expr()}}. \code{\link[=kline]{kline()}} by default.}
+\item{main}{A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-function. \code{\link[=kline]{kline()}} by default.}
-\item{sub}{An optional \link{list} of \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object(s) wrapped in \code{\link[rlang:expr]{rlang::expr()}}.}
+\item{sub}{An optional \link{list} of \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-function(s).}
-\item{indicator}{An optional \link{list} of \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object(s) wrapped in \code{\link[rlang:expr]{rlang::expr()}}.}
+\item{indicator}{An optional \link{list} of \code{\link[plotly:add_trace]{plotly::add_lines()}}-function(s).}
-\item{event_data}{An optional \link{data.frame} with event line(s) to be added to the \code{\link[=chart]{chart()}}. See \code{\link[=add_event]{add_event()}} for more details.}
+\item{event_data}{An optional \link{data.frame} with event line(s) to be added
+to the \code{\link[=chart]{chart()}}. See \code{\link[=add_event]{add_event()}} for more details.}
\item{options}{An optional \link{list} of \code{\link[=chart]{chart()}}-options. See details below.}
}
\value{
-Returns a \code{\link[plotly:plot_ly]{plotly::plot_ly()}} object.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}} object.
+
+\strong{Sample Output}
+\if{html}{
+ \out{}\figure{README-chartquote-1.png}{options: style="width:750px;max-width:75\%;"}\out{}
+}
+\if{latex}{
+ \out{\begin{center}}\figure{README-chartquote-1.png}\out{\end{center}}
+}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
-\code{\link[=chart]{chart()}} creates interactive financial charts using \code{\link[plotly:plot_ly]{plotly::plot_ly()}} as backend. It's a high-level function which collects
-and structures the passed chart elements.
+A high-level \code{\link[plotly:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:subplot]{plotly::subplot()}}-wrapper function
+for building interactive financial charts using
+the affiliated \link{chart}-functions. The \link{chart} consists of a main chart, and
+an optional subchart. The main chart supports overlaying various trading
+indicators like \link{sma} and \link{bollinger_bands}.
}
\details{
\subsection{Options}{
\itemize{
-\item \code{dark} A \link{logical}-value of \link{length} 1. \link{TRUE} by default. Sets the overall theme of the \code{\link[=chart]{chart()}}
-\item \code{slider} A \link{logical}-value of \link{length} 1. \link{FALSE} by default. If \link{TRUE}, a \code{\link[plotly:rangeslider]{plotly::rangeslider()}} is added.
-\item \code{deficiency} A \link{logical}-value of \link{length} 1. \link{FALSE} by default. If \link{TRUE}, all \code{\link[=chart]{chart()}}-elements are colorblind friendly
-\item \code{size} A \link{numeric}-value of \link{length} 1. The relative size of the main chart. 0.6 by default. Must be between 0 and 1, non-inclusive.
+\item \code{dark} A <\link{logical}>-value of \link{length} 1. \link{TRUE} by default.
+Sets the overall theme of the \code{\link[=chart]{chart()}}
+\item \code{slider} A <\link{logical}>-value of \link{length} 1. \link{FALSE} by default.
+If \link{TRUE}, a \code{\link[plotly:rangeslider]{plotly::rangeslider()}} is added
+\item \code{deficiency} A <\link{logical}>-value of \link{length} 1. \link{FALSE} by default.
+If \link{TRUE}, all \code{\link[=chart]{chart()}}-elements are colorblind friendly
+\item \code{size} A <\link{numeric}>-value of \link{length} 1. The relative size of the
+main chart. 0.6 by default. Must be between 0 and 1, non-inclusive
}
}
+
+\subsection{Charting Events}{
+
+If \code{event_data} is passed, vertical eventlines with appropriate labels and
+coloring are added to the \code{\link[=chart]{chart()}}.
+This function is rigid, as it will fail if event, label and
+index columns are not passed.
+
+For more details please see \code{\link[=add_event]{add_event()}}.
+}
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
- indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
+# 1) charting weekly
+# BTC using candlesticks
+# and indicators
+cryptoQuotes::chart(
ticker = BTC,
- main = macd(),
+ main = cryptoQuotes::kline(),
sub = list(
- volume(),
- kline()
+ cryptoQuotes::volume(),
+ cryptoQuotes::macd()
),
indicator = list(
- bollinger_bands(),
- sma()
+ cryptoQuotes::bollinger_bands(),
+ cryptoQuotes::sma(),
+ cryptoQuotes::alma()
),
options = list(
- dark = TRUE,
+ dark = TRUE,
deficiency = FALSE
)
)
@@ -95,11 +99,12 @@ chart(
# script end;
}
\seealso{
-Other chart indicators:
+Other chart indicators:
\code{\link{add_event}()},
\code{\link{alma}()},
\code{\link{bollinger_bands}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
@@ -108,14 +113,16 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
-Other price charts:
+Other price charts:
\code{\link{kline}()},
-\code{\link{ohlc}()}
+\code{\link{ohlc}()},
+\code{\link{pline}()}
}
\author{
Serkan Korkmaz
diff --git a/man/chart_layout.Rd b/man/chart_layout.Rd
new file mode 100644
index 00000000..ef8b9792
--- /dev/null
+++ b/man/chart_layout.Rd
@@ -0,0 +1,47 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/helper.R
+\name{chart_layout}
+\alias{chart_layout}
+\title{Create a list of layout elements on subcharts}
+\usage{
+chart_layout(x, layout_element, layout_attribute)
+}
+\arguments{
+\item{x}{\link{integer}-vector of \link{length} 1.}
+
+\item{layout_element}{\link{character}-vector of \link{length} 1.
+\link[plotly:layout]{plotly::layout} elements. See example.}
+
+\item{layout_attribute}{\link{character}-vector of \link{length} 1.
+\link[plotly:layout]{plotly::layout} element value. See example.}
+}
+\value{
+A \link{list} of layout elements.
+}
+\description{
+Create a list of layout elements on subcharts
+}
+\examples{
+\dontrun{
+chart_layout(
+ x = 1:plot_list_length,
+ layout_element = "yaxis",
+ layout_attribute = list(
+ gridcolor = if (dark) "#40454c" else '#D3D3D3' # Was CCCCCC
+ )
+)
+}
+
+
+}
+\seealso{
+Other development tools:
+\code{\link{GET}()},
+\code{\link{convert_date}()},
+\code{\link{default_dates}()},
+\code{\link{fetch}()},
+\code{\link{flatten}()},
+\code{\link{is.date}()}
+}
+\concept{development tools}
+\keyword{internal}
diff --git a/man/convert_date.Rd b/man/convert_date.Rd
index 69f7e3fe..5c90ef28 100644
--- a/man/convert_date.Rd
+++ b/man/convert_date.Rd
@@ -25,6 +25,7 @@ that its a return value
\seealso{
Other development tools:
\code{\link{GET}()},
+\code{\link{chart_layout}()},
\code{\link{default_dates}()},
\code{\link{fetch}()},
\code{\link{flatten}()},
diff --git a/man/default_dates.Rd b/man/default_dates.Rd
index e3e89cdc..0979b9d0 100644
--- a/man/default_dates.Rd
+++ b/man/default_dates.Rd
@@ -7,13 +7,17 @@
default_dates(interval, from = NULL, to = NULL, length = 200, limit = NULL)
}
\arguments{
-\item{interval}{A \link{character}-vector of \link{length} 1. \verb{1d} by default. See \code{\link[=available_intervals]{available_intervals()}} for available intervals.}
+\item{interval}{A \link{character}-vector of \link{length} 1. \verb{1d} by default.
+See \code{\link[=available_intervals]{available_intervals()}} for available intervals.}
-\item{from}{An optional \link{character}, \link{date} or \link{POSIXct} vector of \link{length} 1. \link{NULL} by default.}
+\item{from}{An optional \link{character}-, \link{date}- or
+\link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.}
-\item{to}{An optional \link{character}, \link{date} or \link{POSIXct} vector of \link{length} 1. \link{NULL} by default.}
+\item{to}{An optional \link{character}-, \link{date}- or
+\link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.}
-\item{length}{a \link{numeric}-value of \link{length} 1. The desired distance between \code{from} and \code{to}.}
+\item{length}{a \link{numeric}-value of \link{length} 1.
+The desired distance between \code{from} and \code{to}.}
}
\value{
A vector of minimum and maximum dates.
@@ -28,6 +32,7 @@ compliance on the limits
\seealso{
Other development tools:
\code{\link{GET}()},
+\code{\link{chart_layout}()},
\code{\link{convert_date}()},
\code{\link{fetch}()},
\code{\link{flatten}()},
diff --git a/man/dema.Rd b/man/dema.Rd
index 4f351804..f15aef88 100644
--- a/man/dema.Rd
+++ b/man/dema.Rd
@@ -2,19 +2,20 @@
% Please edit documentation in R/chart_ma.R
\name{dema}
\alias{dema}
-\title{Add Double Exponential Moving Average to the chart}
+\title{Add Double Exponential Moving Average (DEMA) to the chart}
\usage{
dema(
- price = "close",
- n = 10,
- v = 1,
- wilder = FALSE,
- ratio = NULL,
- internal = list()
+ price = "close",
+ n = 10,
+ v = 1,
+ wilder = FALSE,
+ ratio = NULL,
+ ...
)
}
\arguments{
-\item{price}{A \link{character}-vector of \link{length} 1. Close by default. The name of the vector to passed into \link[TTR:MovingAverages]{TTR::DEMA}}
+\item{price}{A \link{character}-vector of \link{length} 1. "close" by default.
+The name of the vector to passed into \link[TTR:MovingAverages]{TTR::DEMA}.}
\item{n}{Number of periods to average over. Must be between 1 and
\code{nrow(x)}, inclusive.}
@@ -27,60 +28,28 @@ calculated; see notes.}
\item{ratio}{A smoothing/decay ratio. \code{ratio} overrides \code{wilder}
in \code{EMA}.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
+\item{...}{For internal use. Please ignore.}
}
\value{
-A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object wrapped in \code{\link[rlang:expr]{rlang::expr()}}.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object
}
\description{
\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.
+A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that
+interacts with \link{TTR}'s moving average family of functions.
+The function adds moving average indicators to the main \code{\link[=chart]{chart()}}.
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
- indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
+ cryptoQuotes::ema(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::wma(n = 21)
)
)
@@ -92,6 +61,7 @@ Other chart indicators:
\code{\link{alma}()},
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
@@ -100,6 +70,7 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
@@ -111,8 +82,26 @@ Other moving average indicators:
\code{\link{evwma}()},
\code{\link{hma}()},
\code{\link{sma}()},
+\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{donchian_channel}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
}
\concept{chart indicators}
+\concept{main chart indicators}
\concept{moving average indicators}
diff --git a/man/donchian_channel.Rd b/man/donchian_channel.Rd
new file mode 100644
index 00000000..fcb1929f
--- /dev/null
+++ b/man/donchian_channel.Rd
@@ -0,0 +1,90 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/chart_donchian.R
+\name{donchian_channel}
+\alias{donchian_channel}
+\title{Add Donchian Channels
+to the chart}
+\usage{
+donchian_channel(
+ n = 10,
+ include.lag = FALSE,
+ color = '#4682b4',
+ ...
+)
+}
+\arguments{
+\item{n}{Number of periods for moving average.}
+
+\item{include.lag}{Should values be lagged so that today's prices are not
+included in the calculation? See Note.}
+
+\item{color}{A \link{character}-vector of \link{length} 1. "#4682b4" by default.}
+
+\item{...}{For internal use. Please ignore.}
+}
+\value{
+An \link{invisible} \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object.
+}
+\description{
+\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 the \code{\link[TTR:DonchianChannel]{TTR::DonchianChannel()}}-function.
+The function adds Donchian Channels
+to the main \code{\link[=chart]{chart()}}.
+}
+\examples{
+# script start;
+
+# Charting BTC using
+# candlesticks as main
+# chart
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::volume()
+ )
+)
+
+# script end;
+}
+\seealso{
+Other chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{chart}()},
+\code{\link{dema}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{fgi}()},
+\code{\link{hma}()},
+\code{\link{lsr}()},
+\code{\link{macd}()},
+\code{\link{rsi}()},
+\code{\link{sma}()},
+\code{\link{smi}()},
+\code{\link{volume}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{dema}()},
+\code{\link{ema}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
+}
+\concept{chart indicators}
+\concept{main chart indicators}
diff --git a/man/ema.Rd b/man/ema.Rd
index 2ca720db..b72b2a88 100644
--- a/man/ema.Rd
+++ b/man/ema.Rd
@@ -2,19 +2,19 @@
% Please edit documentation in R/chart_ma.R
\name{ema}
\alias{ema}
-\title{Add Exponentially Weighted Moving Average to the charts}
+\title{Add Exponentially-Weighted Moving Average (EMA) to the chart}
\usage{
ema(
- price = "Close",
- n = 10,
- wilder = FALSE,
- ratio = NULL,
- internal = list(),
- ...
+ price = "close",
+ n = 10,
+ wilder = FALSE,
+ ratio = NULL,
+ ...
)
}
\arguments{
-\item{price}{A \link{character}-vector of \link{length} 1. Close by default. The name of the vector to passed into \link[TTR:MovingAverages]{TTR::EMA}}
+\item{price}{A \link{character}-vector of \link{length} 1. "close" by default.
+The name of the vector to passed into \link[TTR:MovingAverages]{TTR::EMA}.}
\item{n}{Number of periods to average over. Must be between 1 and
\code{nrow(x)}, inclusive.}
@@ -25,62 +25,28 @@ calculated; see notes.}
\item{ratio}{A smoothing/decay ratio. \code{ratio} overrides \code{wilder}
in \code{EMA}.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
-
-\item{...}{any other passthrough parameters}
+\item{...}{For internal use. Please ignore.}
}
\value{
-A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object wrapped in \code{\link[rlang:expr]{rlang::expr()}}.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object
}
\description{
\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.
+A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that
+interacts with \link{TTR}'s moving average family of functions.
+The function adds moving average indicators to the main \code{\link[=chart]{chart()}}.
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
- indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
+ cryptoQuotes::ema(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::wma(n = 21)
)
)
@@ -93,6 +59,7 @@ Other chart indicators:
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{evwma}()},
\code{\link{fgi}()},
\code{\link{hma}()},
@@ -100,6 +67,7 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
@@ -111,8 +79,26 @@ Other moving average indicators:
\code{\link{evwma}()},
\code{\link{hma}()},
\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{dema}()},
+\code{\link{donchian_channel}()},
+\code{\link{evwma}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
}
+\author{
+Serkan Korkmaz
+}
\concept{chart indicators}
+\concept{main chart indicators}
\concept{moving average indicators}
diff --git a/man/evwma.Rd b/man/evwma.Rd
index f8ef2f3e..cdfbcd98 100644
--- a/man/evwma.Rd
+++ b/man/evwma.Rd
@@ -2,72 +2,43 @@
% Please edit documentation in R/chart_ma.R
\name{evwma}
\alias{evwma}
-\title{Add Elastic Volume-weighted Moving Average to the chart}
+\title{Add Elastic Volume-Weighted Moving Average (EVWMA) to the chart}
\usage{
-evwma(price = "Close", n = 10, internal = list(), ...)
+evwma(
+ price = "close",
+ n = 10,
+ ...
+)
}
\arguments{
-\item{price}{A \link{character}-vector of \link{length} 1. Close by default. The name of the vector to passed into \link[TTR:MovingAverages]{TTR::EVWMA}}
+\item{price}{A \link{character}-vector of \link{length} 1. "close" by default.
+The name of the vector to passed into \link[TTR:MovingAverages]{TTR::EVWMA}}
\item{n}{Number of periods to average over. Must be between 1 and
\code{nrow(x)}, inclusive.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
-
-\item{...}{any other passthrough parameters}
+\item{...}{For internal use. Please ignore.}
}
\value{
-A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object wrapped in \code{\link[rlang:expr]{rlang::expr()}}.
+A \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object
}
\description{
\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.
+A high-level \code{\link[plotly:add_trace]{plotly::add_lines()}}-wrapper function that
+interacts with \link{TTR}'s moving average family of functions.
+The function adds moving average indicators to the main \code{\link[=chart]{chart()}}.
}
\examples{
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
- ticker = BTC,
- main = kline(),
- sub = list(
- volume(),
- macd()
- ),
- indicator = list(
- bollinger_bands(),
- sma(),
- alma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
- deficiency = FALSE
+ cryptoQuotes::ema(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::wma(n = 21)
)
)
@@ -80,6 +51,7 @@ Other chart indicators:
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{fgi}()},
\code{\link{hma}()},
@@ -87,6 +59,7 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
@@ -98,8 +71,26 @@ Other moving average indicators:
\code{\link{ema}()},
\code{\link{hma}()},
\code{\link{sma}()},
+\code{\link{vwap}()},
\code{\link{wma}()},
\code{\link{zlema}()}
+
+Other main chart indicators:
+\code{\link{add_event}()},
+\code{\link{alma}()},
+\code{\link{bollinger_bands}()},
+\code{\link{dema}()},
+\code{\link{donchian_channel}()},
+\code{\link{ema}()},
+\code{\link{hma}()},
+\code{\link{sma}()},
+\code{\link{vwap}()},
+\code{\link{wma}()},
+\code{\link{zlema}()}
+}
+\author{
+Serkan Korkmaz
}
\concept{chart indicators}
+\concept{main chart indicators}
\concept{moving average indicators}
diff --git a/man/examples/devtools_flatten.R b/man/examples/devtools_flatten.R
index 5bd6e753..34928576 100644
--- a/man/examples/devtools_flatten.R
+++ b/man/examples/devtools_flatten.R
@@ -1,8 +1,3 @@
-# script: flattten
-# date: 2024-03-03
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Give an example
-# of the flatten-function
# script start;
# 1) create a nested list
@@ -20,5 +15,4 @@ cryptoQuotes:::flatten(
nested_list
)
-
# script end;
diff --git a/man/examples/scr_FGIndex.R b/man/examples/scr_FGIndex.R
index 74afba10..09843b6e 100644
--- a/man/examples/scr_FGIndex.R
+++ b/man/examples/scr_FGIndex.R
@@ -1,9 +1,4 @@
\dontrun{
- # script: Fear and Greed Index
- # date: 2023-12-26
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective: Retrieve and Plot the
- # index
# script start;
# 1) get the fear and greed index
diff --git a/man/examples/scr_FUN.R b/man/examples/scr_FUN.R
index d7842089..773371f0 100644
--- a/man/examples/scr_FUN.R
+++ b/man/examples/scr_FUN.R
@@ -1,16 +1,5 @@
-# script: scr_FUN
-# date: 2023-12-27
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Demonstrate the use of the convinience
-# funtions
# script start;
-# by default the Fear and Greed Index
-# is given daily. So to align these values
-# with, say, weekly candles it has to be aggregated
-#
-# In this example the built-in data are used
-
# 1) check index of BTCUSDT and
# the Fear and Greed Index
setequal(
@@ -21,8 +10,8 @@ setequal(
# 2) to align the indices,
# we use the convincience functions
# by splitting the FGI by the BTC index.
-FGIndex <- split_window(
- xts = FGIndex,
+FGIndex <- cryptoQuotes::split_window(
+ xts = cryptoQuotes::FGIndex,
by = zoo::index(BTC),
# Remove upper bounds of the
@@ -38,7 +27,7 @@ FGIndex <- split_window(
# 3) as splitWindow returns a list
# it needs to passed into calibrateWindow
# to ensure comparability
-FGIndex <- calibrate_window(
+FGIndex <- cryptoQuotes::calibrate_window(
list = FGIndex,
# As each element in the list can include
@@ -53,15 +42,12 @@ FGIndex <- calibrate_window(
# 3) check if candles aligns
# accordingly
-setequal(
- zoo::index(BTC),
- zoo::index(FGIndex)
+stopifnot(
+ setequal(
+ zoo::index(BTC),
+ zoo::index(FGIndex)
+ )
)
-# As the dates are now aligned
-# and the Fear and Greed Index being summarised by
-# the first value, the Fear and Greed Index is the opening
-# Fear and Greed Index value, at each candle.
-
# script end;
diff --git a/man/examples/scr_GET.R b/man/examples/scr_GET.R
index de18230a..4a1b3730 100644
--- a/man/examples/scr_GET.R
+++ b/man/examples/scr_GET.R
@@ -1,31 +1,25 @@
-# script: scr_GET
-# date: 2024-02-28
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: An example on how to use the GET-function
-# mostly for internal purposes
-# script start;
-
\dontrun{
+ # script start;
+
exchange <- "bybit"
futures <- FALSE
- # 1) define baseUrl
- # and endoint
+ # 1) define baseurl
base_url <- cryptoQuotes:::baseUrl(
- source = exchange,
+ source = exchange,
futures = futures
)
+ # 2) define endpoint
end_point <- cryptoQuotes:::endPoint(
source = "bybit",
futures = futures,
- type = "ohlc"
+ type = "ohlc"
)
-
- # 2) define parameters
- # that are passed into
- # GET
+ # 2) define actual
+ # parameters based on
+ # API docs
queries <- list(
symbol = "BTCUSDT",
category = "spot",
@@ -33,13 +27,12 @@
interval = "D"
)
-
# 3) perform GET request
- GET(
+ cryptoQuotes:::GET(
url = base_url,
endpoint = end_point,
query = queries
)
-}
-# script end;
+ # script end;
+}
diff --git a/man/examples/scr_LSR.R b/man/examples/scr_LSR.R
index f4c3fe86..ab3dd6ab 100644
--- a/man/examples/scr_LSR.R
+++ b/man/examples/scr_LSR.R
@@ -1,45 +1,13 @@
\dontrun{
- # Example on loading
- # long-short ratio
- # for the last days
- # on the 15 minute candle
- # wrapped in try to avoid
- # failure on Github
+ # script start;
- # 1) long-short ratio
- # on BTCUSDT pair
- ls_ratio <- cryptoQuotes::get_lsratio(
- ticker = 'BTCUSDT',
+ LS_BTC <- cryptoQuotes::get_lsratio(
+ ticker = 'BTCUSDT',
interval = '15m',
- from = Sys.Date() - 1,
- to = Sys.Date()
+ from = Sys.Date() - 1,
+ to = Sys.Date()
)
- # 2) BTCSDT in same period
- # as the long-short ratio;
- BTC <- cryptoQuotes::get_quote(
- ticker = 'BTCUSDT',
- futures = TRUE,
- interval = '15m',
- from = Sys.Date() - 1,
- to = Sys.Date()
- )
-
- # 3) plot BTCUSDT-pair
- # with long-short ratio
- cryptoQuotes::chart(
- ticker = BTC,
- main = cryptoQuotes::kline(),
- sub = list(
- cryptoQuotes::lsr(ratio = ls_ratio),
- cryptoQuotes::volume()
- ),
- indicator = list(
- cryptoQuotes::bollinger_bands()
- )
- )
+ # end of scrtipt;
}
-
-
-# end of scrtipt;
diff --git a/man/examples/scr_MAindicator.R b/man/examples/scr_MAindicator.R
new file mode 100644
index 00000000..47c2b989
--- /dev/null
+++ b/man/examples/scr_MAindicator.R
@@ -0,0 +1,13 @@
+# script start;
+
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
+ indicator = list(
+ cryptoQuotes::ema(n = 7),
+ cryptoQuotes::sma(n = 14),
+ cryptoQuotes::wma(n = 21)
+ )
+)
+
+# script end;
diff --git a/man/examples/scr_addEvents.R b/man/examples/scr_addEvents.R
index a0deaa29..6f02c3a2 100644
--- a/man/examples/scr_addEvents.R
+++ b/man/examples/scr_addEvents.R
@@ -1,13 +1,5 @@
-# script: scr_addEvents
-# date: 2023-12-07
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Describe the usage
-# of addEvents
# script start;
-# laod library
-library(cryptoQuotes)
-
# 1) Generate random events
# of buys and sells and convert
# to data.frame
@@ -16,8 +8,11 @@ library(cryptoQuotes)
# but only base R is shown here to avoid
# too many dependencies
set.seed(1903)
-event_data <- ATOM[
- sample(1:nrow(ATOM), size = 2)
+event_data <- cryptoQuotes::ATOM[
+ sample(
+ x = 1:nrow(cryptoQuotes::ATOM),
+ size = 2
+ )
]
# 1.1) Extract the index
@@ -29,7 +24,9 @@ index <- zoo::index(
# 1.2) Convert the coredata
# into a data.frame
event_data <- as.data.frame(
- zoo::coredata(event_data)
+ zoo::coredata(
+ event_data
+ )
)
# 1.3) Add the index into the data.frame
@@ -51,28 +48,30 @@ event_data$color <- ifelse(
event_data$event == 'Buy',
yes = 'darkgrey',
no = ifelse(
- subset(event_data, event == 'Buy')$Close < subset(event_data, event == 'Sell')$Close,
- yes = 'green',
- no = 'red'
+ test = subset(
+ x = event_data,
+ event == 'Buy')$close < subset(x = event_data, event == 'Sell')$close,
+ yes = 'green',
+ no = 'red'
)
)
# 1.6) modify the event to add
# closing price at each event
event_data$event <- paste0(
- event_data$event, ' @', event_data$Close
+ event_data$event, ' @', event_data$close
)
# 2) Chart the the klines
# and add the buy and sell events
-chart(
- ticker = ATOM,
- main = kline(),
+cryptoQuotes::chart(
+ ticker = cryptoQuotes::ATOM,
+ main = cryptoQuotes::kline(),
sub = list(
- volume()
+ cryptoQuotes::volume()
),
indicator = list(
- bollinger_bands()
+ cryptoQuotes::bollinger_bands()
),
event_data = event_data,
options = list(
diff --git a/man/examples/scr_assert.R b/man/examples/scr_assert.R
index 5844b1e1..5d23cb33 100644
--- a/man/examples/scr_assert.R
+++ b/man/examples/scr_assert.R
@@ -1,101 +1,77 @@
-# script: Assert truthfullness
-# of functions
-# date: 2024-02-22
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Demonstrate the use of the error-function. This is
-# mainly for contributers, and for my future self on how to use
-# this function properly
-#
-#
-# NOTE: As these are wrapped in try
-# they are not properly formatted.
-# script start;
-
-
-# 1) unnamed assert
-# expressions
-foo <- function(
+\dontrun{
+ # script start;
+
+ # 1) unnamed assert
+ # expressions
+ foo <- function(
a,
b) {
- # assert without
- # named expressions
- cryptoQuotes:::assert(
- is.numeric(a),
- is.numeric(b)
- )
+ # assert without
+ # named expressions
+ cryptoQuotes:::assert(
+ is.numeric(a),
+ is.numeric(b)
+ )
- a + b
+ a + b
-}
+ }
-# 1.1) returns
-# the regular R error
-# messages in cli-format
-try(
+ # 1.1) returns
+ # the regular R error
+ # messages in cli-format
foo(
a = "1",
b = "2"
)
-)
-
-
-# 2) named assert
-# expressions
-foo <- function(
+ # 2) named assert
+ # expressions
+ foo <- function(
a,
b) {
- cryptoQuotes:::assert(
- "{.arg a} is not {.cls numeric}" = is.numeric(a),
- "{.arg a} is not {.cls numeric}" = is.numeric(b)
- )
-
+ cryptoQuotes:::assert(
+ "{.arg a} is not {.cls numeric}" = is.numeric(a),
+ "{.arg a} is not {.cls numeric}" = is.numeric(b)
+ )
- a + b
+ a + b
-}
+ }
-# 2.2) Returns
-# custom error-messages
-# in cli-format
-try(
+ # 2.2) Returns
+ # custom error-messages
+ # in cli-format
foo(
a = "1",
b = "2"
)
-)
-
-# 3) custom error
-# messages on
-foo <- function(
+ # 3) custom error
+ # messages on
+ foo <- function(
a) {
- cryptoQuotes:::assert(
- is.numeric(a),
- error_message = sprintf(
- fmt = "{.val %s} is not a numeric value.",
- a
+ cryptoQuotes:::assert(
+ is.numeric(a),
+ error_message = sprintf(
+ fmt = "{.val %s} is not a numeric value.",
+ a
+ )
)
- )
- a
+ a
-}
+ }
-# 2.2) Returns
-# custom error-messages with
-# passed values in cli-format
-try(
+ # 2.2) Returns
+ # custom error-messages with
+ # passed values in cli-format
foo(
a = "1"
)
-)
-
-
-
-
-# script end;
+ # script end;
+}
diff --git a/man/examples/scr_availableExchanges.R b/man/examples/scr_availableExchanges.R
index 2c9e0bd8..c7858168 100644
--- a/man/examples/scr_availableExchanges.R
+++ b/man/examples/scr_availableExchanges.R
@@ -1,11 +1,15 @@
-# script:
-# date: 2023-10-06
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective:
# script start;
-## return all
-## available exchanges
-cryptoQuotes::available_exchanges()
+# 1) available exchanges
+# on ohlc-v endpoint
+cryptoQuotes::available_exchanges(
+ type = "ohlc"
+ )
+
+# 2) available exchanges
+# on long-short ratios
+cryptoQuotes::available_exchanges(
+ type = "lsratio"
+)
# script end;
diff --git a/man/examples/scr_availableIntervals.R b/man/examples/scr_availableIntervals.R
index cb6426fb..94a43865 100644
--- a/man/examples/scr_availableIntervals.R
+++ b/man/examples/scr_availableIntervals.R
@@ -1,22 +1,20 @@
\dontrun{
- # script:
- # date: 2023-10-06
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective:
# script start;
# available intervals
# at kucoin futures market
cryptoQuotes::available_intervals(
- source = 'kucoin',
- futures = TRUE
+ source = 'kucoin',
+ futures = TRUE,
+ type = "ohlc"
)
# available intervals
# at kraken spot market
cryptoQuotes::available_intervals(
- source = 'kraken',
- futures = FALSE
+ source = 'kraken',
+ futures = FALSE,
+ type = "ohlc"
)
# script end;
diff --git a/man/examples/scr_availableTickers.R b/man/examples/scr_availableTickers.R
index d3dfe3e2..34bcefb9 100644
--- a/man/examples/scr_availableTickers.R
+++ b/man/examples/scr_availableTickers.R
@@ -1,18 +1,18 @@
\dontrun{
- ## available tickers
- ## in Binance spot market
+ # 1) available tickers
+ # in Binance spot market
head(
cryptoQuotes::available_tickers(
- source = 'binance',
+ source = 'binance',
futures = FALSE
)
)
- ## available tickers
- ## on Kraken futures market
+ # 2) available tickers
+ # on Kraken futures market
head(
cryptoQuotes::available_tickers(
- source = 'kraken',
+ source = 'kraken',
futures = TRUE
)
)
diff --git a/man/examples/scr_chartFGIndex.R b/man/examples/scr_chartFGIndex.R
new file mode 100644
index 00000000..7dab24b6
--- /dev/null
+++ b/man/examples/scr_chartFGIndex.R
@@ -0,0 +1,34 @@
+\dontrun{
+ # script start;
+
+ # 1) get the fear and greed index
+ # for the last 14 days
+ FGIndex <- cryptoQuotes::get_fgindex(
+ from = Sys.Date() - 14
+ )
+
+ # 2) get the BTC price
+ # for the last 14 days
+ BTC <- cryptoQuotes::get_quote(
+ ticker = "BTCUSDT",
+ source = "bybit",
+ futures = FALSE,
+ from = Sys.Date() - 14
+ )
+
+ # 3) chart the daily BTC
+ # along side the Fear and
+ # Greed Index
+ cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
+ sub = list(
+ fgi(
+ FGIndex
+ )
+ )
+ )
+
+ # script end;
+}
+
diff --git a/man/examples/scr_chartLSR.R b/man/examples/scr_chartLSR.R
new file mode 100644
index 00000000..b6ee883a
--- /dev/null
+++ b/man/examples/scr_chartLSR.R
@@ -0,0 +1,37 @@
+\dontrun{
+ # script start;
+
+ # 1) long-short ratio
+ # on BTCUSDT pair
+ LS_BTC <- cryptoQuotes::get_lsratio(
+ ticker = 'BTCUSDT',
+ interval = '15m',
+ from = Sys.Date() - 1,
+ to = Sys.Date()
+ )
+
+ # 2) BTCSDT in same period
+ # as the long-short ratio;
+ BTC <- cryptoQuotes::get_quote(
+ ticker = 'BTCUSDT',
+ futures = TRUE,
+ interval = '15m',
+ from = Sys.Date() - 1,
+ to = Sys.Date()
+ )
+
+ # 3) plot BTCUSDT-pair
+ # with long-short ratio
+ cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::lsr(
+ ratio = LS_BTC
+ )
+ )
+ )
+
+ # end of scrtipt;
+}
+
diff --git a/man/examples/scr_charting.R b/man/examples/scr_charting.R
index 69836337..7bdb3636 100644
--- a/man/examples/scr_charting.R
+++ b/man/examples/scr_charting.R
@@ -1,45 +1,22 @@
-# script: scr_charting
-# date: 2023-10-25
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Charting in general
# script start;
-## charting the klines
-## with indicators as
-## subcharts
-chart(
+# 1) charting weekly
+# BTC using candlesticks
+# and indicators
+cryptoQuotes::chart(
ticker = BTC,
- main = kline(),
+ main = cryptoQuotes::kline(),
sub = list(
- volume(),
- macd()
+ cryptoQuotes::volume(),
+ cryptoQuotes::macd()
),
indicator = list(
- bollinger_bands(),
- sma(),
- alma()
+ cryptoQuotes::bollinger_bands(),
+ cryptoQuotes::sma(),
+ cryptoQuotes::alma()
),
options = list(
- dark = TRUE,
- deficiency = FALSE
- )
-)
-
-## charting the MACD-indicator
-## with klines as subcharts
-chart(
- ticker = BTC,
- main = macd(),
- sub = list(
- volume(),
- kline()
- ),
- indicator = list(
- bollinger_bands(),
- sma()
- ),
- options = list(
- dark = TRUE,
+ dark = TRUE,
deficiency = FALSE
)
)
diff --git a/man/examples/scr_getFundingrate.R b/man/examples/scr_getFundingrate.R
index f7652822..cd129084 100644
--- a/man/examples/scr_getFundingrate.R
+++ b/man/examples/scr_getFundingrate.R
@@ -1,24 +1,21 @@
\dontrun{
-# script: Funding Rate example
-# date: 2024-03-01
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Fetch
-# funding rate from one of the available
-# exchanges
# script start;
# 1) check available
# exchanges for funding rates
-available_exchanges(type = "fundingrate")
+cryptoQuotes::available_exchanges(
+ type = "fundingrate"
+ )
# 2) get BTC funding rate
# for the last 7 days
tail(
- BTC <- get_fundingrate(
+ BTC <- cryptoQuotes::get_fundingrate(
ticker = "BTCUSDT",
source = "binance",
from = Sys.Date() - 7
)
)
+
# script end;
}
diff --git a/man/examples/scr_getOpeninterest.R b/man/examples/scr_getOpeninterest.R
index afd6c213..788d5681 100644
--- a/man/examples/scr_getOpeninterest.R
+++ b/man/examples/scr_getOpeninterest.R
@@ -1,20 +1,16 @@
\dontrun{
- # script: Open Interest Example
- # date: 2024-03-03
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective: Fetch
- # funding rate from one of the available
- # exchanges
# script start;
# 1) check available
# exchanges for open interest
- available_exchanges(type = 'interest')
+ cryptoQuotes::available_exchanges(
+ type = 'interest'
+ )
# 2) get BTC funding rate
# for the last 7 days
tail(
- BTC <- get_openinterest(
+ BTC <- cryptoQuotes::get_openinterest(
ticker = "BTCUSDT",
source = "binance",
from = Sys.Date() - 7
diff --git a/man/examples/scr_getQuote.R b/man/examples/scr_getQuote.R
index 28eebc65..62a2f498 100644
--- a/man/examples/scr_getQuote.R
+++ b/man/examples/scr_getQuote.R
@@ -1,34 +1,20 @@
\dontrun{
-# script: scr_getQuote
-# date: 2024-02-29
-# author: Serkan Korkmaz, serkor1@duck.com
-# objective: Demonstrate the basic
-# usage of the get_quote-function
-# script start;
+ # script start;
-
- # 1) Load BTC spot
- # from Kucoin with 30 minute
- # intervals
- BTC <- cryptoQuotes::get_quote(
- ticker = 'BTCUSDT',
- source = 'binance',
- interval = '30m',
- futures = FALSE,
- from = Sys.Date() - 1
- )
-
- # 2) chart the spot price
- # using the chart
- # function
- cryptoQuotes::chart(
- ticker = BTC,
- main = cryptoQuotes::kline(),
- indicator = list(
- cryptoQuotes::volume(),
- cryptoQuotes::bollinger_bands()
+ # get quote on
+ # BTCUSDT pair from
+ # Binance in 30m
+ # intervals from the
+ # last 24 hours
+ tail(
+ BTC <- cryptoQuotes::get_quote(
+ ticker = 'BTCUSDT',
+ source = 'binance',
+ interval = '30m',
+ futures = FALSE,
+ from = Sys.Date() - 1
)
)
-# script end;
+ # script end;
}
diff --git a/man/examples/scr_klinechart.R b/man/examples/scr_klinechart.R
new file mode 100644
index 00000000..f370c1dc
--- /dev/null
+++ b/man/examples/scr_klinechart.R
@@ -0,0 +1,14 @@
+# script start;
+
+# Charting BTC using
+# candlesticks as main
+# chart
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::kline(),
+ sub = list(
+ cryptoQuotes::volume()
+ )
+)
+
+# script end;
diff --git a/man/examples/scr_ohlcchart.R b/man/examples/scr_ohlcchart.R
new file mode 100644
index 00000000..9241313d
--- /dev/null
+++ b/man/examples/scr_ohlcchart.R
@@ -0,0 +1,14 @@
+# script start;
+
+# Charting BTC using
+# OHLC-bars as main
+# chart
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::ohlc(),
+ sub = list(
+ cryptoQuotes::volume()
+ )
+)
+
+# script end;
diff --git a/man/examples/scr_plinechart.R b/man/examples/scr_plinechart.R
new file mode 100644
index 00000000..b799e2e1
--- /dev/null
+++ b/man/examples/scr_plinechart.R
@@ -0,0 +1,14 @@
+# script start;
+
+# Charting BTC using
+# line charts with closing price
+# as main chart
+cryptoQuotes::chart(
+ ticker = BTC,
+ main = cryptoQuotes::pline(),
+ sub = list(
+ cryptoQuotes::volume()
+ )
+)
+
+# script end;
diff --git a/man/fetch.Rd b/man/fetch.Rd
index 9aa0c20d..ca415c91 100644
--- a/man/fetch.Rd
+++ b/man/fetch.Rd
@@ -7,19 +7,35 @@
fetch(ticker, source, futures, interval, type, to, from, ...)
}
\arguments{
-\item{ticker}{An \link{character}-vector of \link{length} 1. See \code{\link[=available_tickers]{available_tickers()}} for available tickers.}
+\item{ticker}{A \link{character}-vector of \link{length} 1.
+See \code{\link[=available_tickers]{available_tickers()}} for available tickers.}
-\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default. See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
+\item{source}{A \link{character}-vector of \link{length} 1. \code{binance} by default.
+See \code{\link[=available_exchanges]{available_exchanges()}} for available exchanges.}
-\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default. Returns futures market if \link{TRUE}, spot market otherwise.}
+\item{futures}{A \link{logical}-vector of \link{length} 1. \link{TRUE} by default.
+Returns futures market if \link{TRUE}, spot market otherwise.}
-\item{interval}{A \link{character}-vector of \link{length} 1. \verb{1d} by default. See \code{\link[=available_intervals]{available_intervals()}} for available intervals.}
+\item{interval}{A \link{character}-vector of \link{length} 1. \verb{1d} by default.
+See \code{\link[=available_intervals]{available_intervals()}} for available intervals.}
-\item{type}{\link{character}-vector of length 1. See details}
+\item{type}{\link{character}-vector of \link{length} 1. One of,
+\itemize{
+\item \code{"ohlc"} - Available exchanges for Open, High, Low, Close and
+Volume market data. See the \code{\link[=get_quote]{get_quote()}}-function.
+\item \code{"lsratio"} - Available exchanges for Long-Short ratios.
+See the \code{\link[=get_lsratio]{get_lsratio()}}-function.
+\item \code{"fundingrate"} - Available exchanges for Funding rates.
+See the \code{\link[=get_fundingrate]{get_fundingrate()}}-function.
+\item \code{"interest"} - Available exchanges for Open interest on perpetual
+contracts on both sides. See the \code{\link[=get_openinterest]{get_openinterest()}}-function.
+}}
-\item{to}{An optional \link{character}, \link{date} or \link{POSIXct} vector of \link{length} 1. \link{NULL} by default.}
+\item{to}{An optional \link{character}-, \link{date}- or
+\link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.}
-\item{from}{An optional \link{character}, \link{date} or \link{POSIXct} vector of \link{length} 1. \link{NULL} by default.}
+\item{from}{An optional \link{character}-, \link{date}- or
+\link{POSIXct}-vector of \link{length} 1. \link{NULL} by default.}
\item{...}{additional parameters passed down the endpoint}
}
@@ -33,12 +49,13 @@ This function is a high-level wrapper around the development tools available
and should reduce the amount of coding.
}
\details{
-This function can only be used to fetch time-based objects, and can therefore
-not be used to get, for example, \code{\link[=available_tickers]{available_tickers()}}.
+This function can only be used to fetch time-based objects,
+and can therefore not be used to get, for example, \code{\link[=available_tickers]{available_tickers()}}.
}
\seealso{
Other development tools:
\code{\link{GET}()},
+\code{\link{chart_layout}()},
\code{\link{convert_date}()},
\code{\link{default_dates}()},
\code{\link{flatten}()},
diff --git a/man/fgi.Rd b/man/fgi.Rd
index b1708a29..85b346f5 100644
--- a/man/fgi.Rd
+++ b/man/fgi.Rd
@@ -4,24 +4,26 @@
\alias{fgi}
\title{Chart the Fear and Greed Index}
\usage{
-fgi(index, internal = list())
+fgi(index, ...)
}
\arguments{
-\item{index}{The Fear and Greed Index created by \code{\link[=getFGIndex]{getFGIndex()}}}
+\item{index}{A \code{\link[xts:xts]{xts::xts()}}-object. See \code{\link[=get_fgindex]{get_fgindex()}} for more details.}
-\item{internal}{An empty \link{list}. Used for internal purposes. Ignore.}
+\item{...}{For internal use. Please ignore.}
}
\value{
-Invisbly returns a plotly object.
+An \link{invisible} \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-object.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
-The fear and greed index is a market sentiment indicator that measures investor emotions to
-gauge whether they are generally fearful (indicating potential selling pressure) or greedy (indicating potential buying enthusiasm)
+A high-level \code{\link[plotly:plot_ly]{plotly::plot_ly()}}-wrapper function.
+The function adds a subchart with the \verb{fear and greed}-index.
}
\details{
-The Fear and Greed Index goes from 0-100, and can be classifed as follows
+\subsection{Classification}{
+
+The Fear and Greed Index goes from 0-100, and can be classified as follows,
\itemize{
\item 0-24, Extreme Fear
@@ -31,20 +33,52 @@ The Fear and Greed Index goes from 0-100, and can be classifed as follows
\item 76-100, Extreme Greed
}
}
+
+\subsection{About the Fear and Greed Index}{
+
+The fear and greed index is a market sentiment indicator that measures
+investor emotions to gauge whether they are generally fearful
+(indicating potential selling pressure) or
+greedy (indicating potential buying enthusiasm).
+}
+
+\subsection{Source}{
+
+This index is fetched from
+\href{https://alternative.me/crypto/fear-and-greed-index/}{alternative.me},
+and can be different from the one provided by
+\href{https://coinmarketcap.com/charts/#fear-and-greed-index}{coinmarketcap}.
+}
+}
\examples{
\dontrun{
- # script: Fear and Greed Index
- # date: 2023-12-26
- # author: Serkan Korkmaz, serkor1@duck.com
- # objective: Retrieve and Plot the
- # index
# script start;
# 1) get the fear and greed index
- # for the last 7 days
- tail(
- fgi <- cryptoQuotes::get_fgindex(
- from = Sys.Date() - 7
+ # for the last 14 days
+ FGIndex <- cryptoQuotes::get_fgindex(
+ from = Sys.Date() - 14
+ )
+
+ # 2) get the BTC price
+ # for the last 14 days
+ BTC <- cryptoQuotes::get_quote(
+ ticker = "BTCUSDT",
+ source = "bybit",
+ futures = FALSE,
+ from = Sys.Date() - 14
+ )
+
+ # 3) chart the daily BTC
+ # along side the Fear and
+ # Greed Index
+ cryptoQuotes::chart(
+ ticker = BTC,
+ main = kline(),
+ sub = list(
+ fgi(
+ FGIndex
+ )
)
)
@@ -59,6 +93,7 @@ Other chart indicators:
\code{\link{bollinger_bands}()},
\code{\link{chart}()},
\code{\link{dema}()},
+\code{\link{donchian_channel}()},
\code{\link{ema}()},
\code{\link{evwma}()},
\code{\link{hma}()},
@@ -66,6 +101,7 @@ Other chart indicators:
\code{\link{macd}()},
\code{\link{rsi}()},
\code{\link{sma}()},
+\code{\link{smi}()},
\code{\link{volume}()},
\code{\link{vwap}()},
\code{\link{wma}()},
@@ -74,13 +110,17 @@ Other chart indicators:
Other sentiment indicators:
\code{\link{lsr}()}
-Other subcharts:
+Other subchart indicators:
\code{\link{add_event}()},
\code{\link{lsr}()},
\code{\link{macd}()},
\code{\link{rsi}()},
+\code{\link{smi}()},
\code{\link{volume}()}
}
+\author{
+Serkan Korkmaz
+}
\concept{chart indicators}
\concept{sentiment indicators}
-\concept{subcharts}
+\concept{subchart indicators}
diff --git a/man/figures/NEWS-unnamed-chunk-2-1.png b/man/figures/NEWS-unnamed-chunk-2-1.png
new file mode 100644
index 0000000000000000000000000000000000000000..40eb6491a47a921f7b5878aa610c1e8126fd993d
GIT binary patch
literal 55095
zcmZU41yEaC8!fk*V#SM7oFavyDO!RDD-OZk-Mv77QVJ9aG|<4M5V*J%C|;~7?rsH2
zahKq{L+}0Py_q+|Oqi3CbM`s=+uvSmed~*Pt)@VLOO1bAVtDWfu|FB2SoJr>?-_4GUAN?P{+D&G}^W~x|&`r5*Q8+&bPzI
zQd_q}#=&`WB~9;hANWVyQG9^Gha3mz0>7QluHx?PmwxWA%pTtUvlsrRR3G?^E@&!2
z=QNGk*Jh~55B&b!-95dxHaU6vYs9E(c>NWKr$M({YGvuH3Y48VwEv3Fu1a@wVvH@h
zEAZ+uF(jBhUYR8cS$B5qU8`2KZRaWnGQK#sLF%RUSaYH^xha_8lu?f!$i!HAl8(+y+fZirqztM(S@sZ{r0
zVYr%qtd_af)$BFtOxUn}R6ttmvT(7lE;%_PMCW7Zt-}g=yZjX~R-IqGm}yRF^CF|L
zh%@rT^E4?UeSM>M7}CIogGf(X_>i_3C!O5NcSChg6rE+YQyAWAe~LebIsP+844gCH
z3QRjShUiJyct;-fjSzUDgtR_}I%ok`c4?wmBOqBWS!`w|xvP|z0e!cv%+lwzm81h-6C85tN`f0PiO77`J{)tHmIVz{=t
z;GS!_#D)g!w@n2;rmr_DYN+4p-k9#*NFU6rE?O9!O+}~x6KPe+n=_>ElVLtdH)Gbz
zX6dPA38tl@rB=$*oVr@~5=E&!j9^6R&P)%Fjt^h{Tr_hDTZProxx3pNtlcZ~5{2iD
zNOXu;RD5kJkz-3{f`5Va&0dDfm&k(>@40^sL&-wCy{prx#6S8om$ZtQomrOsDxpp)P^UyItXxy(oH
z2f`vvXl9-QSqpwDW&EEx9EI80&kE;|OIm**)Jsz_UC`(;N!=E*IT*;@FkajMrIx%%1<
zt1SM)!6DPt(n8RTo!t$a@!dU^qFf8*b6efHGP5gs{DO?|P~23{uxVy
zw72NxR?YDJN>v3`Tx~raD0+CfGgq_Vb*27a`R!^yJ1*NS*8h4-LqiXL?J{_H2Xrrj
zx*7&bj7-o*Yeu#$8XI?53Ho@~*xChzm{(*s*JL;QxP&kw)OM8#dfsn9KYsl9j{O7-
z_R!<65X`Xgi%&!I#V>-RRHL=tu1*Ou^GyBtZ+1YRez+)n9vZ56l)BQ(mNR8#rSD_q
zWpwI~7ugnL#b4`&%q58_uV_kq)}T-}f$%JV<}-_xmQv=oXA*#MaUXJ=$txUQ*EcYxqo(Hx4e)SQ
z^;Y(@_WoY)u$gdE7CJYk%PjKj{QB&EMR>sS!G6m{%T1iFu~+Pqwx#kwlr#
zVMGzQ_aQ%QstEB3dAYf3YO7tcv^DbVxJxyPaGysc&MiN_=i8{}^K|0mWu|{1kbV3!
zeM`u8W^PAXG(Duho&;I(&twKcI1wEd`{AAN)7@w6>c6}rY{W!;XV?v$aAr$OnZ43^
z8+5_(fr8G~-XZ2nl-{+=>)`m>YT?Z<(__`%;olq!3oE1f@QVscVZIF$b34#{nd}b<
z>MGXxH7V;fu8k*08mKqslhJo&E<6e>{8AgRPfXeGK62KHH9it|bZqxBOKb_JK2=@6*OGvqn)8FUS
zn_}u{Bbbjl0UzX22L*Qn=EYxq9+nBEJ
zgJqA|rKTDy_dL%T8l0c@z+Oi<{Z$Pe8y4
z;ouui!66+z9S_>tEm+siv#{l_4Oj+6)}-_L&k?-U)P23ZMis&n!y(vxTgs?y7cCsNm4HwU4Ye*WHClOtoghqgB-EjL39SL0$H$P16Q079Xy-M6Di2>r)&*i2GR21uL$9Z9Oo~-(6=pW3&*RfzMzHw`OBeeo
zoq*i552`Y<@1Uj%vhUzYomTu*SyE=gR476*h~3C$ySot^f-OlYPTpCVipR#2gElig
zQ+0O){)YK;eWhlOE)X@=6Yuskmcb^*It98#Ua)O?P5Qjy^{xVYMuB+vbac!=dQ#`w
zYstasv2PVCi;9;2HY537dhANW5kthm*a
zWJ=aJ+S`jR1-BC2hAhXMRfdG2@9vF7Rl(NYJR~ts@wJMyeKLe&vp#Elvqi
z5oDOS3R1^*F2~3oyvb|bQ8wMkbVbd~{G-X~=vWAUNs3TYFp*5V#SF;qou5WmYa{t*
zqN=I`J`9`SHEo|EeT$JN9)WjSU-vS+|0)u3FDx*4(TwBw$?06?D{hk`UZOv*l8h)`
z*5iWq1wQFH1s-k`guiZfz4*IZkaH(_Op4G{6}tK^J19y)>iXjG!MSEys`1o6E_xNH
z5%aQw`SjQR`)()whSSd46Dq-XNv-x-K%HLKKj1~F#2dWM!YN?7!qbfqTP*kvv7dWq#}8XAu+
zDhi^yo&t!i>vv8;iQ~6N7Cr$US%s#hUZN6$g0Sl(i$EEHE$sFF4VzQT&BGhr$)rc0-R=DqllP*x%cWt2$u7m0nJH5GCC$ES@{qRGD2XifCky0s=1
zBa?spz#vjzaOu#6AHS*=`<3nw495MN%Eoyvj)+MqQ9JvY20!(qDsCFWhvZP!DD&2D
z%>++-YKFH9cb%rH!Me!)NfGLPs;h48JTgf
zBNIP!v<&nN(qi1RUlTEYS)Y0ZV%0K?CE_51Mpq?0mFu!%q9yd?=3;U)eQGC|emBH)
z9oLL9PqW~TdWegI_fWR|#aPB!%H~Ls5G;A>vv$ED+p3FRdH!U>y14-bW9C!PyQF`F
zsH^2SVJ2@Sjj2&aEJ{oF!j=t@b8fU{<CQsPzqRvj6PgtjSys4x0oIMkF8j(Ci46O(YX6r*L||TsP}Y#T8BN
zk|fOOQX%RXUJBwq|7rn_UzHg1;#@flsN~ggsBSlKE-2^eclGWt|{ACBsoLHuQ?ti{n8gsR6K3W^b6ve`6SC(QsfE&_4TP#a9dVPBXC(&
zN2&ypHIcpR#cUu8XJ=O0X@BBa;D>hndLP8ll3kTkbfEUsv?nz!WpoXbNikow+4MNb
zz-n%@sC&rP&RI%iCSERs=NCZBongYO9Q(X&`trlP)Q
z$y`Jbix*?#?)Z!>v++;g7N(27OS*SA1bhCRq@Q)^MO0p-FV8(eV5+jPF=210cxziHol5yW_G*z@;>(B?IcReVK{#ga?!aKPk~XiN
z>nXDE4}4!{5o44N+|@&*4x4
zw!`>k@qsdKUR>*6xN_Dy&NU)&PnFP6^lQ!uJ>ypPj29`K)h7AuofdGSG$m%ZAT>&n
zTOPDd@ZI>n4;ia82(2lWD@pwJ8I(^w;M|pYwsK#KgU#6via`O
z$|=2Pi`7J%e9Tw@>$-A_eo-rZt%&Ad6j*R8Lr58?KLv%eEH6?*I4I%Dw+64lu{D-?pk
zU+>hiCaZO=;8uL>w(?2y<-;}s2@AhHNYb_SF$-}5JBd3QYU~EKkzRcL+Lfl$;49x{^QpB{>u5XdLH*?CxWESo5RgaoTkj!qci`l(1{`g_c0
z&g$<@1s~HX$vFpy=bzo<&`QoBL2gxZx%RB!X0GneUyD-2T2MxrpE|lWawT_x!n?LQD#Ip`~ufblr&B@s96=iog+pToYJ)HQ+=$eiFC5I
ze#8i8R8i3oMP)Y?iIEVhzK{Eb($QOBq0sUdc(Hxb9bcMx;p@7+p@rzGk?ab)ZXmQp
z=;rI$3;Mbkk;Z3=2dl9qKPEU5`!q%_3?N4v2d0bUfx$0*J4Wt23T=#uilf1e>Yyt9
zRC3Yl$^ppf001--4h|O{<-bnJEm{7!u!<*b_O+6n22sUwdX|sn74EBNw-GIin~-#iPZrdQ;+`H+6r(A3*GR16&N>vhcCKTx_tt5Z0NQU7${-$c6H
z4$A)iTi4dQZ|Tyhf;R?=wzuD$JaQ5r$|}+X&hM}o+73<49qCG~QH$sbx{6glAe6pE
z`9EJ-tqx0m^|du`Uh9xgUE#xT@j4@@GYTW34)P0KANt@~)W?|IMFfe(^K2uxs95Wm
zRK)HlGgbW1H1Dh7dzAWQb$6i&fikIY1T)~DDr#y6oQE5g`t4pZ{2sUU2(k+D`moyL
zAePu|1|87H10Qq96ZFY9n%foP!TPew-?oK;jg{+0($8^{XF{E9_P`OKk#D4u~
z0>Z+X2<ni%7=yTn$AUo`hVFndOkB9Ec_=
zEG#W6EDiQrDG^R+Y_%1XS!f81u+IGPh~!bUZ?OYEvN3cus$5kg1)5XhXy*myay7aT
zr=IhF+A^s6ew$TB00JVu*SrLC*#xsu#PaAC1v-xz7{n1BTr}x~xnjiL?EA4R7W?b3BSNpW$NI^OtHq=SoI@&dX~qKsVJ@d)hbz
z`Rz%&tnL0&?4zxVHzPg}C?euw)Npgki+de&GySAMdzeFb8O#ZcHW%Oe30=B=hwM5+MtIHf?8_pDbG0n?x2Oqx
zIZ))g{LF&Vk|)BlOclDWKh%Dc$H*lp2$Gyh-w9ihij+8XDz98~B(2HOZ|O=B2s#?7
z-Ya4rkHla@4MB?72SJj_XbVg_o~k2=v8q#4sum+&56T`xpuhhXZpiWQcb8rZHZgc!
zZuTJF5~H3;@wvVtF?$NxrOmHlthM0#JE*nCgEcTY;;$B1PN(~&?84OF3+x>}_^NnC
zT@~Ees+NmQ{)?O}dQ3$TmolBP1ORNHhWrl{o?IXVCkpud}%7L!JirQa?i`y0at
z(ffV!<(u_HSm2SKtOnBS{2G-ZifYa)WyFdh6+0$$W7($mFGNr}V{AFr{{Go!f8})b
zx;qI^dB230N&B#Qk2goo17zegQa^NB){al;NnNc?Ea%8T_~S=bc^|n7XM`c2y3OP~
ztf0fVRDUA&yH;RH?8avkkWL-T`>6cGo9XBbSI7YNv3mLwi?k?LQN&-N9H$+$cM4RV
zf2pvxuYLf34c7KsOs2D4!>zLJ9PPh5r`eSvtGVL`h66A%X8G&))S7Tp%cfR4L8Ngh
z+F0nN7RfV=yBC|(yU0Jaf-pB8XM&PV3IDu9eb-k8xjWTbb|@Z7+36sjjPIJStv4mWK}>XfFDotoV_AEP4jU
zMdNmxH0d71|^pn7)(W&owx{O>V!Ipqccb5zL$CvG~`SvEU^@(ce6DIS)2TweBE8YZi{IAC=IU?)cr$T%8!#1;|{ab6U}!
z7iqkuo^elqp#y%qT2>RsmXV=5lFRAWj^Pg?2r!H~@2j}l1=5%fRUYTexZ~q$MBUW0
zoGv3BErpnZo%!b30|9{qt)^mbUeMj+%E!Kbd)e|i#15aw*5OLcoi4^YTI}y_n3Xi2
z>%A;0diFx-bk9We%CAEoOm=k9=#0YnWtzfzO|2P!VkbsL?7RXJ0#VD8-G$TB`owF{h1psCiC
zcOP^M3J&rnLLE1#Ii2E<#}IzvP@-Jj{90{&s`Tsg>HH~*9S=no5(KmfEY)x|SOwaO
zr<0l*ou!DA4Y^nxIB`2)nP@Q=*5l^s1)iUdadafGFt60z!b#EYRftBH>bw30spcZB
zt)9iK5I#RMp*uKl=FIKRs}e%yW~c3ab-P!f`0biqUju`McsHF&Tcfcmzj3Q!mV)U3
zxQlvtaaVG8H{>EVFV&}L?0GWR3;Y~`XDtJ@<>iNOYS5kj4LO=DBm*jGu)}wsIT)QY
zK5Vj}RJeKj)Z^ovOjG}cuXpVO6A_h10ql>Z*^e0C_vbPt{x}a_IJom14J
z!baljVr**YJvJ(|b|jyu*iqrcO<`zi*#G=_G*Q50Xqq(=H$#Rg(PsErmT&T^|3K8t
z>YTP?^`XEB8nbF$_1J?pttx;Kf9dkx7}6PR&apNzr~di^`ZtrC4=vq~UZDewXCN{UkP$9isq%wn&qo
z2S6Z0oNF1{U+dljlu77n^18RK+GuNn(D@xrT;1k9luy
zHeo0SzHybcpoi?FF3%POoUYTo2W0fNk{`itiA1Yicb`?&Lqc0`AHUz83Cl&{1tPXr
z;HKDnFZ-P7=ui@Rp;yw}^_blBXjb2AJ<(*s(_n$*W&Z+PZt|M%slrYDuRd6b(;MDS
zA&oR>-78Aq$@7~X5veB+{(%+OjM(xLJf0mu_1ILutPfD*AnR6S5g!ay&?h*o7MVvP
zX+wo?YJrN-)1sPE#$=^3iY&MK7R`durAs4k=LqfRyhAPlV>2n||MLQT6@;O>oTwP+
zrs>D%)XXNv-HV&50`1BfFniPW@=&I@&bFNPh@u3Nx5~Md^U3)<H+vIMmG82CqOboBog|T3zr%P|svOnBB
zEe%4q1BTc|N9HjQ$8-eS_FGbZr#Od*Ke?3LeUfz*|IMvV)4ob<;8TmZs34!vOHSGn
zSG%2!9Xc91+90wPyl;S)->bJ9(_#%M#8|~7>68LF?#lXM+JlST($dmN
zI>hSpW}o8;DRoxTh{wBGO?%zl-3KQzD?lg_zAYc$?j60?BiV4XOGmv`JB^aST)3Fr
zEFtH-^y0CZxY3Z#2f1{xSmQtiktp*-#kW>+)Nwn#b;=A^CuxapAV#l~OY592?%YEF
z(x*-dBSiET*6{!nLE8sSDANl)eF1FEomOD7qRf|uKFV@dOm97i*xzss$%L|%2tQ2l
zGrx}I%QB*TI0yim$v4fet2O^XB)EY+2CyQB(xp7GHeY(3VL4WuCr4a!q9}zdZ*fEnUbdpbl^}RMnNV
zTU8p}9B7#%c3eZTSotUh+!7<fy+p?kfCgVQ9pvf2z4Yod2&-
zzMqdH!)^PGVeUNNmtPd9_-viVG}Jct+td#bDvZ&*hekqwoGE>P>#GEx47r~7oBU|<
z@OHjB-*`9pMnp=?x_S!G%)cu{2brj|p**y8d0c6l@PJ}gXo0pvP8U-mlqMZET=463
zQh-iV-IiaZEY!rjI<{kJyGxc3rTu(iQs30Tgp*>69%iOM)X^kn3Q$C7Zl!O_u|)XO
zVqFCm+F=@1h_;9@KUkPQSA>$c<;12U*6vFHV_^m*4HaF;o8{bAJCbt>fOtkr-6)Bo
z$h1=4k~IMvRwtQtjegpb)w0mDb+q2X7j6BC3EfJ|EkRfl(O4Y5#3xD`-NMl_V}C==
z|da`nNS$~+N(c$n=>T82({r#>B*
zkqT|zCtaC8Qg{S7p^wXpaP#Ir5@>Ga{2i^p5?@`I>))xHjO0VLeCr1gDV!)XSrxNv
z;%dK5Htt$8O}nq(YvTGgyWa|CVUyJ)P#`$_+-%P+_&cT~1Z25(D0)$mi+lY{OK3yo?Rb8$}b
z$VOxisb#zPz*%D^0T#AHhBdN@mHYTwK$8E5yEtYD&^H%9sM)SK7+(gIeN)hxs&_eHBjR#_XI0nBta3JP
z=iT~d!NyZXJ;9f5ll)r$MLJLNa!x~l*nkNO2?b0E!RZYqv;yLo&@WnRIW1-T!3GM<7M^T<+xs!yifU;T!$ZXrGa{^rf~rOkk-Cd(ud
za&R<%r=ilRFNEOjlyPqe&q5x?na?0xI+Te*nPq9yu}HUp8KtDals)%*!v922bnbU9
z4It*pa}_z@r4q-;df7zpzb){BCM8=LF(u~GUl~i=@`K}(nKY2dHDJ_lYk_22v(m2G7q<12Q)h?G7#^f@CiF>v#o3K(ej$ZF~X_7O%wG+L-St{RF!guUZYn
zX#ENy5Cb-*!4>o%kVYSpjXl~Owc^*&o}AD%hT!^nM)q0Nq@3Q12iaOz8$CBQFpvk8
zl+_8soFm7Yn<(4)n1%>LyY5{!&*C2kM7+#MGh(55lq`JG0PN;C-Ps_Ld7i%01g*`xkP?UoTI_cRym8-?26f6w9u)Z
z;+heyCy9~eC)O(v1TpUBMO#neW;7L`RVf2*jx4va;uqevkXD?i#rQ%8#zRj*5*xc|
z108|ApY#3fp7J1`w;?Kr1|~Ev~)ph
zCZ^T~x@>8lv`_F)lVjk5>}$Ms?ja{MyN#yCTD3Jb7PWf1`pz;5`TZQj1uQMgOvAVD
zWbvg(7#(Eo`-JHyu>Ux~ajk}#WpdWNHb#+now%kq2P1%hu^kVMkxlB#1+trE1&8X0
zNXvC)0~W9;vB`bD@O5G8z^)is1vo%T#&suY!C?wAf0=*pYrhs7Qv6zztx=$j)+!*t
zPX8Eew_?)R8ka1?>|z16K1MbT%957$L_Uh12_7EyikqU-U3|~W(*ceo9cvv$O#Kb#
zspgA)!|jTEM+@J?*V>0@wwPp+0p85Ynh
z_FY`85&-3fl<>aeW(I%(nL5~)DuxnU&A#no{eh|-H)nO_YbN3r_p8I5<>01ZTg!^I
zlCqZGu2hSIvv;Kt_ii)M{Q(Q57v&E%QCnM&>(%RX&Zabu@3B^%?WngH
z&LRhjSYBe|_pNq-Fx8`6o=XX=HRkOfs+l-He;zF~jEzsJerPaZ$tk+%_!bdZCs1~~
z7@0x!xArm|9225Ji~pHEZ}kd5vA+M;t&9cCCf=PtC3~DVPwtr)y3zXF9u*fU_E|;L
zHY+Kyv_aon2P~Ih11|dgL?reVlv@76dHB}>V8-~?vou`f3gavWF{Z9)cEJOKt-bu7
zBB0wFOiYP@u+Q0ho}7Hn*b6^VQtUjOy$^vBkbRm{OXrJ653+GC?i=t^z=im!YkqT;W&^8R0T
zal9G^MX#@I2|{Q_^4p3AV0m0yd(Ynsamr>cokZsglAJ2AyHvby-{@v^F
z>Ny?6$!0Tve4XhqJF}+_PF}BahD2(=^bM$`O}1D@DsL?$!g5LqiWunE7--k97mZE%
z{ZZjz`hwx+lU#c9Cl^h%EsQ~uL=7lRM?a*;e=M=*RP0N?xdMLP
zP-&g2$Rg=^on%z{q07p%N(-qXKe;eJwv7#Bko+nl@xp}iXfUqHSKNeH;>RKi21&7$y^0+
zXig$uPbE?%eHk2`<6#~W_4KWl?epNPG4>%vFkqa$Y@R30&u9A%j_1+Ov^2n;JMa^)
zg5&c9K#UnV9xgVVyE%4FEC|!e2xLlvF;&wL9BrQ!)KH(XEwX
zYfg9Fe#fz5+Qk2=B(jbw-ZCKzEFmUTQCZnBcoY>_-Bbl=2`Vg0ohP-vKDA$bpY!yR
z7xBd}-^U(`w=DZULqY3ODM(|$821=I74-P)l*y_^;S8?ALdVkJ{YR=J`+o0NzZRyS
zqa*7qR+3{n@-Qg1e7|^Q)@05&T^5Rl3B5y?{MVc;BnCHg89dv@o&pJX8vr%y%>rgn
zu!ld}?5F-fOxJ#5YA;>?a+4k*C^m~B@QRY-p3*+a<;*z`{#erio<4deyKqUS|@?)wOlO2;p2UgxoCCKH=+w3vNy>@T^u%4N;wp5T!JZEot4
zf64)!l*XeDvi5CbZ6i@Jx594Jz`&AU$7*1B-7DpzCZ`T-A$uAZNf%ICM31}C0(JJt
zt8BA3m=Ca=XS$MUnrIg%2jfq?Mc6=*D&F9E)u#EkL>5#h<~JyORBOfOmIQSz
zw8X3kO3hO|nrPVJSaM;!ju!LqQnIO4-$H8O5UE`#8`%@Yyz-%kJjU-1WA4!URfwzb
z=w5(C8x1#bmnnr7X3GA%8m+pmdY7Wv^1!0LT_Zx6D35ntll(Bn?bkX;C`gN}EJQ8xbRRaVH6W9DlArPDZ22Hw)(G3YBOE$~8wkXz)4Uwvd?(D`h
z3BKZqGfA-Q80}a)`ZalCsK~*I5ZHT;P+2jqf;Z{dyJF|`O)vbe(m=q3%2{aan6-Lw
zvL-6VZYzMSqhrZS_%OSt^4;cw2BQwgeVzUQs)nG46UvZkXjuzlX`;G)T^Hb>B6rAY
z#sX08@rv4M2^FI`+R}BzRD=)I>+29hYF$m3mH3mpI1q)UJETzb#z~)J-AdN~5`j?)
zl)Q&OM%KyN-`v9KUUrGpd5JKlVc|NY=A%*G50}S}rQXZ7&G4c%9f=|I1L=cFwH3_(
z0UO#lYWv9oA3RUTW0W1CYFTiso{p?yT6C)!GZzbI={NQBwh0(sJ$BmecFkGz1qG-tz&%G*i5jkGEGo)QyW*QlqiDK-1&@}l*+
z)grPA9M23Vy6Gq*VE@twGPao=e>`w9qDq^Kb|mx>u}-Q!Q`fj{
zpuaRH0&=?~3C@ET&UbbR2xonHc>ILNi6P<`X1L~h3OvcG2WSo18vGXCe0szgWeK@>
zXOulHgQ(%G>AA3R2b4}Lju;lCiq!x?^qtO=)l9=JfnR>j9W=!FghvT+giLU|^eGdr
zNKNlW1lQy9T~JoZURTj*g4n}nG4SklC(pT)14AJdmLv}1N6~)qn`@$yB4Rq{&HkbZ
z#}3}-o2DU5UVkYt4<(ddYl6uVI+Yhhxu^*a#d#4>&$|t)JN~Vdw_ZgKT6`ur8E)tK
zbocbe!SqJu0HFOkclfk@bg$}s2Nab(Xc@_H0ayls;F>>{CK5$42Btzwe85HJ&JoF=
zq(;9p0>Dt|S1#2cKtgB%F4ZiEOrtI##FQ(7wTpx3>CHim@hf)e@p3s8cG`ZXQ(>xi
znp%yV?i4?zPk59+B6uaJGrb*r*e^s`+uzA&lrM7cZWzf$)jOT99W-6g{G>J-byqw)
zZO-FPy;A(61!KeD*`ginna9I1s`m*CW~~QjeD9Yhhp~O0#jClxWi8iZ>{EM*t1lO4
z^#wVxBR?D}$2W@p3%nZyOhX28TFxV&M4htCSIAP
zalmn$onRxMRL*P8$k2PzZnU*vk(n7^`Rv!6Dc#HLYP`?;1-P|}8~e?Qi%SvRD=gB5
zqv^@{{q=K>Gl!Er{R1%P{*83e7jk2x!rJ=I_gD4FzRYk+^aZQh^kle(X0XVCvg?pt
zH770+tt^R(^?~YnBle8>u!^g`l5Ifjdaki(anW-|r0vkRGBN*&njuaWG9?mAbl@*h
zpj~)zsuUw@!Iy40BW7!x4^4S;F!VYlg#~C>LFW|Nt`FgS^*B1p1oY9nSH5UXq?>A@
zzLAYiCzHElU>dZ9O({{$7ChwZViUm4%QJg;+W0pY1%Ru41XV*%*2hXMF+92rg|K8b
zbShq-%51zjl2@`R0GN+XhvX&x1dN3EATP@c15@uf!pDMw)rCUobx5W7^2;X2U51_>ZU$8-%aJn>dFPI
zEI`dL5qJ$OK+SY{Mzfy@P7-q(x0wZ;y}2z$6D#K$d}Zw>FsBsK`wb
z19#abpGZ=9F6Ft%FQ*|{hW)OW^{7vy^Cb4!qh}3bYqzKPg8$Z6O>`R(MVy>18^$(|y}LLHMYz4*!`=E4}wRp4(4Qfk-@s`9AEn@#&V+{BbD&Nbu>?@_$>~
zr2lVg+y7Wj#p5tK=_IMkt5B8@k1PH^zubGjU49_DTTmq=bS!l?bHmaY1Vpub^2r?q|r3
zT8uU|{)3T%+&y*uIqoz_b`ap*ncRxMTg3P0bdF-TSd>1CWbn=sP;lW#s`#)=CoySy
z?IR{S$$(<$?^T;rir<;w*w4?6LV~@l+?>5vemef4YB-s%!R4D`f#wcDf|Pq&Nf_e_
z?)D&$W0|Pzm+>Pss&g21l6xAo_0NdyiLsge!R7Yn6E^
zYmy~}wGR7MT31cizE`**3MWbcw)&Qf2!=TP$13XaD-?JN5X}Pai=;gJD4TScC>tgk
zZ@$ZJaCQ5y0s8;{f||JZd>C#{^guJyc^q9udh^$78@wY0mygP+tA$A(*_sj(%%}B`
zml^pxwl`7Zf4h52jlX$vqo5pID9u&-OdGz&;>H#uwwPG7HQ8+JX^<4@$(DZcE3+rD
za#b^eeNW*QLmZGFW`bNgoC8rA{kf{Y-;KwY0%fsZnUwga?DElSsHW4d-H=ZHEy*V0
z+c)*bwy&W=_v$K?+_;X^8F@d&M%lJAN#@
z9lJXVGwsQ`5`7_TQ7u{@sCKf@(A0zbCk|=JaUCW46$BQiI-=BbUtUVXgV+qzD(LPs
zcyS_)eE_3%$o~4+wzYoLSwqWN(N@m@9^wy8_lsYnR{MD=%~OVevRXf&qEkN7@EM6T%P}BJiBX9R{vU=`mGgHO^e>2mPLTpKhiYxbPHK4cdU5w-|`Tb
zws0imNuc%NIr$&c$ADtOQyiCR@S=?qn$4YeOc-*LlGEUpxC+
z)_)Tx5LwvOYsxXgKdRV_G%?X4y2+r`J{QLSyS%2O=ctgHhBet-vK5m&Rp&WW0P^D<
zttO)J^VGAXcab@VwQS&d_^KEB``wHM*ODhSMS>17Z!g)6``UWYZbxc-e~fK_zs6kC
z@G#&;r_jX9t+u>ITPSnaFGv9~JKczA^$Qkn!PDntx{?L4PUAj3U2g}*Wd7inHr676=G3;m_LyEO@Ju3@ZT$U)OgdX
zaUu6n4ulq1&wKsri}dl$`+j{oArK=xS2U;o=f6%ioS&?6iaKy@rD#IQ;JKZyU%2LX
z)tBDJFu~ozKXBn;JPr81|2u#J=9$M0w*Ri2pRBAerw`4sIRENnjqf{PTxn|M1)oWY
zGZp^#1Lp4WPba-nW2}B(b{)edSpV&^{??=D;H>7n)y{8mSraN3A%QQp#z*wub-Y-}
zkL?$jmg@5Bq5B+hTprf6Vv~b-|4Max!-FMWLm)oHvCY*@E`R1yCh-WA@wfKZyHFe2k=$~c3b+@7*iqLsa<=m|(Tf{J}bU?se
zms4wN7omLL2e8ePK+}U`%qQ!V%lw7McW3MKGz-+TdWU3aj&h((F
zxO$qXSVyV;bia8O#WhV{G_(Pz|K(j2k_-@#=p5&kL{#16r(iM%Ru)
zTGCei7ts@&Lz{8xpX4;2Ja3T{<^Nh!@9}Nyc8|lEydTw1sTPbGqBZp0zQGYoRHRL`
zzwvUaYtyaXeX@XP<9QQo%c~NX@ZfF;^x!L(E>pJVIwp8{T^q_mL41#~k>!8;KY+0!
z%KjjkZ~eLy`BYKTps~i2hlyj-`vo?s=0>psZ5nk(1tR1oKOFVkXjfSebSRXp4)R;3
zM>vQkt808&N%teqkas%IK0n#mSx@fzWyu^dB_SUnS=M_Z@pCF7-|ZF~+(I*hJ-hh7
zb1q-ou#>o6X6(9KaX}ij-w{Dvue-2tnR)AhrL^P#l(6APwN7FPsGUFNa*Eu7DiV-Y
zMw31Xm)XYTTfeof-Nl|?*74%q^8uhdWt5)I1dzb+7s1za43~CRx1w^vXhNC*(0LM-
zXOPOONCFUcK^Xy69=hb^_WQe5f@_B-Z)_iDw%sBZPRG{2xzrw5%bhz>v9}|VqIsJnOpypLwzI%i2g~k;WElWp(*YT1
zOY(ZVjHsqsRU-*7y<82AndWKPSIf`L4rlV%@TEtDVIF(f?KJ~F?Uimrnw_!PtJ_(`
ziIy{-qE4VWI*;693B&MlyGBFM*;)mIvj6-ATBBjBl!*&Z-C)k0^7D1sG&5a+k9@$tpu_Qyi
zv7crq{##6h34F_S3k(-iEn-{m#I?kJbt>m4O&>=lchSGe+v;NL?nh>&qi3%q6iz9q96R1EJ3oO
z4ZZUu8O{Ea6K(Abz_vq3^{1-|$8X*|3h#!`4Qm^19M}Hv--~9t
z-X7aKKo@g?{=K3&<_r5mg6hIA%?e;diRJCxq_@MzQHWF2VjPAgs^pi8MkF)*AGY2)
zDz0D&AG|mTL4vy^Sa5d>65QS0-CYwPc<|tEgFAx;cMIbKrcD2qID(z@0lVX4+Upf6hA`38pD#_NEVLha^mCJZddl|!N)<2
z5*0{f1@&JsxWW;G^~%c8tZ77fXum1BSbPujibsNp9hi+npR70ifQQD(JPvOa{hwEVjn}}JNa11fy{n?VbPD`W
zn-JibRk%=%EfZz+$zZLLFd_t|y5Ro%un+-b*#S@Xqzc}tjkU1)UH*L%&ge@~FZzIM~`
zyng`d_P^chKx=S8F&=LmGu8iFqC0)=`G5X9DtAMMr;1oF1znFNrF{KMyd;&8Hh7=9
zB%O2!evl)bZ@h7RtX&jQb*6C_yMgD(BNZd{F{o7Fhl0VRvSH;{
zM8zNJOl=l{6A`z5|IwocwKRRnbot7wC;4tXfeIp7ikRGB0bO^vYc5;(=O0~m9lbiT
zHrh~;{b)&R>{{8SDtYV{b=oftr}d_W-8Q8orz7#QnGo_H2K5g}(I|s5b=GaU04)~<
zhIM&K6qsdL#Nc0q8sHlsoj6p8)Y&2^hNwzx&vkoxu$-6Je;6E9`L%I{d5OtWUC5E0<-HRkd_+#K?kh;NC
zL?$blP)z4dzjT>7<=m+Ebb7qPe|B0v-r|0{xY}=BIoFazp{bHvCZvejOYS7<#Fd_o
z@SW@Xve2H2?!#;GH`Kz(KWqWtaJrtncRdRayXR)?5!hB=bBj`3=fXJ0w220YnAo<=
zU^v$Zzi^;c$hSWUP>e>F-S7UMheX%H7Qqr@a&ClDx_-llLLBe3k5;z}=4MPhde#3h
zyFsE(G%d2Vm#n!8MsGq~t)JQ4B8g6UIO?86Hq|1KrxQ{hr;iqH>s-YT?+GTt&4UIw}`*@CNt@}!;DTb5DG~}oG#Lr-aShW~56HEX1cxOX6qpb0Z`&Rl)pp6Ht
zB<*0z^7(<4E?WP8Br8^`D~h!{b)9*D_kVV+XBuMYi6B(J{5YsrAK|rX1_dc?#y_;>U2m
z|4m&nvQg1up?l7Cm#VU;vX#CluVk9*k6!7P)*SU}$<7oYw7_4%FCSM%FSw9Q^o$17
z+3>k-wuI1>PwE=~cZzTlL$j^g7AwZZPJYdTi*M~SP?`ao$2wDE%jaJJQoPk!M>N2N
zJFCU9!RMW|^Ox|X
zRgm>h{UAs+BV*k$cB)rznDv2mf1SBX*vdqWs
zB0Jgxl|4VNRw%0c*Y^yxz=i9TBbqo{;aE||5=JC8#p`}zdv=TttF1Qzfjjh?9cG^=
zF~kMYKg?iRx8FR{vThvUe~b9{_Sl6H%UgnH+p^rVnjE&TAb
zvXJt-Tzr0SDm^Vz*I<}L6F(2;*8{k2XO9+i`gWWI@6Rzj6$$q{;30Tc>q}qhg(#V4
zKP3ch5w^%vHVH$13<~w5;B{l4x~oVE(4Jzo%D(3=;Ku*9?W1d{h%I+tkXaWG;>#cmiekupgUsOQZn60-e=W%yunX3A*c3edRL;F9QQm~$Ib8^h~Ecmmdr=-KY#Q-mZ0eOb=I4>aHQw0YkTzC<~H|_
z;&1mjcuDk0KD+Y%-FyA^<@2Q?P^rsyr`5pKQV;B-W=3X9?XO|P<;
zqKeqb3ixg@5veqS@ZWY;FU;Ja(1PCrr2A5Eat2x1Wn|*V^q(JL
z3L}!$`B|o>j+;XLnQUO>_Ub(a00mR-WXUuv4ZZ9GI7w)z0&RnjJzcWZ7O90q!I`rz
z%~d*x!%iIHDW~cxx~8eB+Dkl;yd;-gwk0JdXszX~g5a|VfQC5hYID@EK=h%TjlJ=7
zvE^+sQToarH%6>dkH`N$P@Fmyv>^fkcOX?U5}wR_<!E!q&;Z@#{P@T1C(fZP4Qr
zf7`Gzf7xX*wQH#I9Ag4;eGDR{j&49DY}ve-Q$NYYx>|YTCgt#fRxa$7Bx@SnPOS`g^bPab3N*D~lY&JtECQ_POrsx-?;Vojt0gqnlH?
z(bj)+y0{*7a)k^@R=2ucqo*gKq7;vF%=ors-?i*SHU7G>r~fSY7EQ?w7+9q4;1IFy
zIW#BYAqQaE(BgNiVZ~p^UI=PR52+3dBq7e
z6V%gnuayH-
ze3``aDpUN-|M8s-#6eYXULNf(0V_#e!8}vyYs@B-heDutRPv+{O>0NDm2l#mgxae0
z8-B4gn?FPYp=$qU0Q&yfy3Zs;H9YTCeE;jow2=+%ml?hxl%sUB2rmh=JBH3Emc9F*
zIKibyL$dZOWzlZ%O+wm!m#H&>|MxTdee@#Ejq{rK)t$G~y>sQ!M&$`8-9@ex_O6)LaQ|_(7DyXM&G{(=K*&s>MnL6R1J4ik&@f1ZMphT>aHH$A9WtXh
zjlb5!e?CxYDK&N|G)q`v{4W}?CG+uBFZ5SFsaJS6v>QhF6k0wZ6Gs1EZFUCp6bw+~
zHqQi3Ll5%K3#ECc6Foc7nz;UNeu(O86ykPTL}K*wjVnhBZ)K^Pw`NTQME`pkWNgG%UyT7qNb!wYrz8$i_(pQ+A@so_wyPIvzr6
zgNXmgPI2z4dwEQG5?Wv}cS>br`!sFSb*MlW@?ZIq{>-`ehRA6V^`;uM$v%|$ar0QY
zlFoKx{|i4XuC}00q>P3pR3WB@ALl;bf|}Crv`uN|O8MU)i9@i#Px+>MaS`?MW(8b5
ztcFl?`adQ635&QN-#0?kUQgYkKHLW-Bq_6NmtN14euMZ=-5}`2jUwHzUAsHaesPY0
zP_SQBoJ8o8b8RZ>Q61v5@%k#MOIsxb_|l2)v!y=Tez2*Ml?*|)t(VUT{;{j;Gkm%{
zQ3CFD9_>$9nn2*GkC1p+{Sj$+(y;>GYC@ZAmm%W4YWldc;1$GTfiwqV<_$ochM~2TX0J
z89OARLHyD#k`~IK0v;SaU+VLxLG|!CPh=HSlDf=QHF9*dz#Jv
zVhI%Qz~sJFoj+!zII>q&VpY5CMkn8@m~wiji#=*fCNTyNNGHtmoSFH`ZqA#|i%xl1
z!~7c${u?h$T}$A5Hl83ou}$jKl5MrrgaSCuueBkCxT!|P;Wj(GL%3ob1@@ajM1HH>A}`wJDjC2Y%FjtslXzp8Dw;nc~tf#}uO=*8)dLMc3x
z_bOtn7Mi%+B%`BKU|u!!Spho5PobfZ#aABgDbn48LRQzQfI_loZT3uGR;iinq~yZK
z?rYf(^Q8aS_%^>F3-R$Dh%9owz%W%K-3qLp#i>B$OR
zKx=N3s$*}_JD~>LGulLre`K$ytSFLb<0Q!@j%(v)kM?MS*C@E}l1UY+QfsgU}v29Lp8hgC1|
z!b{H&&U!u24}Cr%*HpAK$Nd(3G|G^?wingsz$W=+1wdz76Jw`{*4q}&SQW{N&bqId
zsa8SQvQ~1wSY&f@&XKb;!v*rs6_8I+=>Prbj>p+U&p?X08J35y?bIEWt;8_J)bfQZe{nSKf2Z4VPO0;>Y4K&=fJ8#C5^Chm7Y4d>;fY^DHn`eB
zP`Nk4sd%$j3+tctQ~7TbWzQo9=iKLvbdBQNPWY{gYf|RPtX1#2F>-Fk>i6DR?wXld
zO&kg-$eJpJiE_{}YlaQ-;Ol%C=Yg>sl1-(U+8_x3G+w#pzT+bliO}PbmwI&VMIE%f
z<(x)g!$KG{qH(7%k*ch;(X)_zl=*1;cek1+X=d}N<;ps1{$q}v%=AE9;*CdDE9#?;ek
zS=m9IfsB9i=QJaRh%VC$|5^9$j3s96o^g#9-1Ob>b#uS_N;i2|~
zA;b60mOJGVTKkk?kgaH0qv9|{6gxqd6!)_h<$Iv-njNk`zKp;Woj1JD{d93@b%6r0
zq4hTb9&xM7M%lyXqAAz$9E9hq9R@)d33k|F9W%(^lJsXCoevmYzkwNrKDA0S>T%n{B~
z-uJKzd(qxKkNPTk@Z6GM)MRYDY4J>;Q2KqX6x8;YCiMd
zpVZ;tWp1}rcM(l{hhxF%L$7qmKQ4y~z|NBbHvS&=0-vD+C`(1oZbtQ&)Q0w&RPF+9Zc`g^%XwJl
zte}8nERM~tyk}>$efiC2*9&& |
+
+
+
### Exchange Support
-The following exchanges have been added to list of `exchanges` available,
+The following exchanges have been added to list of `exchanges`
+available,
-* ByBit
+- ByBit
### New features
-* Funding rates
+- Funding rates, `get_fundingrate()`
+
+