getEnvironmentDir {basilisk.utils}R Documentation

Get the basilisk environment directory

Description

Find the installation directory for the basilisk Python environments for a particular client package.

Usage

getEnvironmentDir(pkgname, installed = TRUE)

Arguments

pkgname

String containing the name of the basilisk client package responsible for generating the environment.

installed

Logical scalar indicating whether the client package is already installed.

Details

By default, basilisk environments are installed to a location specified by getExternalDir. This ensures that R package build systems do not attempt to generate binaries that include the Python/conda packages; such binaries are not relocatable due to the presence of hard-coded paths, resulting in run-time failures.

If the BASILISK_USE_SYSTEM_DIR environment variable is set to "1", the function will return a path to a location inside the client package's system installation directory. This is the ideal approach when installing from source as we guarantee synchronization in Python and R re-installations. It also ensures that any R process that can load the client package will also have permissions to access its environments, which makes life easier for sysadmins of clusters or other shared resources.

Value

String containing the path to the environment directory.

Author(s)

Aaron Lun

Examples

# Setting the environment variable to run this example: 
# all other modes rely on installation of the client.
old <- Sys.getenv("BASILISK_USE_SYSTEM_DIR")
Sys.setenv(BASILISK_USE_SYSTEM_DIR=1)

getEnvironmentDir("client.of.basilisk", installed=FALSE)

Sys.setenv(BASILISK_USE_SYSTEM_DIR=old)


[Package basilisk.utils version 1.0.4 Index]