-
Notifications
You must be signed in to change notification settings - Fork 155
/
README.Rmd
78 lines (56 loc) · 3.83 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# renv <img src="man/figures/logo.svg" align="right" height="115"/>
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html) [](https://CRAN.R-project.org/package=renv) [](https://github.com/rstudio/renv/actions)
<!-- badges: end -->
## Overview
The renv package[^1] helps you create **r**eproducible **env**ironments for your R projects.
Use renv to make your R projects more isolated, portable and reproducible.
[^1]: Pronounced "R" "env"
- **Isolated**: Installing a new or updated package for one project won't break your other projects, and vice versa. That's because renv gives each project its own private library.
- **Portable**: Easily transport your projects from one computer to another, even across different platforms. renv makes it easy to install the packages your project depends on.
- **Reproducible**: renv records the exact package versions you depend on, and ensures those exact versions are the ones that get installed wherever you go.
## Installation
Install the latest version of renv from CRAN with:
``` r
install.packages("renv")
```
## Workflow
```{r}
#| echo: false
#| fig.align: center
#| out.width: null
#| fig.alt: >
#| A diagram showing the most important verbs and nouns of renv.
#| Projects start with init(), which creates a project library using
#| packages from the system library. snapshot() updates the lockfile
#| using the packages installed in the project library, where restore()
#| installs packages into the project library using the metadata from
#| the lockfile, and status() compares the lockfile to the project library.
#| You install and update packages from CRAN and GitHub using install()
#| and update(), but because you'll need to do this for multiple projects,
#| renv uses cache to make this fast.
knitr::include_graphics("vignettes/renv.png", dpi = 144)
```
Use `renv::init()` to initialize renv in a new or existing project.
This will set up a **project library**, containing all the packages you're currently using.
The packages (and all the metadata needed to reinstall them) are recorded into a **lockfile**, `renv.lock`, and a `.Rprofile` ensures that the library is used every time you open that project.
As you continue to work on your project, you will install and upgrade packages, either using `install.packages()` and `update.packages()` or `renv::install()` and `renv::update()`.
After you've confirmed your code works as expected, use `renv::snapshot()` to record the packages and their sources in the lockfile.
Later, if you need to share your code with someone else or run your code on new machine, your collaborator (or you) can call `renv::restore()` to reinstall the specific package versions recorded in the lockfile.
## Learning more
If this is your first time using renv, we strongly recommend starting with the [Introduction to renv](https://rstudio.github.io/renv/articles/renv.html) vignette: this will help you understand the most important verbs and nouns of renv.
If you have a question about renv, please first check the [FAQ](https://rstudio.github.io/renv/articles/faq.html) to see whether your question has already been addressed.
If it hasn't, please feel free to ask on the [Posit Forum](https://forum.posit.co).
If you believe you've found a bug in renv, please file a bug (and, if possible, a [reproducible example](https://reprex.tidyverse.org)) at <https://github.com/rstudio/renv/issues>.