Skip to content

Commit 409892a

Browse files
change error messages and vignette to refer to renamed set_cancensus_api_key
change error messages and vignette to refer to renamed set_cancensus_api_key
1 parent a39c509 commit 409892a

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

R/cancensus.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ get_census <- function (dataset, regions, level=NA, vectors=c(), geo_format = NA
141141
meta_file <- paste0(data_file, ".meta")
142142
if (!use_cache || !file.exists(data_file)) {
143143
if (!have_api_key) {
144-
stop(paste("No API key set. Use set_api_key('<your API ket>`) to set one, or set_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
144+
stop(paste("No API key set. Use set_cancensus_api_key('<your API ket>`) to set one, or set_cancensus_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
145145
}
146146
url <- paste0(base_url, "data.csv")
147147
response <- if (!quiet) {
@@ -206,7 +206,7 @@ get_census <- function (dataset, regions, level=NA, vectors=c(), geo_format = NA
206206
meta_file <- paste0(geo_file, ".meta")
207207
if (!use_cache || !file.exists(geo_file)) {
208208
if (!have_api_key) {
209-
stop(paste("No API key set. Use set_api_key('<your API ket>`) to set one, or set_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
209+
stop(paste("No API key set. Use set_cancensus_api_key('<your API ket>`) to set one, or set_cancensus_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
210210
}
211211
url <- paste0(base_url, "geo.geojson")
212212
response <- if (!quiet) {

R/intersect_geometry.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ get_intersecting_geometries <- function(dataset, level, geometry, simplified = F
7676

7777
if (!use_cache || !file.exists(data_file)) {
7878
if (!have_api_key) {
79-
stop(paste("No API key set. Use set_api_key('<your API ket>`) to set one, or set_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
79+
stop(paste("No API key set. Use set_cancensus_api_key('<your API ket>`) to set one, or set_cancensus_api_key('<your API ket>`, install = TRUE) to save is permanently in our .Renviron."))
8080
}
8181
url <- paste0(cancensus_base_url(),"/api/v1/intersecting_geographies")
8282
body <- list(dataset=dataset,

vignettes/cancensus.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ As Statistics Canada does not provide direct API access to Census data, **cancen
3131

3232
**cancensus** requires a valid CensusMapper API key to use. You can obtain a free API key by [signing up](https://censusmapper.ca/users/sign_up) for a CensusMapper account. CensusMapper API keys are free and public API quotas are generous; however, due to incremental costs of serving large quantities of data, there limits to API usage in place. For most use cases, these API limits should not be an issue. Production uses with large extracts of fine grained geographies may run into API quota limits. For larger quotas, please get in touch with Jens [directly](mailto:jens@censusmapper.ca).
3333

34-
To check your API key, just go to "Edit Profile" (in the top-right of the CensusMapper menu bar). Once you have your key, you can store it in your system environment so it is automatically used in API calls. To do so just enter `set_api_key(<your_api_key>, install = TRUE)`
34+
To check your API key, just go to "Edit Profile" (in the top-right of the CensusMapper menu bar). Once you have your key, you can store it in your system environment so it is automatically used in API calls. To do so just enter `set_cancensus_api_key(<your_api_key>, install = TRUE)`
3535

3636
## Installing cancensus
3737

0 commit comments

Comments
 (0)