rsyncrosim (version 2.0.1)

useConda: Conda configuration of a SsimLibrary

Description

Retrieves or sets the Conda configuration of a SsimLibrary. Note that in order to use conda environments, you will first need to ensure that the conda environment has been created for a given package. You can create the conda environment for a package using the createCondaEnv function.

Usage

useConda(ssimObject)
# S4 method for character
useConda(ssimObject)
# S4 method for SsimLibrary
useConda(ssimObject)
useConda(ssimObject) <- value
# S4 method for logical
useConda(ssimObject) <- value
# S4 method for SsimLibrary
useConda(ssimObject) <- value

Value

Logical: whether Conda environments will be used during runtime for the given SsimLibrary

Arguments

ssimObject

SsimLibrary object

value

logical for whether to use Conda environments for the given SyncroSim Library. If set to TRUE, then Conda environments will be used. If set to FALSE, then Conda environments will not be used during runtime.

Examples

if (FALSE) {
# Set up a SyncroSim Session, SsimLibrary
mySession <- session()

# Retrieve Conda configuration status of the SsimLibrary
useConda(myLibrary)

# Set the Conda configuration of the SyncroSim Library
useConda(myLibrary) <- TRUE

# Only use Conda with the specified SyncroSim packages
useConda(myLibrary) <- "helloworld"

# Only use Conda with multiple specified SyncroSim packages
useConda(myLibrary) <- c("helloworld", "stsim")
}