docs(predict_race): document that census.key will be retrieved from…

… `CENSUS_API_KEY` envvar
kosukeimai · Nov 15, 2023 · 2998d97 · 2998d97
1 parent 4aa6019
commit 2998d97
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/R/predict_race.R b/R/predict_race.R
@@ -42,9 +42,14 @@
 #' must have column named \code{place}.
 #' Specifying \code{\var{census.geo}} will call \code{census_helper} function
 #' to merge Census geographic data at specified level of geography.
-#' @param census.key A character object specifying user's Census API
-#'  key. Required if \code{\var{census.geo}} is specified, because
-#'  a valid Census API key is required to download Census geographic data.
+#' 
+#' @param census.key A character object specifying user's Census API key.
+#'   Required if `census.geo` is specified, because a valid Census API key is
+#'   required to download Census geographic data.
+#'   
+#'   If [`NULL`], the default, attempts to find a census key stored in an
+#'   [environment variable][Sys.getenv] named `CENSUS_API_KEY`.
+#'   
 #' @param census.data A list indexed by two-letter state abbreviations,
 #' which contains pre-saved Census geographic data.
 #' Can be generated using \code{get_census_data} function.

diff --git a/man/predict_race.Rd b/man/predict_race.Rd