add examples

rstudio · Aug 14, 2024 · c602d80 · c602d80
1 parent fee2acc
commit c602d80
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/R/retrieve.R b/R/retrieve.R
@@ -29,6 +29,18 @@ the$repos_archive <- new.env(parent = emptyenv())
 #'   those packages were downloaded.
 #'
 #' @export
+#'
+#' @examples
+#' \dontrun{
+#'
+#' # retrieve package + versions as defined in the lockfile
+#' # normally used as a pre-flight step to renv::restore()
+#' renv::retrieve()
+#'
+#' # download one or more packages locally
+#' renv::retrieve("rlang", destdir = ".")
+#'
+#' }
 retrieve <- function(packages = NULL,
                      ...,
                      lockfile = NULL,

diff --git a/man/retrieve.Rd b/man/retrieve.Rd