diff --git a/R/api_helpers.R b/R/api_helpers.R index 3113ea24..3c2fcf7b 100644 --- a/R/api_helpers.R +++ b/R/api_helpers.R @@ -75,6 +75,20 @@ ipums_data_collections <- function() { #' @seealso #' [set_ipums_default_collection()] to set a default collection. #' +#' @examples +#' # Set for single session +#' set_ipums_api_key("your-api-key-here") +#' +#' \dontrun{ +#' # Save key to .Renviron for future sessions +#' set_ipums_api_key("your-api-key-here", save = TRUE) +#' +#' # Overwrite existing key in .Renviron +#' set_ipums_api_key("your-api-key-here", overwrite = TRUE) +#' +#' # Remove existing key from .Renviron +#' set_ipums_api_key("your-api-key-here", unset = TRUE) +#' } #' @export set_ipums_api_key <- function(api_key, save = overwrite, diff --git a/man/set_ipums_api_key.Rd b/man/set_ipums_api_key.Rd index 01edc21a..5c8f3609 100644 --- a/man/set_ipums_api_key.Rd +++ b/man/set_ipums_api_key.Rd @@ -37,6 +37,21 @@ from \href{https://walker-data.com/tidycensus/}{tidycensus}. Learn more about the IPUMS API in \code{vignette("ipums-api")}. } +\examples{ +# Set for single session +set_ipums_api_key("your-api-key-here") + +\dontrun{ +# Save key to .Renviron for future sessions +set_ipums_api_key("your-api-key-here", save = TRUE) + +# Overwrite existing key in .Renviron +set_ipums_api_key("your-api-key-here", overwrite = TRUE) + +# Remove existing key from .Renviron +set_ipums_api_key("your-api-key-here", unset = TRUE) +} +} \seealso{ \code{\link[=set_ipums_default_collection]{set_ipums_default_collection()}} to set a default collection. }