Skip to contents

Create a new environment

envCreate.Rd

Create an environment directory and installs the specified packages.

Usage

envCreate(envName = "new_env", packages = NULL, lockFile = NULL, quiet = FALSE)

Arguments

envName

A `character(1)` string specifying the name of the environment. Default is "new_env".

packages

A `character()` vector of package names to install in the environment. Default is NULL.

To specify the packages you want to install within the environment, you can use different syntax:

  • pkg: install the latest version of the package from CRAN.

  • pkg@version: install a specific version of the package from CRAN.

  • username/repo: install the package from GitHub. You can also specify the commit with username/repo@commitId.

  • bioc::pkg: install the package from Bioconductor.

Note that to install a specific version of a Bioconductor package, it is recommended to install it via GitHub.

You can find more information on package installation in the renv::install documentation.

lockFile

A `character()` string specifying the path to a lockFile. Default is NULL.

quiet

A `logical()` indicating whether messages should be suppressed. Default is `FALSE`.

Details

Only one of the `packages` and `lockfile` parameters should be present in order to create the environment.

When a new environment is initialized, a new directory is created inside the `.envs/` directory. This new directory will contain all the installed packages specific to this environment.