setup_key: Set up Carto user name and API key with environment
In dracodoc/rCartoAPI: R Wrapper for Carto.com API

Description Usage Arguments Details Value

All functions need a Carto user name and API key.

1	setup_key(env_path = "~/.Renviron")

env_path

path of environment file. Default as ~/.Renviron.

run file.edit("~/.Renviron") to edit the environment variable file
add two lines
- carto_acc = "your user name"
- carto_api_key = "your api key"
run setup_key().

Note if you want to remove the key and deleted the lines from ~/.Renviron, the key could still exist in environment. Restart R session to make sure it was removed.

For adding key or changing key value, edit and run setup_key() is enough.

setup status message

dracodoc/rCartoAPI documentation built on May 15, 2019, 1:52 p.m.