Skip to content

Commit 63e2a72

Browse files
Update R/auth.R
Co-authored-by: brookslogan <lcbrooks@cs.cmu.edu>
1 parent 3ee71a5 commit 63e2a72

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

R/auth.R

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@
1111
#' key](https://api.delphi.cmu.edu/epidata/admin/registration_form).
1212
#'
1313
#' API keys are strings read from the environment variable `DELPHI_EPIDATA_KEY`.
14-
#' We recommend setting your key with `save_api_key()`, which will modify your
15-
#' `.Renviron` file and will persist your key across R sessions (see `?Startup`
16-
#' for a description of `.Renviron` files). Alternatively, you can modify the
17-
#' environment variable in the shell or with `Sys.setenv()`, but these will not
18-
#' persist across sessions.
14+
#' We recommend setting your key with `save_api_key()`, which will modify an
15+
#' applicable `.Renviron` file, which will be read in automatically when you
16+
#' start future R sessions (see [`?Startup`][base::Startup] for details on
17+
#' `.Renviron` files). Alternatively, you can modify the environment variable at
18+
#' the command line before/while launching R, or inside an R session with
19+
#' [`Sys.setenv()`], but these will not persist across sessions.
1920
#'
2021
#' Once an API key is set, it is automatically used for all requests made by
2122
#' functions in this package.

0 commit comments

Comments
 (0)