Skip to content

Commit

Permalink
docs(get_census_data): document use of CENSUS_API_KEY envvar
Browse files Browse the repository at this point in the history
  • Loading branch information
rossellhayes committed Nov 15, 2023
1 parent 616c2c6 commit ede8ad0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
9 changes: 7 additions & 2 deletions R/get_census_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
#' for specified state(s). Using this function to download Census data in advance
#' can save considerable time when running \code{predict_race} and \code{census_helper}.
#'
#' @param key A required character object containing a valid Census API key,
#' which can be requested \href{https://api.census.gov/data/key_signup.html}{here}.
#' @param key A character string containing a valid U.S. Census API key,
#' which can be requested from the
#' [U.S. Census API key signup page](https://api.census.gov/data/key_signup.html).
#'
#' If [`NULL`], the default, attempts to find a census key stored in an
#' [environment variable][Sys.getenv] named `CENSUS_API_KEY`.
#'
#' @param states which states to extract Census data for, e.g., \code{c("NJ", "NY")}.
#' @param age A \code{TRUE}/\code{FALSE} object indicating whether to condition on
#' age or not. If \code{FALSE} (default), function will return Pr(Geolocation | Race).
Expand Down
8 changes: 6 additions & 2 deletions man/get_census_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ede8ad0

Please sign in to comment.