Skip to content
rv docs

Project Status

One of the benefits of rv is the ability to see what will happen before it occurs, as seen in the --dry-run flags in the package installation section. As part of this, rv has two commands to indicate the status of the project, displaying the information differently depending on your needs.

rv summary

Section titled “rv summary”

rv summary is a way to inspect your project on a global level. It indicates information about the detected system (including R version), how many packages are installed, how many packages need to be installed/removed, where packages come from, and how many packages are available in the repositories.

Usage

Section titled “Usage”
Terminal window
rv summary [OPTIONS]

Options

Section titled “Options”
  • --r-version - Specify an R version different than the one in the config. This allows you to see what would occur if the project was changed to a different R version. The R version does not need to be on the system

Example

Section titled “Example”

In this example, we started out with tibble installed and want to install the dev version of dplyr from GitHub.

rproject.toml
[project]
name = "example"
r_version = "4.4"


repositories = [
    { alias = "PPM", url = "https://packagemanager.posit.co/cran/latest" },
]


dependencies = [
    "tibble",
    { name = "dplyr", git = "https://github.com/tidyverse/dplyr", branch = "main" },
]

rv plan

Section titled “rv plan”

For a more granual look, rv plan will show the results should you run rv sync.

Usage

Section titled “Usage”
Terminal window
rv plan [OPTIONS]

Options

Section titled “Options”
  • --r-version - Specify an R version different than the one in the config. This allows you to see what would occur if the project was changed to a different R version. The R version does not need to be on the system
  • --upgrade - The same as rv upgrade --dry-run

Example

Section titled “Example”

The same scenario as the example above, this time wanting to see a granual installation plan.

rproject.toml
[project]
name = "example"
r_version = "4.4"


repositories = [
    { alias = "PPM", url = "https://packagemanager.posit.co/cran/latest" },
]


dependencies = [
    "tibble",
    { name = "dplyr", git = "https://github.com/tidyverse/dplyr", branch = "main" },
]