diff --git a/DESCRIPTION b/DESCRIPTION index c884795..db3eac6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -19,7 +19,7 @@ Authors@R: c( ) Description: This high-level API client provides open access to cryptocurrency market data, sentiment indicators, and interactive charting tools. - The data is sourced from major cryptocurrency exchanges via cURL and processed using the xts package. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. + The data is sourced from major cryptocurrency exchanges via 'curl' and returned in 'xts'-format. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. This flexibility makes it ideal for developing and backtesting trading strategies or conducting detailed market analysis. License: GPL (>= 2) Encoding: UTF-8 diff --git a/codemeta.json b/codemeta.json index 88421fc..d5417ad 100644 --- a/codemeta.json +++ b/codemeta.json @@ -2,7 +2,7 @@ "@context": "https://doi.org/10.5063/schema/codemeta-2.0", "@type": "SoftwareSourceCode", "identifier": "cryptoQuotes", - "description": " This high-level API client provides open access to cryptocurrency market data, sentiment indicators, and interactive charting tools. The data is sourced from major cryptocurrency exchanges via cURL and processed using the xts package. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. This flexibility makes it ideal for developing and backtesting trading strategies or conducting detailed market analysis.", + "description": " This high-level API client provides open access to cryptocurrency market data, sentiment indicators, and interactive charting tools. The data is sourced from major cryptocurrency exchanges via 'curl' and returned in 'xts'-format. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. This flexibility makes it ideal for developing and backtesting trading strategies or conducting detailed market analysis.", "name": "cryptoQuotes: Open Access to Cryptocurrency Market Data, Sentiment Indicators and Interactive Charts", "relatedLink": ["https://serkor1.github.io/cryptoQuotes/", "https://CRAN.R-project.org/package=cryptoQuotes"], "codeRepository": "https://github.com/serkor1/cryptoQuotes", @@ -14,7 +14,7 @@ "name": "R", "url": "https://r-project.org" }, - "runtimePlatform": "R version 4.4.1 (2024-06-14)", + "runtimePlatform": "R version 4.4.2 (2024-10-31)", "provider": { "@id": "https://cran.r-project.org", "@type": "Organization", @@ -257,7 +257,7 @@ }, "SystemRequirements": null }, - "fileSize": "1476.579KB", + "fileSize": "1455.164KB", "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://app.codecov.io/gh/serkor1/cryptoQuotes"], diff --git a/man/alma.Rd b/man/alma.Rd index 76fb1c1..4f27ccd 100644 --- a/man/alma.Rd +++ b/man/alma.Rd @@ -14,7 +14,7 @@ alma( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::ALMA()}}.} +The name of the vector to passed into \code{\link[TTR:ALMA]{TTR::ALMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -31,7 +31,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/bollinger_bands.Rd b/man/bollinger_bands.Rd index 29d5dbb..0cf307a 100644 --- a/man/bollinger_bands.Rd +++ b/man/bollinger_bands.Rd @@ -30,8 +30,8 @@ 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:bollingerBands]{TTR::BBands()}}-function. The function adds bollinger bands +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts +with the \code{\link[TTR:BBands]{TTR::BBands()}}-function. The function adds bollinger bands to the main \code{\link[=chart]{chart()}}. } \examples{ diff --git a/man/chart.Rd b/man/chart.Rd index 6835b58..29e35ab 100644 --- a/man/chart.Rd +++ b/man/chart.Rd @@ -21,7 +21,7 @@ can be coerced to a \code{\link[xts:xts]{xts::xts()}}-object.} \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:add_trace]{plotly::add_lines()}}-function(s).} +\item{indicator}{An optional \link{list} of \code{\link[plotly:add_lines]{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.} diff --git a/man/cryptoQuotes-package.Rd b/man/cryptoQuotes-package.Rd index 7c52e9a..eab101c 100644 --- a/man/cryptoQuotes-package.Rd +++ b/man/cryptoQuotes-package.Rd @@ -8,7 +8,7 @@ \description{ \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} -This high-level API client provides open access to cryptocurrency market data, sentiment indicators, and interactive charting tools. The data is sourced from major cryptocurrency exchanges via cURL and processed using the xts package. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. This flexibility makes it ideal for developing and backtesting trading strategies or conducting detailed market analysis. +This high-level API client provides open access to cryptocurrency market data, sentiment indicators, and interactive charting tools. The data is sourced from major cryptocurrency exchanges via 'curl' and returned in 'xts'-format. The data comes in open, high, low, and close (OHLC) format with flexible granularity, ranging from seconds to months. This flexibility makes it ideal for developing and backtesting trading strategies or conducting detailed market analysis. } \seealso{ Useful links: diff --git a/man/dema.Rd b/man/dema.Rd index 1095ce9..99773e1 100644 --- a/man/dema.Rd +++ b/man/dema.Rd @@ -15,7 +15,7 @@ dema( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::DEMA()}}.} +The name of the vector to passed into \code{\link[TTR:DEMA]{TTR::DEMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -36,7 +36,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/donchian_channel.Rd b/man/donchian_channel.Rd index fcb1929..106325d 100644 --- a/man/donchian_channel.Rd +++ b/man/donchian_channel.Rd @@ -28,7 +28,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{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()}}. diff --git a/man/ema.Rd b/man/ema.Rd index a338eac..2cee2ad 100644 --- a/man/ema.Rd +++ b/man/ema.Rd @@ -14,7 +14,7 @@ ema( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::EMA()}}.} +The name of the vector to passed into \code{\link[TTR:EMA]{TTR::EMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -33,7 +33,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/evwma.Rd b/man/evwma.Rd index 4308bec..59d5590 100644 --- a/man/evwma.Rd +++ b/man/evwma.Rd @@ -12,7 +12,7 @@ evwma( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::EVWMA()}}} +The name of the vector to passed into \code{\link[TTR:EVWMA]{TTR::EVWMA()}}} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -25,7 +25,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/hma.Rd b/man/hma.Rd index ca386f0..7cd3603 100644 --- a/man/hma.Rd +++ b/man/hma.Rd @@ -12,7 +12,7 @@ hma( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::HMA()}}.} +The name of the vector to passed into \code{\link[TTR:HMA]{TTR::HMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -25,7 +25,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/macd.Rd b/man/macd.Rd index dc81d57..374c595 100644 --- a/man/macd.Rd +++ b/man/macd.Rd @@ -40,7 +40,7 @@ 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:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_trace]{plotly::add_lines()}}-function that +A high-level \code{\link[plotly:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_lines]{plotly::add_lines()}}-function that interacts with the \code{\link[TTR:MACD]{TTR::MACD()}}-function. The function adds subchart with a \code{\link[TTR:MACD]{TTR::MACD()}}-indicator. } diff --git a/man/rsi.Rd b/man/rsi.Rd index 2dcbd75..8cfaf6d 100644 --- a/man/rsi.Rd +++ b/man/rsi.Rd @@ -43,7 +43,7 @@ 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:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_trace]{plotly::add_lines()}}-function that +A high-level \code{\link[plotly:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_lines]{plotly::add_lines()}}-function that interacts with the \code{\link[TTR:RSI]{TTR::RSI()}}-function. The function adds a subchart with a \code{\link[TTR:RSI]{TTR::RSI()}}-indicator. } diff --git a/man/sma.Rd b/man/sma.Rd index 79c6d6d..925c07f 100644 --- a/man/sma.Rd +++ b/man/sma.Rd @@ -12,7 +12,7 @@ sma( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::SMA()}}.} +The name of the vector to passed into \code{\link[TTR:SMA]{TTR::SMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -25,7 +25,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/smi.Rd b/man/smi.Rd index 76cabe7..e063c0b 100644 --- a/man/smi.Rd +++ b/man/smi.Rd @@ -42,10 +42,10 @@ calculation?} calculating FastK. See Details.} \item{upper_limit}{A \link{numeric}-vector of \link{length} 1. 40 by default. -Sets the upper limit of the \link[TTR:stochastics]{TTR::SMI}.} +Sets the upper limit of the \link[TTR:SMI]{TTR::SMI}.} \item{lower_limit}{A \link{numeric}-vector of \link{length} 1. -40 by default. -Sets the lower limit of the \link[TTR:stochastics]{TTR::SMI}.} +Sets the lower limit of the \link[TTR:SMI]{TTR::SMI}.} \item{color}{A \link{character}-vector of \link{length} 1. "#4682b4" by default.} @@ -57,9 +57,9 @@ 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:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_trace]{plotly::add_lines()}}-function that -interacts with the \code{\link[TTR:stochastics]{TTR::SMI()}}-function. -The function adds a subchart with a \code{\link[TTR:stochastics]{TTR::SMI()}}-indicator. +A high-level \code{\link[plotly:plot_ly]{plotly::plot_ly()}}- and \code{\link[plotly:add_lines]{plotly::add_lines()}}-function that +interacts with the \code{\link[TTR:SMI]{TTR::SMI()}}-function. +The function adds a subchart with a \code{\link[TTR:SMI]{TTR::SMI()}}-indicator. } \examples{ # script start; diff --git a/man/vwap.Rd b/man/vwap.Rd index 3134e63..d8d0a3c 100644 --- a/man/vwap.Rd +++ b/man/vwap.Rd @@ -13,7 +13,7 @@ vwap( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::VWAP()}}} +The name of the vector to passed into \code{\link[TTR:VWAP]{TTR::VWAP()}}} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -29,7 +29,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/wma.Rd b/man/wma.Rd index b3cc3f9..f07525e 100644 --- a/man/wma.Rd +++ b/man/wma.Rd @@ -13,7 +13,7 @@ wma( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::WMA()}}.} +The name of the vector to passed into \code{\link[TTR:WMA]{TTR::WMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -29,7 +29,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. } diff --git a/man/write_xts.Rd b/man/write_xts.Rd index fd5107d..1542aa6 100644 --- a/man/write_xts.Rd +++ b/man/write_xts.Rd @@ -37,7 +37,7 @@ file \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} -The \code{\link[=write_xts]{write_xts()}}- and \code{\link[=read_xts]{read_xts()}}-functions are \code{\link[zoo:read.zoo]{zoo::write.zoo()}}- and \code{\link[zoo:read.zoo]{zoo::read.zoo()}}-wrapper functions. +The \code{\link[=write_xts]{write_xts()}}- and \code{\link[=read_xts]{read_xts()}}-functions are \code{\link[zoo:write.zoo]{zoo::write.zoo()}}- and \code{\link[zoo:read.zoo]{zoo::read.zoo()}}-wrapper functions. } \details{ When reading and writing <[\link[xts]{xts}]>-objects the \link{attributes} does not follow the object. diff --git a/man/zlema.Rd b/man/zlema.Rd index 9be9f5e..55f7c60 100644 --- a/man/zlema.Rd +++ b/man/zlema.Rd @@ -13,7 +13,7 @@ zlema( } \arguments{ \item{price}{A \link{character}-vector of \link{length} 1. "close" by default. -The name of the vector to passed into \code{\link[TTR:MovingAverages]{TTR::ZLEMA()}}.} +The name of the vector to passed into \code{\link[TTR:ZLEMA]{TTR::ZLEMA()}}.} \item{n}{Number of periods to average over. Must be between 1 and \code{nrow(x)}, inclusive.} @@ -29,7 +29,7 @@ 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 +A high-level \code{\link[plotly:add_lines]{plotly::add_lines()}}-wrapper function that interacts with \{TTR\}'s moving average family of functions. The function adds moving average indicators to the main \code{\link[=chart]{chart()}}. }