set_cancensus_api_key: Set Censusmapper API key
In cancensus: Access, Retrieve, and Work with Canadian Census Data and Geography

set_cancensus_api_key

R Documentation

Set Censusmapper API key

Description

Cancensus requires a free Censusmapper API key to retrieve data. This function helps set the key for either the duration of the session (default) or permanently for use across sessions.

Usage

set_cancensus_api_key(key, overwrite = FALSE, install = FALSE)

Arguments

`key`	a Censusmapper API key. For more information on keys see the API key section
`overwrite`	Option to overwrite any existing Censusmapper keys already stored locally.
`install`	Option to install permanently for use across sessions.

Examples

## Not run: 
set_cancensus_api_key("YOUR_CM_API_KEY")

# This will set the key permanently until overwritten again
set_cancensus_api_key("YOUR_CM_API_KEY", install = TRUE)

## End(Not run)

cancensus documentation built on May 29, 2024, 6:21 a.m.