better error messages when api key is missing, asking users to use the new set_api_key function instead of doing it manually.

Author: mountainMath

R/cancensus.R

@@ -95,8 +95,7 @@ get_census <- function (dataset, regions, level=NA, vectors=c(), geo_format = NA
                             digest::digest(param_string, algo = "md5"), ".rda")
     if (!use_cache || !file.exists(data_file)) {
       if (!have_api_key) {
-        stop(paste("No API key set. Use Sys.setenv(CM_API_KEY = '<your API key>') or",
-                   "options(cancensus.api_key = '<your API key>') to set one."))
+        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."))
       }
       url <- paste0(base_url, "data.csv")
       response <- if (!quiet) {
@@ -147,8 +146,7 @@ get_census <- function (dataset, regions, level=NA, vectors=c(), geo_format = NA
     geo_file <- cache_path(geo_base_name, ".geojson")
     if (!use_cache || !file.exists(geo_file)) {
       if (!have_api_key) {
-        stop(paste("No API key set. Use Sys.setenv(CM_API_KEY = '<your API key>') or",
-                   "options(cancensus.api_key = '<your API key>') to set one."))
+        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."))
       }
       url <- paste0(base_url, "geo.geojson")
       response <- if (!quiet) {

R/intersect_geometry.R

@@ -45,7 +45,7 @@ get_intersecting_geometries <- function(dataset, level, geometry, simplified = F
                                         use_cache = TRUE, quiet = FALSE,
                                         api_key=Sys.getenv("CM_API_KEY")) {
   api_key <- robust_api_key(api_key)
-  have_api_key <- !is.null(api_key)
+  have_api_key <- valid_api_key(api_key)
   result <- NULL
 
     if ("sf" %in% class(geometry)) {
@@ -74,8 +74,7 @@ get_intersecting_geometries <- function(dataset, level, geometry, simplified = F
 
   if (!use_cache || !file.exists(data_file)) {
     if (!have_api_key) {
-      stop(paste("No API key set. Use options(cancensus.api_key = 'XXX') or",
-                 "Sys.setenv(CM_API_KEY = 'XXX') to set one."))
+      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."))
     }
     url <- paste0(cancensus_base_url(),"/api/v1/intersecting_geographies")
     body <- list(dataset=dataset,

docs/articles/Making_maps_with_cancensus.html

@@ -8,7 +8,7 @@ articles:
   cancensus: cancensus.html
   data_discovery: data_discovery.html
   intersecting_geometries: intersecting_geometries.html
-last_built: 2021-01-24T07:54Z
+last_built: 2021-01-25T04:15Z
 urls:
   reference: https://mountainmath.github.io/cancensus/index.html/reference
   article: https://mountainmath.github.io/cancensus/index.html/articles