set_bls_key | R Documentation |
.Renviron
File for Repeated UseThis function will add your BLS API key to your .Renviron
file so it can be called securely without being stored
in your code. After you have installed your key, it can be called any time by typing Sys.getenv("BLS_KEY")
and can be
used in package functions by simply typing BLS_KEY. If you do not have an .Renviron
file, the function will create on for you.
If you already have an .Renviron
file, the function will append the key to your existing file, while making a backup of your
original file for disaster recovery purposes.
set_bls_key(key = NA, overwrite = NA)
key |
The API key provided to you from the BLS formatted in quotes. A key can be acquired at https://data.bls.gov/registrationEngine/ |
overwrite |
If this is set to TRUE, it will overwrite an existing BLS_KEY that you already have in your |
No return value. A convenience function used for API Key configuration.
## Not run: set_bls_key("111111abc") # First time, reload your environment so you can use the key without restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("BLS_KEY") ## End(Not run) ## Not run: # If you need to overwrite an existing key: set_bls_key("111111abc", overwrite = TRUE) # First time, reload your environment so you can use the key without restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("BLS_KEY") ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.