From 690482c83ae6d379abc95ab7754a24e3d570ab75 Mon Sep 17 00:00:00 2001 From: Egor Kotov Date: Wed, 4 Sep 2024 13:08:40 +0200 Subject: [PATCH] delete include from vignettes --- vignettes/_include/setup-data-directory.qmd | 39 --------------------- 1 file changed, 39 deletions(-) delete mode 100644 vignettes/_include/setup-data-directory.qmd diff --git a/vignettes/_include/setup-data-directory.qmd b/vignettes/_include/setup-data-directory.qmd deleted file mode 100644 index 59a5169..0000000 --- a/vignettes/_include/setup-data-directory.qmd +++ /dev/null @@ -1,39 +0,0 @@ ---- -execute: - eval: false ---- - - -## Set the data directory {#set-data-folder} - -Choose where `{spanishoddata}` should download (and convert) the data by setting the `SPANISH_OD_DATA_DIR` environment variable with the following command: - -```{r} -Sys.setenv(SPANISH_OD_DATA_DIR = "~/spanish_od_data") -``` - -The package will create this directory if it does not exist on the first run of any function that downloads the data. - -
Setting data directory for advanced users - -To permanently set the directory for all projects, you can specify the data directory globally by setting the `SPANISH_OD_DATA_DIR` environment variable, e.g. with the following command: - -```{r} -#| eval: false -usethis::edit_r_environ() -# Then set the data directory globally, by typing this line in the file: -``` - -``` -SPANISH_OD_DATA_DIR = "~/spanish_od_data" -``` - -You can also set the data directory locally, just for the current project. Set the 'envar' in the working directory by editing `.Renviron` file in the root of the project: - -```{r} -#| eval: false -file.edit(".Renviron") -``` - - -