From d75f961c82cc251f2b81f0406cbc9897c91ee1a9 Mon Sep 17 00:00:00 2001 From: u0140201 Date: Thu, 6 Nov 2025 14:34:06 +0100 Subject: [PATCH 1/2] update vsc-Rproject documentation --- source/compute/software/vsc_rproject.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/compute/software/vsc_rproject.rst b/source/compute/software/vsc_rproject.rst index 94394abc7..aa4ca53a9 100644 --- a/source/compute/software/vsc_rproject.rst +++ b/source/compute/software/vsc_rproject.rst @@ -215,4 +215,7 @@ When launching a new session via the :ref:`Studio Server ` app i The R module selected in the OnDemand form must match the R module that was used to create the project! Otherwise dependency conflicts may arise as RStudio Server will replace the modules loaded via the pre-run scriplet. -Once inside the RStudio session, you still need to open the RStudio Project via the interface. +Once inside the RStudio session, you still need to open the RStudio Project via the interface: +File > Open Project... + +After loading the RStudio Project, any packages you install — via install.packages(), devtools::install(), or other methods — will be installed into the project’s local R package library. From 3928991e9a0a91dde44564479310150a908651fa Mon Sep 17 00:00:00 2001 From: u0140201 Date: Thu, 29 Jan 2026 12:20:14 +0100 Subject: [PATCH 2/2] Add section on using the project --- source/compute/software/vsc_rproject.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/source/compute/software/vsc_rproject.rst b/source/compute/software/vsc_rproject.rst index aa4ca53a9..ada580cf5 100644 --- a/source/compute/software/vsc_rproject.rst +++ b/source/compute/software/vsc_rproject.rst @@ -156,6 +156,17 @@ The ``activate`` sub-command can be used to activate an already existing vsc-Rpr Activating a vsc-Rproject environment will load all the relevant modules listed in the modules file and set the ``$VSC_RPROJECT`` environment variable which can be used to access the root directory of the project. +.. note:: + + To open a project via the commandline, you simply need to launch R from within your project root folder: + + .. code:: bash + + vsc-rproject activate MyProject + cd $VSC_RPROJECT + R + + .. _deactivating_a_project: Deactivating a project @@ -215,7 +226,12 @@ When launching a new session via the :ref:`Studio Server ` app i The R module selected in the OnDemand form must match the R module that was used to create the project! Otherwise dependency conflicts may arise as RStudio Server will replace the modules loaded via the pre-run scriplet. -Once inside the RStudio session, you still need to open the RStudio Project via the interface: -File > Open Project... +In order to use this project within the RStudio session, you still need to open the RStudio Project via the interface: +File > Open Project... + +Using the Environment and installing software +--------------------------------------------- -After loading the RStudio Project, any packages you install — via install.packages(), devtools::install(), or other methods — will be installed into the project’s local R package library. +Once your project has been opened (either in RStudio or via the commandline), you should see a welcome message pointing you to the project folder and listing all known library paths. +The first library path should point to the project's own library itself. +When loading packages (e.g. ``library()``) or installing packages (e.g.``install.packages()``) R prioritizes the first library path.