Merge pull request #94 from FredHutch/update-readme-vignette-building

Update README.md to suggest installing dependencies in order to build vignettes
FredHutch · Sep 4, 2024 · 8858847 · 8858847
2 parents bd9c7fe + b0c1ba1
commit 8858847
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -27,8 +27,9 @@ The package is available on the Fred Hutch organization GitHub page.
 ``` r
 remotes::install_github("FredHutch/VISCfunctions")
 
-# Use the build_vignettes parameter to access the vignette:
-remotes::install_github("FredHutch/VISCfunctions", build_vignettes = TRUE)
+# Use the build_vignettes parameter to access the vignette
+# (Note that this may auto-upgrade dependencies - this behavior can be controlled with the `upgrade` argument)
+remotes::install_github("FredHutch/VISCfunctions", dependencies = TRUE, build_vignettes = TRUE)
 vignette("Overview")
 ```