changed SimFin to 'SimFin'

matthiasgomolka · Sep 24, 2020 · c43e2d9 · c43e2d9
1 parent 4143cd8
commit c43e2d9
Show file tree

Hide file tree

Showing 23 changed files with 39 additions and 39 deletions.
diff --git a/CRAN-RELEASE b/CRAN-RELEASE
@@ -1,2 +1,2 @@
-This package was submitted to CRAN on 2020-09-08.
-Once it is accepted, delete this file and tag the release (commit 9cc149c).
+This package was submitted to CRAN on 2020-09-10.
+Once it is accepted, delete this file and tag the release (commit 086a5e6).
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,15 +1,15 @@
 Type: Package
 Package: simfinapi
-Title: Accessing SimFin Data
+Title: Accessing 'SimFin' Data
 Version: 0.1.0
 Authors@R: 
     person(given = "Matthias",
            family = "Gomolka",
            role = c("aut", "cre"),
            email = "matthias.gomolka@posteo.de")
 Description: Through simfinapi, you can intuitively access the
-    SimFin Web-API (<https://simfin.com/>) to make SimFin data easily
-    available in R. To obtain an SimFin API key (and thus to use this
+    'SimFin' Web-API (<https://simfin.com/>) to make 'SimFin' data easily
+    available in R. To obtain an 'SimFin' API key (and thus to use this
     package), you need to register at <https://simfin.com/login>.
 License: GPL-3
 URL: https://github.com/Plebejer/simfinapi

diff --git a/R/call_api.R b/R/call_api.R
@@ -37,7 +37,7 @@ call_api <- function(..., cache_dir) {
   )
 
   if (utils::hasName(content, "error")) {
-    warning("From SimFin API: '", content[["error"]], "'", call. = FALSE)
+    warning("From 'SimFin' API: '", content[["error"]], "'", call. = FALSE)
     return(NULL)
   }
 

diff --git a/R/sfa_get_entities.R b/R/sfa_get_entities.R
@@ -1,5 +1,5 @@
-#' Get a table of all available SimFin ID's with ticker and name.
-#' @param api_key [character] Your SimFin API key. It's recommended to set
+#' Get a table of all available 'SimFin' ID's with ticker and name.
+#' @param api_key [character] Your 'SimFin' API key. It's recommended to set
 #'   the API key globally using [sfa_set_api_key].
 #' @param cache_dir [character] Your cache directory. It's recommended to set
 #'   the cache directory globally using [sfa_set_cache_dir].

diff --git a/R/sfa_get_info.R b/R/sfa_get_info.R
@@ -1,7 +1,7 @@
 #' Get basic company information
 #' @description Internal function.
 #' @param ticker [integer] Ticker of the companies of interest.
-#' @param api_key `[character(1)]` Your SimFin API key. For simplicity use
+#' @param api_key `[character(1)]` Your 'SimFin' API key. For simplicity use
 #'   `options(sfa_api_key = "yourapikey")`.
 #' @param cache_dir [character] Your cache directory. It's recommended to set
 #'   the cache directory globally using [sfa_set_cache_dir].
@@ -39,11 +39,11 @@ sfa_get_info_ <- function(ticker, api_key, cache_dir) {
 
 #' Get basic company information
 #' @param Ticker [integer] Ticker of the companies of interest.
-#' @param SimFinId [integer] SimFin IDs of the companies of interest. Any
+#' @param SimFinId [integer] 'SimFin' IDs of the companies of interest. Any
 #'   SimFinId will be internally translated to the respective `Ticker`. This
 #'   reduces the number of queries if you would query the same company via
 #'   `Ticker` *and* `SimFinId`.
-#' @param api_key [character] Your SimFin API key. It's recommended to set
+#' @param api_key [character] Your 'SimFin' API key. It's recommended to set
 #'   the API key globally using [sfa_set_api_key].
 #' @param cache_dir [character] Your cache directory. It's recommended to set
 #'   the cache directory globally using [sfa_set_cache_dir].

diff --git a/R/sfa_get_statement.R b/R/sfa_get_statement.R
@@ -80,7 +80,7 @@ sfa_get_statement_ <- function(
 
 #' Get basic company information
 #' @param Ticker [integer] Ticker of the companies of interest.
-#' @param SimFinId [integer] SimFin IDs of the companies of interest. Any
+#' @param SimFinId [integer] 'SimFin' IDs of the companies of interest. Any
 #'   SimFinId will be internally translated to the respective `Ticker`. This
 #'   reduces the number of queries if you would query the same company via
 #'   `Ticker` *and* `SimFinId`.
@@ -129,7 +129,7 @@ sfa_get_statement_ <- function(
 #'   & diluted shares outstanding for each period along with the fundamentals.
 #'   Reserved for SimFin+ users (as non-SimFin+ user, you can still use the
 #'   shares outstanding endpoints).
-#' @param api_key [character] Your SimFin API key. It's recommended to set
+#' @param api_key [character] Your 'SimFin' API key. It's recommended to set
 #'   the API key globally using [sfa_set_api_key].
 #' @param cache_dir [character] Your cache directory. It's recommended to set
 #'   the cache directory globally using [sfa_set_cache_dir].

diff --git a/R/sfa_set_api_key.R b/R/sfa_set_api_key.R
@@ -1,4 +1,4 @@
-#' Set your SimFin API key globally
+#' Set your 'SimFin' API key globally
 #' @description It is highly recommended to set the API key globally as it makes
 #'   specifying the `api_key` argument of other `sfa_*` functions obsolete.
 #'

diff --git a/R/sfa_set_cache_dir.R b/R/sfa_set_cache_dir.R
@@ -2,14 +2,14 @@
 #' @description It is highly recommended to set the cache directory globally.
 #'   This has two advantages:
 #'
-#'   1. Results from the SimFin API calls are cached over the end of the
+#'   1. Results from the 'SimFin' API calls are cached over the end of the
 #'   session. This is especially interesting if you don't have a SimFin+ account
 #'   and the number of API calls is limited to 2,000 per day.
 #'   2. It makes specifying the `cache_dir` argument of other `sfa_*` functions
 #'   obsolete.
 #'
 #' @param path [character] The directory where you want to cache the responses
-#'   from the SimFin API calls.
+#'   from the 'SimFin' API calls.
 #' @param create [logical] Set `TRUE` if you want to create `path` automatically
 #'   if it does not yet exist.
 sfa_set_cache_dir <- function(path, create = FALSE) {

diff --git a/README.Rmd b/README.Rmd
@@ -34,11 +34,11 @@ theme_set(theme_minimal())
 `r badge_dependencies()`
 
 ## What does simfinapi do?
-simfinapi wraps the https://simfin.com/ Web-API to make SimFin data easily
+simfinapi wraps the https://simfin.com/ Web-API to make 'SimFin' data easily
 available in R. 
 
 *To use the package, you need to register at https://simfin.com/login and obtain
-a SimFin API key.*
+a 'SimFin' API key.*
 
 
 ## Example

diff --git a/README.md b/README.md
@@ -12,11 +12,11 @@ status](https://github.com/Plebejer/simfinapi/workflows/R-CMD-check/badge.svg)](
 
 ## What does simfinapi do?
 
-simfinapi wraps the <https://simfin.com/> Web-API to make SimFin data
+simfinapi wraps the <https://simfin.com/> Web-API to make ‘SimFin’ data
 easily available in R.
 
 *To use the package, you need to register at <https://simfin.com/login>
-and obtain a SimFin API key.*
+and obtain a ‘SimFin’ API key.*
 
 ## Example
 

diff --git a/man/check_inputs.Rd b/man/check_inputs.Rd
diff --git a/man/figures/README-plot_data-1.png b/man/figures/README-plot_data-1.png
diff --git a/man/figures/README-recreate_plot-1.png b/man/figures/README-recreate_plot-1.png
diff --git a/man/sfa_get_entities.Rd b/man/sfa_get_entities.Rd
diff --git a/man/sfa_get_info.Rd b/man/sfa_get_info.Rd
diff --git a/man/sfa_get_info_.Rd b/man/sfa_get_info_.Rd
diff --git a/man/sfa_get_prices.Rd b/man/sfa_get_prices.Rd
diff --git a/man/sfa_get_shares.Rd b/man/sfa_get_shares.Rd
diff --git a/man/sfa_get_shares_.Rd b/man/sfa_get_shares_.Rd
diff --git a/man/sfa_get_statement.Rd b/man/sfa_get_statement.Rd
diff --git a/man/sfa_get_statement_.Rd b/man/sfa_get_statement_.Rd
diff --git a/man/sfa_set_api_key.Rd b/man/sfa_set_api_key.Rd
diff --git a/man/sfa_set_cache_dir.Rd b/man/sfa_set_cache_dir.Rd