From eb685065ff02f69a13358262057b64c771160062 Mon Sep 17 00:00:00 2001 From: Kellie MacPhee Date: Fri, 23 Aug 2024 19:02:59 -0400 Subject: [PATCH 1/2] Update README.md to suggest installing dependencies to build vignettes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f7ddfd..b7189e8 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ The package is available on the Fred Hutch organization GitHub page. remotes::install_github("FredHutch/VISCfunctions") # Use the build_vignettes parameter to access the vignette: -remotes::install_github("FredHutch/VISCfunctions", build_vignettes = TRUE) +remotes::install_github("FredHutch/VISCfunctions", dependencies = TRUE, build_vignettes = TRUE) vignette("Overview") ``` From d0bb13de9d915c19f4917ef46ec68dccb3e3e271 Mon Sep 17 00:00:00 2001 From: Kellie MacPhee Date: Mon, 26 Aug 2024 10:49:44 -0700 Subject: [PATCH 2/2] add note about auto-upgrading dependencies --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7189e8..427f8a1 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,8 @@ 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: +# 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") ```