Updated Documentation

DESCRIPTION

@@ -19,6 +19,8 @@ Imports:
     curl (>= 5.0.2),
     httr (>= 1.4.7),
     jsonlite (>= 1.8.7),
+    magrittr,
+    plotly,
     rlang (>= 1.1.1),
     xts (>= 0.13.1),
     zoo (>= 1.8-12)

NAMESPACE

@@ -1,13 +1,19 @@
 # Generated by roxygen2: do not edit by hand
 
+export("%>%")
 export(availableExchanges)
 export(availableIntervals)
 export(availableTickers)
+export(chart)
 export(getQuote)
 importFrom(curl,has_internet)
 importFrom(httr,GET)
 importFrom(httr,content)
 importFrom(jsonlite,fromJSON)
+importFrom(magrittr,"%>%")
+importFrom(plotly,layout)
+importFrom(plotly,plot_ly)
+importFrom(plotly,subplot)
 importFrom(rlang,abort)
 importFrom(rlang,trace_back)
 importFrom(xts,as.xts)

R/availableIntervals.R

@@ -1,5 +1,5 @@
 #' See all available intervals for the futures and spot markets
-#' on the desired exchange.
+#' on the desired exchange
 #'
 #' This function shows all
 #' available intervals available

R/chart.R

@@ -0,0 +1,124 @@
+# script: scr_chart
+# date: 2023-10-06
+# author: Serkan Korkmaz, [email protected]
+# objective: Chart the quotes using
+# plotly
+# script start;
+
+#' Create a candlestick chart
+#' with volume and bollinger bands
+#'
+#' This function returns a plotly candlestick with
+#' the most common indicators.
+#'
+#'
+#' @export
+
+chart <- function(
+    quote,
+    deficiency = FALSE,
+    slider = TRUE
+    ) {
+
+  # 1) convert quote
+  # to data.frame
+  quote_ <- as.data.frame(
+    quote
+  )
+
+  # 2) determine
+  # wether it closed
+  # above or below
+  quote_$direction <- ifelse(
+    quote_$Close > quote_$Open,
+    yes = 'Increasing',
+    no  = 'Decreasing'
+  )
+
+  # 2) Create candlestick
+  candlestick <- plotly::plot_ly(
+    data = quote_,
+    name = 'Price',
+    x    = rownames(quote_),
+    type = 'candlestick',
+    open = ~Open,
+    close = ~Close,
+    high  = ~High,
+    low   = ~Low,
+    increasing = list(
+      line =list(color =ifelse(
+        test = deficiency,
+        yes = '#FFD700',
+        no  = 'palegreen'
+      )
+      )
+    ),
+    decreasing = list(
+      line =list(color =ifelse(
+      test = deficiency,
+      yes = '#0000ff',
+      no  = 'tomato'
+    )
+      )
+    )
+  )
+
+  # 3) create volume
+  # plot
+  volume <- plotly::plot_ly(
+    data = quote_,
+    name = 'Volume',
+    x = rownames(quote_),
+    y = ~Volume,
+    type = 'bar',
+    color = ~direction,
+    colors = c(
+      ifelse(
+        test = deficiency,
+        yes = '#FFD700',
+        no  = 'tomato'
+      ),
+      ifelse(
+        test = deficiency,
+        yes = '#0000ff',
+        no  = 'palegreen'
+      )
+    )
+  )
+
+
+
+  # 4) generate plot
+  plot <- plotly::subplot(
+    candlestick,
+    volume,
+    heights = c(0.7,0.2),
+    nrows=2,
+    shareX = TRUE,
+    titleY = TRUE
+  )
+
+  plot %>% plotly::layout(
+    title = "Basic Candlestick Chart",
+    xaxis = list(rangeslider = list(visible = slider)),
+    showlegend = FALSE,
+    paper_bgcolor='rgba(0,0,0,0)',
+    plot_bgcolor='rgba(0,0,0,0)'
+    )
+
+
+}
+
+
+
+# chart(
+#   subset(
+#     ATOMUSDT,
+#     ATOMUSDT$exchange == 1 & ATOMUSDT$market == 1
+#   ),
+#   deficiency = FALSE
+# )
+
+
+
+# script end;

R/cryptoQuotes-package.R

@@ -6,6 +6,9 @@
 #' @importFrom httr content
 #' @importFrom httr GET
 #' @importFrom jsonlite fromJSON
+#' @importFrom plotly layout
+#' @importFrom plotly plot_ly
+#' @importFrom plotly subplot
 #' @importFrom rlang abort
 #' @importFrom rlang trace_back
 #' @importFrom xts as.xts

R/getQuote.R

@@ -1,5 +1,5 @@
 #' Get a quote on a cryptopair from one
-#' of the major exchanges.
+#' of the major exchanges
 #'
 #' This function returns a crypto quote from
 #' one of the available exchanges. The function supports

R/utils-pipe.R

@@ -0,0 +1,14 @@
+#' Pipe operator
+#'
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
+#'
+#' @name %>%
+#' @rdname pipe
+#' @keywords internal
+#' @export
+#' @importFrom magrittr %>%
+#' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
+NULL

README.Rmd

@@ -30,53 +30,35 @@ Currently, cryptoQuotes supports perpetual futures and spot markets on the follo
 > **Note:** cryptoQuotes supports various intervals limited
 > to what the different exchange APIs allows. The lowest interval is 1s (Seconds), and the highest is 1M (Months)
 
-#### Basic usage
-
-Get USDT denominated ATOM in the spot market from Binance in `30m` intervals,
-
-```{r example}
-## get perpetual contracts on USDT denominated ATOM
-spotPrice <- cryptoQuotes::getQuote(
-  ticker = 'ATOMUSDT',
-  source = 'binance',
-  futures = FALSE,
-  interval = '30m'
-)
-```
-
-This `spotPrice` can be passed to the `chartSeries` from `quantmod` directly to chart it with candlesticks.
-
-```{r chartSeries, echo=TRUE, warning=FALSE, message = FALSE}
-## chart the spotPrice series
-## using quantmod
-quantmod::chartSeries(
-  x = spotPrice,
-  theme = quantmod::chartTheme('black')
-)
-```
-
-When the `spotPrice` has been charted, the indicators in `quantmod` is directly applicable. See for example `addBBands`
-
-```{r addBBands, echo=TRUE, warning=FALSE, message = FALSE}
-## add bollinger bands 
-## using quantmod
-quantmod::addBBands()
-```
 
 #### Installation
 
 **Stable Version**
-``` r
+```{r, eval = FALSE}
 devtools::install_github(
   repo = 'https://github.com/serkor1/cryptoQuotes/',
   ref = 'main'
 )
 ```
 
 **Development Version**
-``` r
+```{r, eval = FALSE}
 devtools::install_github(
   repo = 'https://github.com/serkor1/cryptoQuotes/',
   ref = 'development'
 )
 ```
+
+#### Basic usage
+
+Get USDT denominated ATOM in the spot market from Binance in `30m` intervals,
+
+```{r example}
+## get perpetual contracts on USDT denominated ATOM
+spotPrice <- cryptoQuotes::getQuote(
+  ticker = 'ATOMUSDT',
+  source = 'binance',
+  futures = FALSE,
+  interval = '30m'
+)
+```

man/examples/scr_getQuote.R

@@ -1,35 +1,21 @@
-# script: scr_getQuote
-# date: 2023-09-22
-# author: Serkan Korkmaz, [email protected]
-# objective: demonstrate how to use
-# the getQuote
-# script start;
-
-# gc
-rm(list = ls()); invisible(gc())
-
-# 1) load perpetual
-# futures
-#
-# NOTE: The function is wrapped
-# in try to avoid failing
-# the R-CMD-CHECK on Github
-perpAtom <- try(
-  cryptoQuotes::getQuote(
-  ticker  = 'ATOMUSDT',
-  source = 'binance',
-  interval = '15m',
-  futures = TRUE
-)
-)
-
-
-# 2) head data;
-if (!inherits(perpAtom, 'try-error')) {
-
-  head(perpAtom)
+\donttest{
+  # 1) load perpetual
+  # futures
+
+  perpAtom <- cryptoQuotes::getQuote(
+    ticker  = 'ATOMUSDT',
+    source = 'binance',
+    interval = '15m',
+    futures = TRUE
+  )
+
+  # 2) chart the futures
+  cryptoQuotes::chart(
+    perpAtom
+  )
 
 }
 
 
+
 # script end;