Skip to content

update vsc-Rproject documentation#521

Open
WouterVanAssche wants to merge 2 commits into
masterfrom
rstudio_documentation_update
Open

update vsc-Rproject documentation#521
WouterVanAssche wants to merge 2 commits into
masterfrom
rstudio_documentation_update

Conversation

@WouterVanAssche
Copy link
Copy Markdown
Contributor

No description provided.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's something that should be mentioned higher up in the page, because it applies to all ways in which vsc-Rproject can be used (it's not RStudio-specific).

Copy link
Copy Markdown
Contributor

@MaximeVdB MaximeVdB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(see that one comment)

Comment on lines +232 to +237
Using the Environment and installing software
---------------------------------------------

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(<packagename>)``) or installing packages (e.g.``install.packages(<packagename>)``) R prioritizes the first library path.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indeed better, but I would still like to see this higher up the page because it describes an important part of how vsc-Rproject works. So I'd suggest to for example put it in a new subsection in between Activating a project and Deactivating a project (perhaps calling it Adding R packages to the project?).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I like this idea. That section is explaining one by one the different subcommands create, activate, deactivate, and configure. Installing packages in an RStudio Project is not something specific to vsc-Rproject. vsc-Rproject just facilitates the setup of your project directory and the package libary in a correct way.
The moment the project is created the job of vsc-Rproject is pretty much done. All it then needs to do is make sure the correct modules are in place whenever you want to use it.
Installing packages in the project's package library, whether via command line R or RStudio does not dependent on vsc-Rproject anymore. That is why I have these two separate sections ("vsc-Rproject and RStudio Server" and "Using the Environment and installing software") at the end of the page.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The argument that this does not correspond to a specific vsc-Rproject subcommand does not hold. What counts is what happens from a user perspective. The main and perhaps only reason they are using vsc-Rproject is to install their own R packages, and so that step is as essential as the vsc-Rproject subcommands themselves. If you check our pages on Python, Conda, and the like, will see the same create-environment/activate-environment/install-stuff-in-environment/deactivate-environment structure ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants