BasiliskEnvironment-class: The BasiliskEnvironment class

In LTLA/basilisk: Freezing Python Dependencies Inside Bioconductor Packages

The BasiliskEnvironment class

Description

The BasiliskEnvironment class provides a simple structure containing all of the information to construct a basilisk environment. It is used by basiliskStart to perform lazy installation.

Constructor

BasiliskEnvironment(envname, pkgname, packages) will return a BasiliskEnvironment object, given:

• envname, string containing the name of the environment. Environment names starting with an underscore are reserved for internal use.

• pkgname, string containing the name of the package that owns the environment.

• packages, character vector containing the names of the required Python packages from conda, see setupBasiliskEnv for requirements.

• channels, character vector specifying the Conda channels to search, see setupBasiliskEnv for detials.

• pip, character vector containing names of additional Python packages from PyPi, see setupBasiliskEnv for requirements.

• paths, character vector containing relative paths to Python packages to be installed via pip. These paths are interpreted relative to the system directory of pkgname, i.e., they are appended to the output of system.file to obtain absolute paths for setupBasiliskEnv. Thus, any Python package vendored into the R package should be stored in the inst directory of the latter's source.

Author(s)

Aaron lun

Examples

BasiliskEnvironment("my_env1", "AaronPackage", 
    packages=c("scikit-learn=1.1.1", "pandas=1.43.1"))

LTLA/basilisk documentation built on Nov. 3, 2024, 3:05 p.m.