modifying examples for Cran submission

EodHistoricalData · Aug 16, 2024 · 38f145f · 38f145f
1 parent fd4fb60
commit 38f145f
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 6 deletions.
diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
@@ -1,3 +1,3 @@
 Version: 0.5.0
-Date: 2024-08-08 17:27:27 UTC
-SHA: ea86eedd16cda0290ffcc72acb2d91c257dae3c5
+Date: 2024-08-16 13:49:57 UTC
+SHA: fd4fb60e24f999bbbef39ade082e2f0fe3b88bf0
diff --git a/R/dividends.R b/R/dividends.R
@@ -13,9 +13,11 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' set_token(get_demo_token())
 #' df_div <- get_dividends(ticker = "AAPL", exchange = "US")
 #' df_div
+#' }
 get_dividends <- function(ticker = "AAPL", exchange = "US",
                           cache_folder = get_default_cache(),
                           check_quota = TRUE) {

diff --git a/R/financials.R b/R/financials.R
@@ -16,11 +16,13 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' set_token(get_demo_token())
 #' l_out <- get_fundamentals(ticker = "AAPL", exchange = "US")
 #'
 #' df_fin <- parse_financials(l_out, "long")
 #' df_fin
+#' }
 parse_financials <- function(l_out, type_table = "long") {
 
   possible_values <- c("long", "wide")

diff --git a/R/fundamentals.R b/R/fundamentals.R
@@ -20,9 +20,11 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' set_token(get_demo_token())
 #' l_out <- get_fundamentals(ticker = "AAPL", exchange = "US")
 #' names(l_out)
+#' }
 get_fundamentals <- function(ticker = "AAPL",
                              exchange = "US",
                              cache_folder = get_default_cache(),

diff --git a/R/prices.R b/R/prices.R
@@ -9,8 +9,10 @@
 #' @export
 #'
 #' @examples
-#' set_token("demo")
+#' \dontrun{
+#' set_token(get_demo_token())
 #' df_prices <- get_prices(ticker = "AAPL", exchange = "US")
+#' }
 get_prices <- function(ticker = "AAPL",
                        exchange = "US",
                        cache_folder = get_default_cache(),

diff --git a/R/splits.R b/R/splits.R
@@ -9,7 +9,8 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{# requires a subscription (paid) token
+#' \dontrun{
+#' # requires a subscription (paid) token
 #'  df_split <- get_splits(ticker = "AAPL", exchange = "US")
 #' }
 get_splits <- function(ticker = "AAPL", exchange = "US",

diff --git a/R/token.R b/R/token.R
@@ -10,7 +10,9 @@
 #' @export
 #'
 #' @examples
+#' \dontrun{
 #' set_token()
+#' }
 set_token <- function(token = get_demo_token()) {
 
   Sys.setenv("eodhd-token" = token)

diff --git a/man/get_dividends.Rd b/man/get_dividends.Rd
diff --git a/man/get_fundamentals.Rd b/man/get_fundamentals.Rd
diff --git a/man/get_prices.Rd b/man/get_prices.Rd
diff --git a/man/get_splits.Rd b/man/get_splits.Rd
diff --git a/man/parse_financials.Rd b/man/parse_financials.Rd
diff --git a/man/set_token.Rd b/man/set_token.Rd