From 1858d57d21de83c155aa228bcd1c1de25d35dd60 Mon Sep 17 00:00:00 2001 From: Martha Bass Date: Mon, 23 Sep 2024 09:32:59 -0500 Subject: [PATCH] minor updates --- docs/auth/storing-credentials.qmd | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/auth/storing-credentials.qmd b/docs/auth/storing-credentials.qmd index 975d99d..f6830b8 100644 --- a/docs/auth/storing-credentials.qmd +++ b/docs/auth/storing-credentials.qmd @@ -10,15 +10,15 @@ The packages in the R-ArcGIS Bridge rely heavily on **environment variables**. E ## Environment variables -The package `{arcgisutils}` is responsible for handling authorization for all of the R packages. With it, there are a number of different mechanism for authorizing each requiring a different combination of environment variables. +The package `{arcgisutils}` is responsible for handling authorization for all of the R packages. With it, there are a number of different mechanisms for authorizing each requiring a different combination of environment variables. -Environment variables are fetched using `Sys.getenv()`. They are key-value pairs. For example, to find the path of R run +Environment variables are fetched using `Sys.getenv()`. They are key-value pairs. For example, to find the path of R run: ```{r} Sys.getenv("R_HOME") ``` -Or to set a value use `Sys.setenv()` +Or to set a value use `Sys.setenv()`: ```{r} Sys.setenv("ANSWER_TO_EVERYTHING" = 42) @@ -31,7 +31,7 @@ Sys.getenv("ANSWER_TO_EVERYTHING") Environment variables should _**never**_ be included in your code. We recommend using an `.Renviron` file at minimum to store your credentials. -You can use the `usethis` to edit the file. Ensure it is installed and run the following in your text editor: +You can use the `usethis` package to edit the file. Ensure it is installed and run the following in your text editor: :::{.callout-warning} If you modify environment variables you will need to restart your R session for the change to be registered.