Add renv instructions to README (#23)

* Add renv instructions

* Ignore `calypso` for renv

* Correct use of `dev = TRUE` for renv calls

README.md

@@ -49,6 +49,29 @@ as it has good support for R package development and Shiny.
     ```
 
 The `dev/02_dev.R` script contains a few helper functions to get you started.
+
+### Updating the `renv` lockfile
+
+Make sure to regularly run `renv::status(dev = TRUE)` to check if your local library and the lockfile
+are up to date.
+
+When adding a new dependency, install it in the `renv` library with
+
+```r
+renv::install("package_name")
+```
+
+and then use it in your code as usual.
+`renv` will pick up the new package if it's installed and used in the project.
+
+To update the lockfile, run
+
+```r
+renv::snapshot(dev = TRUE)
+```
+
+The `dev = TRUE` argument ensures that development dependencies (e.g. those recorded under
+`Suggests` in the `DESCRIPTION` file) are also included in the lockfile.
 
 ### Design
 

renv/settings.json

@@ -1,7 +1,9 @@
 {
   "bioconductor.version": null,
   "external.libraries": [],
-  "ignored.packages": [],
+  "ignored.packages": [
+    "calypso"
+  ],
   "package.dependency.fields": [
     "Imports",
     "Depends",