From f06da4c5400a80dc4c5d6c4018c0bd40f0154dad Mon Sep 17 00:00:00 2001 From: Christophe Dervieux Date: Wed, 6 Nov 2024 13:14:33 +0100 Subject: [PATCH] add examples to README --- tests/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index 5de7737c1e..1e5133dbd0 100644 --- a/tests/README.md +++ b/tests/README.md @@ -23,7 +23,7 @@ Tests are running through `Deno.test()` framework, adapted for our Quarto projec Here are what is expected in the environment for the tests : -- R should be installed and in PATH - [**rig**](https://github.com/r-lib/rig) is a good tool to manage R versions. +- R should be installed and in PATH - [**rig**](https://github.com/r-lib/rig) is a good tool to manage R versions. e.g `rig install 4.4.2` and `rig default 4.4.2` to install and set the version to 4.4.2 - On Windows, Rtools should be too (for source package installation) - Python should be installed and in PATH - [**pyenv**](https://github.com/pyenv/pyenv) is a good option to manage Python versions. - On Windows, it will be [`pyenv-win`](https://pyenv-win.github.io/pyenv-win/) to manage versions. Otherwise or install from https://www.python.org/ manually or using `winget`. @@ -53,6 +53,8 @@ Our project is using [explicit dependencies discovery](https://rstudio.github.io See [documentation](https://rstudio.github.io/renv/) if you need to tweak the R environment. +After a dependency update, you can run `configure-test-env.sh` or `configure-test-env.ps1` to update the environment, or manually run `renv::restore()` to recreate the environment with new versions. Be sure to update your R version if needed. + #### Python We use [**pipenv**](https://pipenv.pypa.io/en/latest/) to manage dependencies and recreate easily on all OS. `pipenv` will be installed as part of the configuration if not already.