fix the confusing API key placeholder instructions

R/cfbd_api_key.R

@@ -1,27 +1,27 @@
-#' @title 
+#' @title
 #' **CFBD API Key Registration**
 #' @description Save your API Key as a system environment variable `CFBD_API_KEY`
 #' @details To get access to an API key, follow the instructions at [https://collegefootballdata.com/key](https://collegefootballdata.com/key "Key Registration")
-#' 
-#' **Using the key:** 
-#' You can save the key for consistent usage by adding `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). 
-#' Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), 
-#' a new script will pop open named `.Renviron`, **THEN** 
+#'
+#' **Using the key:**
+#' You can save the key for consistent usage by adding `CFBD_API_KEY=YOUR-API-KEY-HERE` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)).
+#' Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html),
+#' a new script will pop open named `.Renviron`, **THEN**
 #' paste the following in the new script that pops up (with**out** quotations)
 #' ```r
-#' CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
+#' CFBD_API_KEY = YOUR-API-KEY-HERE
 #' ```
-#' Save the script and restart your RStudio session, by clicking `Session` (in between `Plots` and `Build`) and click `Restart R` 
-#' (there also exists the shortcut `Ctrl + Shift + F10` to restart your session). 
-#' 
+#' Save the script and restart your RStudio session, by clicking `Session` (in between `Plots` and `Build`) and click `Restart R`
+#' (there also exists the shortcut `Ctrl + Shift + F10` to restart your session).
+#'
 #' If set correctly, from then on you should be able to use any of the `cfbd_` functions without any other changes.
-#' 
-#' **For less consistent usage:** 
-#' At the beginning of every session or within an R environment, 
-#' save your API key as the environment variable `CFBD_API_KEY` (**with** quotations) 
+#'
+#' **For less consistent usage:**
+#' At the beginning of every session or within an R environment,
+#' save your API key as the environment variable `CFBD_API_KEY` (**with** quotations)
 #' using a command like the following.
 #' ```r
-#' Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
+#' Sys.setenv(CFBD_API_KEY = "YOUR-API-KEY-HERE")
 #' ```
 #' @name register_cfbd
 NULL

README.Rmd

@@ -56,16 +56,16 @@ The [CollegeFootballData API](https://collegefootballdata.com/) now requires an
 
 * To get an API key, follow the directions here: [College Football Data Key Registration.](https://collegefootballdata.com/key) 
 
-* Using the key: You can save the key for consistent usage by adding `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), a new script will pop open named `.Renviron`, **THEN** paste the following in the new script that pops up (with**out** quotations)
+* Using the key: You can save the key for consistent usage by adding `CFBD_API_KEY=YOUR-API-KEY-HERE` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), a new script will pop open named `.Renviron`, **THEN** paste the following in the new script that pops up (with**out** quotations)
 ```r
-CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
+CFBD_API_KEY = YOUR-API-KEY-HERE
 ```
 Save the script and restart your RStudio session, by clicking `Session` (in between `Plots` and `Build`) and click `Restart R` (there also exists the shortcut `Ctrl + Shift + F10` to restart your session). If set correctly, from then on you should be able to use any of the `cfbd_` functions without any other changes.
 
 * For less consistent usage: At the beginning of every session or within an R environment, save your API key as the environment variable `CFBD_API_KEY` (with quotations) using a command like the following.
 
 ```{r}
-Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
+Sys.setenv(CFBD_API_KEY = "YOUR-API-KEY-HERE")
 ```
 
 

README.md

@@ -61,16 +61,16 @@ requires an API key, here’s a quick run-down:
     Data Key Registration.](https://collegefootballdata.com/key)
 
 -   Using the key: You can save the key for consistent usage by adding
-    `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .Renviron file
-    (easily accessed via
+    `CFBD_API_KEY=YOUR-API-KEY-HERE` to your .Renviron file (easily
+    accessed via
     [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)).
     Run
     [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html),
     a new script will pop open named `.Renviron`, **THEN** paste the
     following in the new script that pops up (with**out** quotations)
 
 ``` r
-CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
+CFBD_API_KEY = YOUR-API-KEY-HERE
 ```
 
 Save the script and restart your RStudio session, by clicking `Session`
@@ -85,7 +85,7 @@ functions without any other changes.
     following.
 
 ``` r
-Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
+Sys.setenv(CFBD_API_KEY = "YOUR-API-KEY-HERE")
 ```
 
 ## Follow [cfbfastR](https://twitter.com/cfbfastR) and the [SportsDataverse](https://twitter.com/SportsDataverse) on Twitter and star this repo

vignettes/intro.Rmd

@@ -82,18 +82,18 @@ As of `cfbfastR` version `r remote_version`, the package exports `r nrow(exporte
 
 #### **Using the CFB Data API key**
 
-You can save the key for consistent usage by adding `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), a new script will pop open named `.Renviron`, **THEN** paste the following in the new script that pops up (with**out** quotations)
+You can save the key for consistent usage by adding `CFBD_API_KEY=YOUR-API-KEY-HERE` to your .Renviron file (easily accessed via [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). Run [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html), a new script will pop open named `.Renviron`, **THEN** paste the following in the new script that pops up (with**out** quotations)
 
 ```{r, eval = FALSE}
-CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX
+CFBD_API_KEY = YOUR-API-KEY-HERE
 ```
 
 Save the script and restart your RStudio session, by clicking `Session` (in between `Plots` and `Build`) and click `Restart R` (n.b. there also exists the shortcut `Ctrl + Shift + F10` to restart your session). If set correctly, from then on you should be able to use any of the `cfbd_` functions without any other changes.
 
 For less consistent usage, save your API key as the environment variable `CFBD_API_KEY` (**with** quotations) at the beginning of every session, using a command like the following.
 
 ```{r, eval = FALSE}
-Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")
+Sys.setenv(CFBD_API_KEY = "YOUR-API-KEY-HERE")
 ```
 
 # Let's get some play by play data