Avoid messing up user's WORKON_HOME in examples.

R/basiliskStart.R

@@ -79,6 +79,15 @@
 #' \code{\link{getBasiliskFork}} and \code{\link{getBasiliskShared}}, to control various global options.
 #' 
 #' @examples
+#' ##################################################
+#' # Creating virtualenvs in a temporary directory to 
+#' # avoid polluting the user's WORKON_HOME.
+#' tmploc <- file.path(tempdir(), "basilisk")
+#' dir.create(tmploc)
+#' old <- Sys.getenv("WORKON_HOME")
+#' Sys.setenv(WORKON_HOME=tmploc)
+#' ##################################################
+#'
 #' # Loading one virtual environment into our R session:
 #' setupVirtualEnv('my_package_A', c('pandas==0.25.3',
 #'     "python-dateutil==2.8.1", "pytz==2019.3"))
@@ -110,6 +119,11 @@
 #' # Close persistent processes to avoid errors during CHECK.
 #' basiliskStop(cl, persist=FALSE)
 #' }
+#'
+#' ##################################################
+#' # Restoring the old WORKON_HOME.
+#' Sys.setenv(WORKON_HOME=old)
+#' ##################################################
 #' @export
 #' @importFrom parallel makePSOCKcluster clusterCall makeForkCluster
 #' @importFrom reticulate py_config py_available

R/setupVirtualEnv.R

@@ -42,6 +42,15 @@
 #' In such cases, the compatible versions of the core packages must again be explicitly listed in \code{packages}.
 #'
 #' @examples
+#' ##################################################
+#' # Creating virtualenvs in a temporary directory to 
+#' # avoid polluting the user's WORKON_HOME.
+#' tmploc <- file.path(tempdir(), "basilisk")
+#' dir.create(tmploc)
+#' old <- Sys.getenv("WORKON_HOME")
+#' Sys.setenv(WORKON_HOME=tmploc)
+#' ##################################################
+#' 
 #' setupVirtualEnv('my_package_A', c('pandas==0.25.3',
 #'     "python-dateutil==2.8.1", "pytz==2019.3"))
 #' useVirtualEnv("my_package_A")
@@ -51,7 +60,11 @@
 #' # No need to list versions of core packages, 
 #' # or to list them at all if they are dependencies.
 #' setupVirtualEnv('my_package_A_alt', 'pandas')
-#' 
+#'
+#' ##################################################
+#' # Restoring the old WORKON_HOME.
+#' Sys.setenv(WORKON_HOME=old)
+#' ##################################################
 #' @seealso
 #' \code{\link{listCorePackages}}, for a list of core Python packages with pinned versions.
 #'

R/useVirtualEnv.R

@@ -25,9 +25,22 @@
 #' @author Aaron Lun
 #' 
 #' @examples
+#' ##################################################
+#' # Creating virtualenvs in a temporary directory to 
+#' # avoid polluting the user's WORKON_HOME.
+#' tmploc <- file.path(tempdir(), "basilisk")
+#' dir.create(tmploc)
+#' old <- Sys.getenv("WORKON_HOME")
+#' Sys.setenv(WORKON_HOME=tmploc)
+#' ##################################################
+#'
 #' setupVirtualEnv('my_package_A_alt', 'pandas')
 #' useVirtualEnv("my_package_A_alt")
 #' 
+#' ##################################################
+#' # Restoring the old WORKON_HOME.
+#' Sys.setenv(WORKON_HOME=old)
+#' ##################################################
 #' @seealso
 #' \code{\link{basiliskStart}}, for how these virtual environments should be used.
 #'