Patch (#48)

## 📚 What?

This PR consists of two bug-fixes --- one user-reported, and one
reported by CRAN:

1. The `Funding Rate` from Binance API were returning vectors of dates
instead of the Funding Rate. Thank you Michael; I would have put your
name in the release docs but I do not have your Github-handle.
2. The docs were generating NOTE on CRAN when embedding {plotly}-graps
via HTML and Latex. The plots have been deleted as they are already
shown in the examples.

## Repository and pkg-specific changes

* Added a Makefile for more flexible control-flow of the pkg-building
process.
* Streamlined CoinMarketCap input so it follows the remaining syntax, ie
`1M` instead of `30d`.
* Cleaned up unused .png-files

> [!NOTE]
>
> See commit history for more details.

Author: serkor1

.Rbuildignore

@@ -17,4 +17,5 @@ playground
 ^data-raw$
 ^codemeta\.json$
 NEWS.Rmd
-.vdoc.r
+.vdoc.r
+Makefile

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 1.3.2
-Date: 2024-11-07 05:41:59 UTC
-SHA: e12973201b0a1173d20ccc6d89b774a4f68b95cf
+Version: 1.3.3
+Date: 2025-09-15 18:41:18 UTC
+SHA: 4f3649c1905e82ab62e390aff687b81b3088eaf8

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: cryptoQuotes
 Title: Open Access to Cryptocurrency Market Data, Sentiment Indicators and Interactive Charts
-Version: 1.3.2
+Version: 1.3.3
 Authors@R: c(
     person(
       given   = "Serkan", 

Makefile

@@ -0,0 +1,41 @@
+## Package information
+package_name     := $(shell grep "^Package:" DESCRIPTION | sed "s/Package: //")
+package_version  := $(shell grep "^Version:" DESCRIPTION | sed "s/Version: //")
+tarball_location := $(package_name)_$(package_version).tar.gz
+
+## default target
+.PHONY: help
+help:
+	@grep -h -E '^[[:space:]]*[A-Za-z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) \
+		| sed -E 's/^[[:space:]]*//' \
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[1;34m%-15s\033[m \xE2\x80\x94 %s\n", $$1, $$2}'
+
+build: ## Build the R package
+	@Rscript --verbose -e "devtools::document()"
+	@R CMD build . && R CMD INSTALL $(tarball_location)
+	@Rscript -e "rmarkdown::render('README.Rmd', output_format = rmarkdown::github_document(html_preview = FALSE), clean = TRUE)"
+	@Rscript -e "rmarkdown::render('NEWS.Rmd', output_format = rmarkdown::github_document(html_preview = FALSE), clean = TRUE)"
+
+check: ## Check the R package
+	@Rscript --verbose -e "devtools::document()"
+	@R CMD build . && R CMD check $(tarball_location)
+
+test: ## Run tests
+	@Rscript --verbose -e "library(cryptoQuotes); testthat::test_dir('tests/testthat')"
+
+clean: ## Remove artifacts
+	@rm -rf $(tarball_location)
+	@rm -rf $(package_name).Rcheck
+	@Rscript -e "remove.packages('$(package_name)')"
+
+fmt: ## Format code
+	@air format .
+
+pkgdown-build: ## Build {pkgdown} documentation
+	@Rscript --verbose -e "devtools::document()"
+	@Rscript -e "pkgdown::clean_site()"
+	@Rscript -e "pkgdown::init_site()"
+	@Rscript -e "pkgdown::build_site()"
+
+pkgdown-preview: ## Preview {pkgdown} documetation
+	@Rscript -e "pkgdown::preview_site()"

NEWS.Rmd

@@ -23,26 +23,34 @@ knitr::opts_chunk$set(
 library(cryptoQuotes)
 ```
 
-# Version 1.3.2
+# Version 1.3.3
 
 ## General
 
-* `bitmart` has updated their futures API. The backend have been updated accordingly.
-
-* Unit-tests have been updated and now all `get_quote()`-functions are being tested for equality in passed and inferred interval.
-
-## Improvements
-
-## [NEW FEATURE] Global Market Capitalization
+### New features
 
 * The `get_mktcap()`-function returns the global market capitalization of the cryptocurrency market. It also has the option to return altcoin market capitalization.
 
 ```{r}
-# get market
-# capitalization
-tail(get_mktcap())
+# get market capitalization
+tail(
+  get_mktcap()
+)
 ```
 
+## Bugfixes
+
+* A bug in the funding rates from Binance have been fixed. The returned values was the time indices of the json-array, not the actual rates.
+
+# Version 1.3.2
+
+## General
+
+* `bitmart` has updated their futures API. The backend have been updated accordingly.
+
+* Unit-tests have been updated and now all `get_quote()`-functions are being tested for equality in passed and inferred interval.
+
+## Improvements
 
 ## [NEW FEATURE] Read and Write `xts`-objects
 

NEWS.md

@@ -1,6 +1,36 @@
 
 <!-- NEWS.md is generated from NEWS.Rmd. Please edit that file -->
 
+# Version 1.3.3
+
+## General
+
+### New features
+
+- The `get_mktcap()`-function returns the global market capitalization
+  of the cryptocurrency market. It also has the option to return altcoin
+  market capitalization.
+
+``` r
+# get market capitalization
+tail(
+  get_mktcap()
+)
+```
+
+    #>                        marketcap       volume
+    #> 2025-09-12 05:00:00 4.015436e+12 163237690580
+    #> 2025-09-13 05:00:00 4.072732e+12 169107128392
+    #> 2025-09-14 05:00:00 4.062633e+12 137318394600
+    #> 2025-09-15 05:00:00 4.056822e+12 128029319974
+    #> 2025-09-16 05:00:00 4.004271e+12 163269852880
+    #> 2025-09-17 05:00:00 4.027473e+12 146323890322
+
+## Bugfixes
+
+- A bug in the funding rates from Binance have been fixed. The returned
+  values was the time indices of the json-array, not the actual rates.
+
 # Version 1.3.2
 
 ## General
@@ -13,7 +43,7 @@
 
 ## Improvements
 
-## Read and Write `xts`-objects
+## \[NEW FEATURE\] Read and Write `xts`-objects
 
 - `read_xts()` and `write_xts()` reads and stores `xts`-objects. These
   functions are essentially just wrappers of `zoo::read.zoo()` and
@@ -62,7 +92,7 @@ chart(
 )
 ```
 
-<img src="man/figures/NEWS-unnamed-chunk-2-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/NEWS-unnamed-chunk-3-1.png" style="display: block; margin: auto;" />
 </details>
 <details>
 <summary>
@@ -86,7 +116,7 @@ chart(
 )
 ```
 
-<img src="man/figures/NEWS-unnamed-chunk-3-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/NEWS-unnamed-chunk-4-1.png" style="display: block; margin: auto;" />
 </details>
 
 ### Supported Exchanges (Issue [\#14](https://github.com/serkor1/cryptoQuotes/issues/14))
@@ -167,7 +197,7 @@ chart(
 )
 ```
 
-<img src="man/figures/NEWS-unnamed-chunk-4-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/NEWS-unnamed-chunk-5-1.png" style="display: block; margin: auto;" />
 </details>
 
 ### Expanded Support
@@ -190,12 +220,12 @@ tail(
 ```
 
     #>                     open_interest
-    #> 2024-11-02 10:00:00      2394.876
-    #> 2024-11-02 11:00:00      2389.595
-    #> 2024-11-02 12:00:00      2396.225
-    #> 2024-11-02 13:00:00      2403.175
-    #> 2024-11-02 14:00:00      2418.193
-    #> 2024-11-02 15:00:00      2398.648
+    #> 2025-09-18 02:00:00      2707.242
+    #> 2025-09-18 03:00:00      2730.265
+    #> 2025-09-18 04:00:00      2731.936
+    #> 2025-09-18 05:00:00      2711.744
+    #> 2025-09-18 06:00:00      2708.016
+    #> 2025-09-18 07:00:00      2706.681
 
 </details>
 
@@ -233,7 +263,7 @@ chart(
 )
 ```
 
-<img src="man/figures/NEWS-unnamed-chunk-6-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/NEWS-unnamed-chunk-7-1.png" style="display: block; margin: auto;" />
 </details>
 
 ### Documentation
@@ -348,7 +378,7 @@ chart(
 )
 ```
 
-<img src="man/figures/NEWS-unnamed-chunk-7-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/NEWS-unnamed-chunk-8-1.png" style="display: block; margin: auto;" />
 
 ### Exchange Support
 
@@ -377,12 +407,12 @@ tail(
 ```
 
     #>                     funding_rate
-    #> 2024-10-31 17:00:00 1.730390e+12
-    #> 2024-11-01 01:00:00 1.730419e+12
-    #> 2024-11-01 09:00:00 1.730448e+12
-    #> 2024-11-01 17:00:00 1.730477e+12
-    #> 2024-11-02 01:00:00 1.730506e+12
-    #> 2024-11-02 09:00:00 1.730534e+12
+    #> 2025-09-16 10:00:00    6.991e-05
+    #> 2025-09-16 18:00:00    6.472e-05
+    #> 2025-09-17 02:00:00    6.972e-05
+    #> 2025-09-17 10:00:00    8.441e-05
+    #> 2025-09-17 18:00:00    6.303e-05
+    #> 2025-09-18 02:00:00    4.941e-05
 
 </details>
 
@@ -403,13 +433,7 @@ tail(
 )
 ```
 
-    #>                     open_interest
-    #> 2024-10-28 01:00:00      82206.35
-    #> 2024-10-29 01:00:00      89115.04
-    #> 2024-10-30 01:00:00      90242.98
-    #> 2024-10-31 01:00:00      89315.49
-    #> 2024-11-01 01:00:00      89544.93
-    #> 2024-11-02 01:00:00      84087.60
+    #>      open_interest
 
 </details>
 

R/ATOM.R

@@ -27,7 +27,3 @@
 #'   sub = list(volume())
 #' )
 "ATOM"
-
-
-
-

R/FUN.R

@@ -30,9 +30,9 @@
 #' @export
 
 remove_bound <- function(
-    xts,
-    bounds = c('upper')) {
-
+  xts,
+  bounds = c('upper')
+) {
   # check if bounds are correctly
   # specified
   # if (!grepl(x = bounds, pattern = 'upper|lower|both')) {
@@ -59,11 +59,10 @@ remove_bound <- function(
     bounds,
     upper = xts[-nrow(xts)],
     lower = xts[-1],
-    both  = xts[-c(1,nrow(xts))]
+    both = xts[-c(1, nrow(xts))]
   )
 
   xts
-
 }
 
 # split window; #####
@@ -90,10 +89,10 @@ remove_bound <- function(
 #'
 #' @export
 split_window <- function(
-    xts,
-    by,
-    bounds = 'upper') {
-
+  xts,
+  by,
+  bounds = 'upper'
+) {
   assert(
     inherits(xts, "xts"),
     error_message = c(
@@ -111,10 +110,9 @@ split_window <- function(
   lapply(
     X = seq_along(by),
     FUN = function(i) {
-
       # 1) extract both
       # indices
-      index <- by[i:(i+1)]
+      index <- by[i:(i + 1)]
 
       # 2) subset using
       # window and cut the upper
@@ -123,16 +121,14 @@ split_window <- function(
         xts = stats::window(
           x = xts,
           start = index[1],
-          end   = index[2]
+          end = index[2]
         ),
         bounds = bounds
       )
 
       xts
-
     }
   )
-
 }
 
 # calibrate window; ####
@@ -157,10 +153,10 @@ split_window <- function(
 #'
 #' @export
 calibrate_window <- function(
-    list,
-    FUN,
-    ...) {
-
+  list,
+  FUN,
+  ...
+) {
   assert(
     inherits(list, "list"),
     error_message = c(
@@ -185,7 +181,6 @@ calibrate_window <- function(
       ...
     )
   )
-
 }
 
 # script end;